Referenční informace k souboru host.json pro Azure Functions 2.x a novější

Soubor metadat host.json obsahuje možnosti konfigurace, které ovlivňují všechny funkce v instanci aplikace funkcí. Tento článek uvádí nastavení, která jsou k dispozici od verze 2.x modulu runtime Azure Functions.

Další možnosti konfigurace aplikace funkcí se spravují v závislosti na tom, kde aplikace funkcí běží:

• Nasazené do Azure: v nastavení aplikace
• V místním počítači: v souboru local.settings.json .

Konfigurace v host.json souvisejících s vazbami se aplikují rovnoměrně na každou funkci v aplikaci funkcí.

Nastavení můžete také přepsat nebo použít pro každé prostředí pomocí nastavení aplikace.

Ukázkový soubor host.json

Následující ukázkový soubor host.json verze 2.x+ obsahuje všechny možné možnosti (s výjimkou všech, které jsou určené jenom pro interní použití).

{
    "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" ]
}

Následující části tohoto článku vysvětlují jednotlivé vlastnosti nejvyšší úrovně. Všechny jsou volitelné, pokud není uvedeno jinak.

agregátor

Určuje, kolik volání funkcí se agreguje při výpočtu metrik pro Application Insights.

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

Vyvolání funkcí se agreguje při dosažení prvního ze dvou limitů.

applicationInsights

Toto nastavení je podřízené protokolování.

Možnosti ovládacích prvků pro Application Insights, včetně možností vzorkování

Kompletní strukturu JSON najdete v předchozím příkladu host.json souboru.

applicationInsights.samplingSettings

Další informace o těchto nastaveních najdete v tématu Vzorkování v Application Insights.

applicationInsights.httpAutoCollectionOptions

applicationInsights.dependencyTrackingOptions

applicationInsights.snapshotConfiguration

Další informace o snímcích najdete v tématu Ladění snímků u výjimek v aplikacích .NET a řešení potíží s povolením ladicího programu snímků Application Insights nebo zobrazením snímků.

objekty blob

Nastavení konfigurace najdete v triggerech a vazbách objektů blob služby Storage.

konzola

Toto nastavení je podřízené protokolování. Řídí protokolování konzoly, pokud není v režimu ladění.

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

Azure Cosmos DB

Nastavení konfigurace najdete v triggerech a vazbách služby Azure Cosmos DB.

customHandler

Nastavení konfigurace pro vlastní obslužnou rutinu Další informace najdete v tématu Vlastní obslužné rutiny Azure Functions.

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

durableTask

Nastavení konfigurace najdete ve vazbách pro Durable Functions.

souběžnost

Umožňuje dynamickou souběžnost pro konkrétní vazby v aplikaci funkcí. Další informace najdete v tématu Dynamické souběžnosti.

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

eventHub

Nastavení konfigurace najdete v triggerech a vazbách centra událostí.

rozšíření

Vlastnost, která vrací objekt, který obsahuje všechna nastavení specifická pro vazbu, jako je http a eventHub.

extensionBundle

Sady rozšíření umožňují přidat do aplikace funkcí kompatibilní sadu rozšíření vazeb functions. Další informace najdete v tématu Sady rozšíření pro místní vývoj.

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

V objektu extensionBundle jsou k dispozici následující vlastnosti:

– funkce

Seznam funkcí, které hostitel úlohy spouští. Prázdné pole znamená spuštění všech funkcí. Určeno k použití pouze při místním spuštění. V aplikacích funkcí v Azure byste měli místo toho postupovat podle kroků v části Jak zakázat funkce ve službě Azure Functions a zakázat konkrétní funkce místo použití tohoto nastavení.

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

functionTimeout

Určuje dobu trvání časového limitu pro všechna spuštění funkce. Řídí se formátem řetězce časového rozsahu.

¹ Spuštění plánu Premium je zaručeno pouze po dobu 60 minut, ale technicky nevázané.
² Hodnota -1 indikuje nevázané spuštění, ale doporučuje se zachovat pevnou horní mez.

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

healthMonitor

Nastavení konfigurace pro monitorování stavu hostitele

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

http

Nastavení konfigurace najdete v triggerech a vazbách HTTP.

protokolování

Řídí chování protokolování aplikace funkcí, včetně Application Insights.

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

managedDependency

Spravovaná závislost je funkce, která se v současné době podporuje jenom u funkcí založených na PowerShellu. Umožňuje automatickou správu závislostí službou. Pokud je vlastnost nastavena enabled na true, requirements.psd1 soubor se zpracuje. Závislosti se aktualizují při vydání všech podverzí. Další informace najdete v článku o spravované závislosti v PowerShellu.

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

fronty

Nastavení konfigurace najdete v triggerech a vazbách fronty služby Storage.

sendGrid

Nastavení konfigurace najdete v triggerech a vazbách SendGrid.

serviceBus

Nastavení konfigurace najdete v triggerech a vazbách služby Service Bus.

unikát

Nastavení konfigurace pro chování zámku Singleton. Další informace najdete v tématu o problému GitHubu s podporou singletonu.

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

telemetryMode

Tato funkce je aktuálně ve verzi Preview.

Slouží k povolení výstupu protokolů a trasování ve výstupním formátu OpenTelemetry do jednoho nebo více koncových bodů, které podporují OpenTelemetry. Pokud je toto nastavení nastavené na OpenTelemetry, použije se výstup OpenTelemetry. Ve výchozím nastavení bez tohoto nastavení se všechny protokoly, trasování a události odesílají do Application Insights pomocí standardních výstupů. Další informace najdete v tématu Použití OpenTelemetry se službou Azure Functions.

version

Tato hodnota označuje verzi schématu host.json. Řetězec "version": "2.0" verze se vyžaduje pro aplikaci funkcí, která cílí na modul runtime v2 nebo novější verzi. Mezi v2 a v3 nejsou žádné změny schématu host.json.

watchDirectories

Sada sdílených adresářů kódu, které by měly být monitorovány pro změny. Zajišťuje, že když se změní kód v těchto adresářích, budou změny vyzvednuty vašimi funkcemi.

{
    "watchDirectories": [ "Shared" ]
}

watchFiles

Pole jednoho nebo více názvů souborů, které jsou monitorovány pro změny, které vyžadují restartování aplikace. To zaručuje, že když se změní kód v těchto souborech, budou aktualizace vyzvednuty vašimi funkcemi.

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

Přepsání hodnot host.json

Mohou existovat případy, kdy chcete nakonfigurovat nebo upravit konkrétní nastavení v souboru host.json pro konkrétní prostředí, aniž byste změnili samotný soubor host.json. Konkrétní host.json hodnoty můžete přepsat vytvořením ekvivalentní hodnoty jako nastavení aplikace. Když modul runtime najde nastavení aplikace ve formátu, přepíše ekvivalentní nastavení host.json umístěné path.to.setting ve formátu AzureFunctionsJobHost__path__to__settingJSON. Pokud je vyjádřeno jako nastavení aplikace, tečka (.) použitá k označení hierarchie JSON se nahradí dvojitým podtržítkem (__).

Řekněme například, že chcete zakázat vzorkování Application Insights při místním spuštění. Pokud jste změnili místní soubor host.json tak, aby zakázal Application Insights, může se tato změna během nasazování odeslat do produkční aplikace. Bezpečnější způsob, jak to udělat, je místo toho vytvořit nastavení aplikace jako "AzureFunctionsJobHost__logging__applicationInsights__samplingSettings__isEnabled":"false" v local.settings.json souboru. Toto se zobrazí v následujícím local.settings.json souboru, který se nepublikuje:

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

Přepsání nastavení host.json pomocí proměnných prostředí se řídí ASP.NET základními konvencemi vytváření názvů. Pokud struktura elementu obsahuje pole, měl by být číselný index pole považován za další název elementu v této cestě. Další informace najdete v tématu Pojmenování proměnných prostředí.

Další kroky