"Referencia host.json dla Azure Functions 1.x"

Plik metadanych host.json zawiera opcje konfiguracji, które mają wpływ na wszystkie funkcje w wystąpieniu aplikacji funkcji. W tym artykule wymieniono ustawienia dostępne dla środowiska uruchomieniowego w wersji 1.x. Schemat JSON znajduje się pod http://json.schemastore.org/host.

Inne opcje konfiguracji funkcji aplikacji są zarządzane w ustawieniach aplikacji.

Niektóre ustawienia host.json są używane tylko podczas lokalnego wykonywania w pliku local.settings.json.

Przykładowy plik host.json

Następujące przykładowe pliki host.json mają określone wszystkie możliwe opcje.

{
    "aggregator": {
        "batchSize": 1000,
        "flushTimeout": "00:00:30"
    },
    "applicationInsights": {
        "sampling": {
          "isEnabled": true,
          "maxTelemetryItemsPerSecond" : 5
        }
    },
    "documentDB": {
        "connectionMode": "Gateway",
        "protocol": "Https",
        "leaseOptions": {
            "leasePrefix": "prefix"
        }
    },
    "eventHub": {
      "maxBatchSize": 64,
      "prefetchCount": 256,
      "batchCheckpointFrequency": 1
    },
    "functions": [ "QueueProcessor", "GitHubWebHook" ],
    "functionTimeout": "00:05:00",
    "healthMonitor": {
        "enabled": true,
        "healthCheckInterval": "00:00:10",
        "healthCheckWindow": "00:02:00",
        "healthCheckThreshold": 6,
        "counterThreshold": 0.80
    },
    "http": {
        "routePrefix": "api",
        "maxOutstandingRequests": 20,
        "maxConcurrentRequests": 10,
        "dynamicThrottlesEnabled": false
    },
    "id": "9f4ea53c5136457d883d685e57164f08",
    "logger": {
        "categoryFilter": {
            "defaultLevel": "Information",
            "categoryLevels": {
                "Host": "Error",
                "Function": "Error",
                "Host.Aggregator": "Information"
            }
        }
    },
    "queues": {
      "maxPollingInterval": 2000,
      "visibilityTimeout" : "00:00:30",
      "batchSize": 16,
      "maxDequeueCount": 5,
      "newBatchThreshold": 8
    },
    "sendGrid": {
        "from": "Contoso Group <admin@contoso.com>"
    },
    "serviceBus": {
      "maxConcurrentCalls": 16,
      "prefetchCount": 100,
      "autoRenewTimeout": "00:05:00",
      "autoComplete": true
    },
    "singleton": {
      "lockPeriod": "00:00:15",
      "listenerLockPeriod": "00:01:00",
      "listenerLockRecoveryPollingInterval": "00:01:00",
      "lockAcquisitionTimeout": "00:01:00",
      "lockAcquisitionPollingInterval": "00:00:03"
    },
    "tracing": {
      "consoleLevel": "verbose",
      "fileLoggingMode": "debugOnly"
    },
    "watchDirectories": [ "Shared" ],
}

W poniższych sekcjach tego artykułu opisano każdą właściwość najwyższego poziomu. Wszystkie są opcjonalne, chyba że wskazano inaczej.

Agregator

Określa, ile wywołań funkcji jest agregowanych podczas obliczania metryk dla usługi Application Insights.

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

Wywołania funkcji są agregowane, gdy osiągnięto pierwszy z tych dwóch limitów.

Wgląd w aplikacje

Steruje funkcją próbkowania w usłudze Application Insights.

{
        "applicationInsights": {
                "sampling": {
                    "isEnabled": true,
                    "maxTelemetryItemsPerSecond" : 5
                }
        }
}

DocumentDB

Ustawienia konfiguracji wyzwalacza i powiązań dla Azure Cosmos DB.

{
    "documentDB": {
        "connectionMode": "Gateway",
        "protocol": "Https",
        "leaseOptions": {
            "leasePrefix": "prefix1"
        }
    }
}

trwałe zadanie

Ustawienia konfiguracji Durable Functions.

W Azure Functions runtime 1.x durableTask sekcja znajduje się u podstawy pliku host.json. Dostępne ustawienia zależą od wersji rozszerzenia Durable Functions. Aktualne odniesienie konfiguracyjne można znaleźć w Durable Functions host.json ustawieniach.

eventHub

Ustawienia konfiguracyjne dla wyzwalaczy i powiązań Event Hub.

— funkcje

Lista funkcji uruchamianych przez hosta zadań. Pusta tablica oznacza uruchomienie wszystkich funkcji. Przeznaczone do użytku tylko w przypadku uruchamiania lokalnego. W aplikacjach funkcji w Azure należy wykonać kroki opisane w Jak wyłączyć funkcje w Azure Functions aby wyłączyć określone funkcje zamiast używać tego ustawienia.

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

functionTimeout

Wskazuje czas trwania limitu czasu dla wszystkich funkcji. W planie użycia bezserwerowego prawidłowy zakres wynosi od 1 sekundy do 10 minut, a wartość domyślna to 5 minut. W planie usługi App Service nie ma ogólnego limitu, a wartość domyślna ma wartość null, co oznacza brak limitu czasu.

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

monitor zdrowia

Ustawienia konfiguracyjne dla monitora stanu zdrowia Host.

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

http

Ustawienia konfiguracji wyzwalaczy i wiązań HTTP.

{
    "http": {
        "routePrefix": "api",
        "maxOutstandingRequests": 200,
        "maxConcurrentRequests": 100,
        "dynamicThrottlesEnabled": true
    }
}

identyfikator

Unikalny identyfikator hosta zadań. Może być zapisany małymi literami identyfikator GUID z usuniętymi kreskami. Wymagane przy uruchamianiu lokalnym. Podczas uruchamiania w Azure zalecamy, aby nie ustawiać wartości identyfikatora. Identyfikator jest generowany automatycznie w Azure, gdy pominięto id.

Jeśli udostępniasz konto usługi Storage w wielu aplikacjach funkcjonalnych, upewnij się, że każda aplikacja ma inny id. Możesz pominąć właściwość id lub ręcznie ustawić dla każdej aplikacji funkcjonalnej id inną wartość. Wyzwalacz czasomierza używa blokady magazynowej, aby upewnić się, że będzie tylko jedno wystąpienie czasomierza, gdy aplikacja funkcji zostanie rozproszona na wiele instancji. Jeśli dwie aplikacje funkcji współdzielą tę samą id i każda z nich używa wyzwalacza czasowego, uruchamia się tylko jeden czasomierz.

{
    "id": "9f4ea53c5136457d883d685e57164f08"
}

rejestrator

Steruje filtrowaniem dzienników napisanych przez obiekt ILogger lub context.log.

{
    "logger": {
        "categoryFilter": {
            "defaultLevel": "Information",
            "categoryLevels": {
                "Host": "Error",
                "Function": "Error",
                "Host.Aggregator": "Information"
            }
        }
    }
}

kolejki

Ustawienia dla wyzwalaczy i powiązań kolejki Storage.

{
    "queues": {
      "maxPollingInterval": 2000,
      "visibilityTimeout" : "00:00:30",
      "batchSize": 16,
      "maxDequeueCount": 5,
      "newBatchThreshold": 8
    }
}

SendGrid

Ustawienie konfiguracji wiązania wyjścia SendGrid.

{
    "sendGrid": {
        "from": "Contoso Group <admin@contoso.com>"
    }
}    

serviceBus

Ustawienia konfiguracji dla wyzwalaczy i wiązań Service Bus.

{ 
    "serviceBus": {
      "maxConcurrentCalls": 16,
      "prefetchCount": 100,
      "autoRenewTimeout": "00:05:00",
      "autoComplete": true
    }
}

pojedyncze

Ustawienia konfiguracji zachowania blokady Singleton. Aby uzyskać więcej informacji, zobacz GitHub issue dotyczący obsługi singletonów.

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

śledzenie

Wersja 1.x

Ustawienia konfiguracji dzienników tworzonych przy użyciu TraceWriter obiektu. Aby dowiedzieć się więcej, zobacz [Rejestrowanie w języku C#].

{
    "tracing": {
      "consoleLevel": "verbose",
      "fileLoggingMode": "debugOnly"
    }
}

monitorujKatalogi

Zestaw udostępnionych katalogów kodu, które powinny być monitorowane pod kątem zmian. Gwarantuje, że po zmianie kodu w tych katalogach zmiany są wykrywane przez funkcje.

{
    "watchDirectories": [ "Shared" ]
}

Następne kroki