Azure İşlevleri 1.x için host.json başvurusu

host.json meta veri dosyası, bir işlev uygulaması örneğindeki tüm işlevleri etkileyen yapılandırma seçeneklerini içerir. Bu makalede, sürüm 1.x çalışma zamanı için kullanılabilen ayarlar listelenir. JSON şeması konumundadır http://json.schemastore.org/host.

Diğer işlev uygulaması yapılandırma seçenekleri uygulama ayarlarınızda yönetilir.

Bazı host.json ayarları yalnızca local.settings.json dosyasında yerel olarak çalıştırılırken kullanılır.

Örnek host.json dosyası

Aşağıdaki örnek host.json dosyaları tüm olası seçenekler belirtilmiş.

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

Bu makalenin aşağıdaki bölümlerinde her üst düzey özellik açıklanmaktadır. Aksi belirtilmediği sürece tümü isteğe bağlıdır.

Toplayıcı

Application Insights ölçümlerini hesaplarken kaç işlev çağrısının toplanmış olduğunu belirtir.

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

İki sınırdan ilki ulaşıldığında işlev çağrıları toplanır.

applicationInsights

Application Insights'ta örnekleme özelliğini denetler.

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

DocumentDB

Azure Cosmos DB tetikleyicisi ve bağlamaları için yapılandırma ayarları.

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

durableTask

Dayanıklı İşlevler yapılandırma ayarları.

{
 "extensions": {
  "durableTask": {
    "hubName": "MyTaskHub",
    "storageProvider": {
      "connectionStringName": "AzureWebJobsStorage",
      "controlQueueBatchSize": 32,
      "controlQueueBufferThreshold": 256,
      "controlQueueVisibilityTimeout": "00:05:00",
      "maxQueuePollingInterval": "00:00:30",
      "partitionCount": 4,
      "trackingStoreConnectionStringName": "TrackingStorage",
      "trackingStoreNamePrefix": "DurableTask",
      "useLegacyPartitionManagement": true,
      "useTablePartitionManagement": false,
      "workItemQueueVisibilityTimeout": "00:05:00",
    },
    "tracing": {
      "traceInputsAndOutputs": false,
      "traceReplayEvents": false,
    },
    "notifications": {
      "eventGrid": {
        "topicEndpoint": "https://topic_name.westus2-1.eventgrid.azure.net/api/events",
        "keySettingName": "EventGridKey",
        "publishRetryCount": 3,
        "publishRetryInterval": "00:00:30",
        "publishEventTypes": [
          "Started",
          "Completed",
          "Failed",
          "Terminated"
        ]
      }
    },
    "maxConcurrentActivityFunctions": 10,
    "maxConcurrentOrchestratorFunctions": 10,
    "extendedSessionsEnabled": false,
    "extendedSessionIdleTimeoutInSeconds": 30,
    "useAppLease": true,
    "useGracefulShutdown": false,
    "maxEntityOperationBatchSize": 50,
    "storeInputsInOrchestrationHistory": false
  }
 }
}

{
  "extensions": {
    "durableTask": {
      "hubName": "MyTaskHub",
      "controlQueueBatchSize": 32,
      "partitionCount": 4,
      "controlQueueVisibilityTimeout": "00:05:00",
      "workItemQueueVisibilityTimeout": "00:05:00",
      "maxConcurrentActivityFunctions": 10,
      "maxConcurrentOrchestratorFunctions": 10,
      "maxQueuePollingInterval": "00:00:30",
      "azureStorageConnectionStringName": "AzureWebJobsStorage",
      "trackingStoreConnectionStringName": "TrackingStorage",
      "trackingStoreNamePrefix": "DurableTask",
      "traceInputsAndOutputs": false,
      "logReplayEvents": false,
      "eventGridTopicEndpoint": "https://topic_name.westus2-1.eventgrid.azure.net/api/events",
      "eventGridKeySettingName":  "EventGridKey",
      "eventGridPublishRetryCount": 3,
      "eventGridPublishRetryInterval": "00:00:30",
      "eventGridPublishEventTypes": ["Started", "Completed", "Failed", "Terminated"]
    }
  }
}

Görev hub'ı adları bir harfle başlamalı ve yalnızca harf ve sayılardan oluşmalıdır. Belirtilmezse, bir işlev uygulamasının varsayılan görev hub'ı adı TestHubName'dir. Daha fazla bilgi için bkz . Görev hub'ları.

Bu ayarların çoğu performansı iyileştirmeye yöneliktir. Daha fazla bilgi için bkz . Performans ve ölçeklendirme.

eventHub

Olay Hub'ı tetikleyicileri ve bağlamaları için yapılandırma ayarları.

işlevleri

İş konağı tarafından çalıştırılır işlevlerin listesi. Boş bir dizi, tüm işlevleri çalıştırma anlamına gelir. Yalnızca yerel olarak çalıştırılırken kullanılmak üzere tasarlanmıştır. Azure'daki işlev uygulamalarında, bu ayarı kullanmak yerine belirli işlevleri devre dışı bırakmak için Azure İşlevleri işlevleri devre dışı bırakma bölümünde yer alan adımları izlemeniz gerekir.

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

functionTimeout

Tüm işlevler için zaman aşımı süresini gösterir. Sunucusuz Tüketim planında geçerli aralık 1 saniye ile 10 dakika arasındadır ve varsayılan değer 5 dakikadır. App Service planında genel bir sınır yoktur ve varsayılan değer null olur ve bu da zaman aşımı olmadığını gösterir.

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

healthMonitor

Konak sistem durumu izleyicisi için yapılandırma ayarları.

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

http

Http tetikleyicileri ve bağlamaları için yapılandırma ayarları.

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

id

İş konağı için benzersiz kimlik. Kısa çizgilerin kaldırıldığı küçük harf GUID'i olabilir. Yerel olarak çalıştırılırken gereklidir. Azure'da çalışırken kimlik değeri ayarlamamanızı öneririz. Atlandığında id Azure'da otomatik olarak bir kimlik oluşturulur.

Depolama hesabını birden çok işlev uygulamasında paylaşıyorsanız, her işlev uygulamasının farklı idolduğundan emin olun. Özelliğini atlayabilir id veya her işlev uygulamasının id değerlerini farklı bir değere el ile ayarlayabilirsiniz. Zamanlayıcı tetikleyicisi, bir işlev uygulamasının ölçeğini birden çok örneğe genişlettiğinde yalnızca bir zamanlayıcı örneği olmasını sağlamak için bir depolama kilidi kullanır. İki işlev uygulaması aynı id öğeyi paylaşıyorsa ve her biri bir zamanlayıcı tetikleyicisi kullanıyorsa, yalnızca bir zamanlayıcı çalışır.

{
    "id": "9f4ea53c5136457d883d685e57164f08"
}

Günlükçü

ILogger nesnesi veya context.log tarafından yazılan günlükler için filtrelemeyi denetler.

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

kuyruklar

Depolama kuyruğu tetikleyicileri ve bağlamaları için yapılandırma ayarları.

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

SendGrid

SendGrind çıkış bağlaması için yapılandırma ayarı

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

serviceBus

Service Bus tetikleyicileri ve bağlamaları için yapılandırma ayarı.

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

Singleton

Tekil kilit davranışı için yapılandırma ayarları. Daha fazla bilgi için bkz . Tekil destek hakkında GitHub sorunu.

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

Izleme

Sürüm 1.x

Nesne TraceWriter kullanarak oluşturduğunuz günlükler için yapılandırma ayarları. Daha fazla bilgi edinmek için bkz. [C# Günlüğü].

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

watchDirectories

Değişiklikler için izlenmesi gereken paylaşılan kod dizinleri kümesi. Bu dizinlerdeki kod değiştirildiğinde değişikliklerin işlevleriniz tarafından alınmasını sağlar.

{
    "watchDirectories": [ "Shared" ]
}

Sonraki adımlar