Informazioni di riferimento su host.json per Funzioni di Azure 2.x e versioni successive

Il file di metadati host.json contiene opzioni di configurazione che influiscono su tutte le funzioni in un'istanza dell'app per le funzioni. Questo articolo elenca le impostazioni disponibili a partire dalla versione 2.x del runtime di Funzioni di Azure.

Altre opzioni di configurazione dell'app per le funzioni vengono gestite a seconda della posizione in cui viene eseguita l'app per le funzioni:

• Distribuito in Azure: nelle impostazioni dell'applicazione
• Nel computer locale: nel file local.settings.json .

Le configurazioni in host.json correlate alle associazioni vengono applicate allo stesso modo a ogni funzione nell'app per le funzioni.

È anche possibile eseguire l'override o applicare le impostazioni per ogni ambiente usando le impostazioni dell'applicazione.

File di esempio host.json

Nell'esempio seguente host.json file per la versione 2.x+ sono specificate tutte le opzioni possibili (escluse quelle per uso interno).

{
    "version": "2.0",
    "aggregator": {
        "batchSize": 1000,
        "flushTimeout": "00:00:30"
    },
    "concurrency": { 
            "dynamicConcurrencyEnabled": true, 
            "snapshotPersistenceEnabled": true 
        },
    "extensions": {
        "blobs": {},
        "cosmosDb": {},
        "durableTask": {},
        "eventHubs": {},
        "http": {},
        "queues": {},
        "sendGrid": {},
        "serviceBus": {}
    },
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[4.0.0, 5.0.0)"
    },
    "functions": [ "QueueProcessor", "GitHubWebHook" ],
    "functionTimeout": "00:05:00",
    "healthMonitor": {
        "enabled": true,
        "healthCheckInterval": "00:00:10",
        "healthCheckWindow": "00:02:00",
        "healthCheckThreshold": 6,
        "counterThreshold": 0.80
    },
    "logging": {
        "fileLoggingMode": "debugOnly",
        "logLevel": {
          "Function.MyFunction": "Information",
          "default": "None"
        },
        "applicationInsights": {
            "samplingSettings": {
              "isEnabled": true,
              "maxTelemetryItemsPerSecond" : 20,
              "evaluationInterval": "01:00:00",
              "initialSamplingPercentage": 100.0, 
              "samplingPercentageIncreaseTimeout" : "00:00:01",
              "samplingPercentageDecreaseTimeout" : "00:00:01",
              "minSamplingPercentage": 0.1,
              "maxSamplingPercentage": 100.0,
              "movingAverageRatio": 1.0,
              "excludedTypes" : "Dependency;Event",
              "includedTypes" : "PageView;Trace"
            },
            "dependencyTrackingOptions": {
                "enableSqlCommandTextInstrumentation": true
            },
            "enableLiveMetrics": true,
            "enableDependencyTracking": true,
            "enablePerformanceCountersCollection": true,            
            "httpAutoCollectionOptions": {
                "enableHttpTriggerExtendedInfoCollection": true,
                "enableW3CDistributedTracing": true,
                "enableResponseHeaderInjection": true
            },
            "snapshotConfiguration": {
                "agentEndpoint": null,
                "captureSnapshotMemoryWeight": 0.5,
                "failedRequestLimit": 3,
                "handleUntrackedExceptions": true,
                "isEnabled": true,
                "isEnabledInDeveloperMode": false,
                "isEnabledWhenProfiling": true,
                "isExceptionSnappointsEnabled": false,
                "isLowPrioritySnapshotUploader": true,
                "maximumCollectionPlanSize": 50,
                "maximumSnapshotsRequired": 3,
                "problemCounterResetInterval": "24:00:00",
                "provideAnonymousTelemetry": true,
                "reconnectInterval": "00:15:00",
                "shadowCopyFolder": null,
                "shareUploaderProcess": true,
                "snapshotInLowPriorityThread": true,
                "snapshotsPerDayLimit": 30,
                "snapshotsPerTenMinutesLimit": 1,
                "tempFolder": null,
                "thresholdForSnapshotting": 1,
                "uploaderProxy": null
            }
        }
    },
    "managedDependency": {
        "enabled": true
    },
    "singleton": {
      "lockPeriod": "00:00:15",
      "listenerLockPeriod": "00:01:00",
      "listenerLockRecoveryPollingInterval": "00:01:00",
      "lockAcquisitionTimeout": "00:01:00",
      "lockAcquisitionPollingInterval": "00:00:03"
    },
    "telemetryMode": "OpenTelemetry",
    "watchDirectories": [ "Shared", "Test" ],
    "watchFiles": [ "myFile.txt" ]
}

Le sezioni seguenti di questo articolo illustrano ogni proprietà di livello superiore. Tutte sono facoltative se non diversamente specificato.

aggregator

Specifica il numero di chiamate di funzione che vengono aggregate quando si esegue il calcolo della metrica per Application Insights.

{
    "aggregator": {
        "batchSize": 1000,
        "flushTimeout": "00:00:30"
    }
}

Le chiamate di funzione vengono aggregate quando il primo dei due limiti viene raggiunto.

applicationInsights

Questa impostazione è un elemento figlio di logging.

Controlla le opzioni per Application Insights, incluse le opzioni di campionamento.

Per la struttura JSON completa, vedere l'esempio precedente host.json file.

applicationInsights.samplingSettings

Per altre informazioni su queste impostazioni, vedere Campionamento in Application Insights.

applicationInsights.httpAutoCollectionOptions

applicationInsights.dependencyTrackingOptions

applicationInsights.snapshotConfiguration

Per altre informazioni sugli snapshot, vedere Eseguire il debug di snapshot sulle eccezioni nelle app .NET e Risolvere i problemi di abilitazione di Application Insights Snapshot Debugger o visualizzazione di snapshot.

blob

Le impostazioni di configurazione sono disponibili in Trigger e associazioni dei BLOB di archiviazione.

console

Questa impostazione è un elemento figlio di logging. Controlla la registrazione nella console quando non è attiva la modalità di debug.

{
    "logging": {
    ...
        "console": {
          "isEnabled": false,
          "DisableColors": true
        },
    ...
    }
}

Azure Cosmos DB

Le impostazioni di configurazione sono disponibili nei trigger e nelle associazioni di Azure Cosmos DB.

customHandler

Impostazioni di configurazione per un gestore personalizzato. Per altre informazioni, vedere Funzioni di Azure gestori personalizzati.

"customHandler": {
  "description": {
    "defaultExecutablePath": "server",
    "workingDirectory": "handler",
    "arguments": [ "--port", "%FUNCTIONS_CUSTOMHANDLER_PORT%" ]
  },
  "enableForwardingHttpRequest": false
}

durableTask

L'impostazione di configurazione è reperibile nelle associazioni per Durable Functions.

concurrency

Abilita la concorrenza dinamica per associazioni specifiche nell'app per le funzioni. Per altre informazioni, vedere Concorrenza dinamica.

    { 
        "concurrency": { 
            "dynamicConcurrencyEnabled": true, 
            "snapshotPersistenceEnabled": true 
        } 
    } 

eventHub

Le impostazioni di configurazione sono reperibili in Trigger e associazioni di Hub eventi.

Estensioni

Proprietà che restituisce un oggetto che contiene tutte le impostazioni di associazione specifiche, ad esempio http e eventHub.

extensionBundle

I bundle di estensioni consentono di aggiungere un set compatibile di estensioni di associazione di Funzioni all'app per le funzioni. Per altre informazioni, vedere Bundle di estensioni per lo sviluppo locale.

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[4.0.0, 5.0.0)"
    }
}

In extensionBundle sono disponibili le proprietà seguenti:

functions

Un elenco di funzioni eseguite dall'host di processo. Una matrice vuota indica l’esecuzione di tutte le funzioni. Deve essere utilizzato solo in caso di esecuzione in locale. In app per le funzioni in Azure è necessario invece seguire i passaggi descritti in Come disabilitare le funzioni in Funzioni di Azure per disabilitare le funzioni specifiche invece di usare questa impostazione.

{
    "functions": [ "QueueProcessor", "GitHubWebHook" ]
}

functionTimeout

Indica la durata del timeout per tutte le esecuzioni di funzioni. Segue il formato stringa timespan.

¹ L'esecuzione del piano Premium è garantita solo per 60 minuti, ma tecnicamente non associato.
² Il valore indica -1 l'esecuzione senza vincoli, ma è consigliabile mantenere un limite superiore fisso.

{
    "functionTimeout": "00:05:00"
}

healthMonitor

Impostazioni di configurazione per il monitoraggio integrità host.

{
    "healthMonitor": {
        "enabled": true,
        "healthCheckInterval": "00:00:10",
        "healthCheckWindow": "00:02:00",
        "healthCheckThreshold": 6,
        "counterThreshold": 0.80
    }
}

http

Le impostazioni di configurazione sono reperibili in Trigger e associazioni HTTP.

registrazione

Controlla i comportamenti di registrazione dell'app per le funzioni, tra cui Application Insights.

"logging": {
    "fileLoggingMode": "debugOnly",
    "logLevel": {
      "Function.MyFunction": "Information",
      "default": "None"
    },
    "console": {
        ...
    },
    "applicationInsights": {
        ...
    }
}

managedDependency

La dipendenza gestita è una funzionalità attualmente supportata solo con le funzioni basate su PowerShell. Consente di gestire automaticamente le dipendenze dal servizio. Quando la enabled proprietà è impostata su true, il requirements.psd1 file viene elaborato. Le dipendenze vengono aggiornate quando vengono rilasciate versioni secondarie. Per altre informazioni, vedere Dipendenza gestita nell'articolo PowerShell.

{
    "managedDependency": {
        "enabled": true
    }
}

code

Le impostazioni di configurazione sono reperibili in Trigger e associazioni di Archiviazione code.

sendGrid

Le impostazioni di configurazione sono reperibili in Trigger e associazioni di SendGrid.

serviceBus

Le impostazioni di configurazione sono reperibili in Trigger e associazioni del bus di servizio.

singleton

Impostazioni di configurazione per il comportamento di blocco Singleton. Per ulteriori informazioni, vedere il problema GitHub sul supporto singleton.

{
    "singleton": {
      "lockPeriod": "00:00:15",
      "listenerLockPeriod": "00:01:00",
      "listenerLockRecoveryPollingInterval": "00:01:00",
      "lockAcquisitionTimeout": "00:01:00",
      "lockAcquisitionPollingInterval": "00:00:03"
    }
}

telemetryMode

Questa funzionalità è attualmente in anteprima.

Usato per abilitare l'output dei log e delle tracce in un formato di output OpenTelemetry a uno o più endpoint che supportano OpenTelemetry. Quando questa impostazione è impostata su OpenTelemetry, viene usato l'output OpenTelemetry. Per impostazione predefinita senza questa impostazione, tutti i log, le tracce e gli eventi vengono inviati ad Application Insights usando gli output standard. Per altre informazioni, vedere Usare OpenTelemetry con Funzioni di Azure.

versione

Questo valore indica la versione dello schema di host.json. La stringa "version": "2.0" di versione è necessaria per un'app per le funzioni destinata al runtime v2 o a una versione successiva. Non sono presenti modifiche dello schema host.json tra v2 e v3.

watchDirectories

Un set di directory codice condivise da monitorare per le modifiche. Assicura che quando viene modificato il codice in tali directory, le modifiche vengono prelevate dalle funzioni.

{
    "watchDirectories": [ "Shared" ]
}

watchFiles

Matrice di uno o più nomi di file monitorati per le modifiche che richiedono il riavvio dell'app. Ciò garantisce che quando il codice in questi file viene modificato, gli aggiornamenti vengono prelevati dalle funzioni.

{
    "watchFiles": [ "myFile.txt" ]
}

Eseguire l'override dei valori di host.json

Possono essere presenti istanze in cui si desidera configurare o modificare impostazioni specifiche in un file host.json per un ambiente specifico, senza modificare il file host.json stesso. È possibile eseguire l'override di valori di host.json specifici creando un valore equivalente come impostazione dell'applicazione. Quando il runtime trova un'impostazione dell'applicazione nel formato AzureFunctionsJobHost__path__to__setting, esegue l'override dell'impostazione di host.json equivalente che si trova path.to.setting in nel file JSON. Se espresso come impostazione dell'applicazione, il punto (.) usato per indicare la gerarchia JSON viene sostituito da un doppio carattere di sottolineatura (__).

Si supponga, ad esempio, di voler disabilitare il campionamento di Application Insight durante l'esecuzione in locale. Se il file di host.json locale è stato modificato per disabilitare Application Insights, questa modifica potrebbe essere inserita nell'app di produzione durante la distribuzione. Il modo più sicuro per eseguire questa operazione consiste nel creare invece un'impostazione dell'applicazione come "AzureFunctionsJobHost__logging__applicationInsights__samplingSettings__isEnabled":"false" nel local.settings.json file. È possibile visualizzare questo file nel file seguente local.settings.json , che non viene pubblicato:

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "{storage-account-connection-string}",
        "FUNCTIONS_WORKER_RUNTIME": "{language-runtime}",
        "AzureFunctionsJobHost__logging__applicationInsights__samplingSettings__isEnabled":"false"
    }
}

L'override delle impostazioni di host.json usando le variabili di ambiente segue le convenzioni di denominazione ASP.NET Core. Quando la struttura degli elementi include una matrice, l'indice di matrice numerica deve essere considerato come un nome di elemento aggiuntivo in questo percorso. Per altre informazioni, vedere Denominazione delle variabili di ambiente.

Passaggi successivi