Referensi host.json untuk Azure Functions 1.x

File metadata host.json berisi opsi konfigurasi yang memengaruhi semua fungsi di instans aplikasi fungsi. Artikel ini mencantumkan pengaturan yang tersedia untuk versi runtime 1.x. Skema JSON adalah pada http://json.schemastore.org/host.

Opsi konfigurasi aplikasi fungsi lainnya dikelola di pengaturan aplikasi Anda.

Beberapa pengaturan host.json hanya digunakan saat menjalankan secara lokal di file local.settings.json.

Contoh file host.json

Contoh file host.json berikut memiliki semua opsi yang mungkin ditentukan.

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

Bagian berikut dari artikel ini menjelaskan setiap properti tingkat atas. Semua bersifat opsional kecuali dinyatakan lain.

agregator

Menentukan berapa banyak pemanggilan fungsi yang diagregasi saat menghitung metrik untuk Application Insights.

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

Pemanggilan fungsi diagregasi ketika batasan pertama dari dua batas tercapai.

applicationInsights

Mengontrol fitur pengambilan sampel di Application Insights.

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

DocumentDB

Pengaturan konfigurasi untuk pemicu dan pengikatan Azure Cosmos DB.

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

durableTask

Pengaturan konfigurasi untuk Fungsi Tahan Lama.

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

Nama hub tugas harus dimulai dengan huruf dan hanya terdiri atas huruf dan angka. Jika tidak ditentukan, nama hub tugas default untuk aplikasi fungsi adalah TestHubName. Untuk informasi selengkapnya, lihat Hub tugas.

Banyak dari pengaturan ini untuk mengoptimalkan performa. Untuk informasi selengkapnya, lihat Performa dan skala.

eventHub

Pengaturan konfigurasi untuk pemicu dan pengikatan Event Hub .

fungsi

Daftar fungsi yang dijalankan oleh host pekerjaan. Larik kosong berarti menjalankan semua fungsi. Ditujukan untuk digunakan hanya ketika berjalan secara lokal. Di aplikasi fungsi di Azure, Anda harus mengikuti langkah-langkah dalam Cara menonaktifkan fungsi di Azure Functions untuk menonaktifkan fungsi tertentu alih-alih menggunakan pengaturan ini.

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

functionTimeout

Menunjukkan durasi waktu habis untuk semua fungsi. Dalam paket Konsumsi tanpa server, kisaran yang valid adalah dari 1 detik hingga 10 menit, dan nilai defaultnya adalah 5 menit. Dalam paket App Service, tidak ada batas keseluruhan dan defaultnya adalah null, yang menunjukkan tidak ada batas waktu.

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

healthMonitor

Pengaturan konfigurasi untuk monitor kesehatan Host.

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

http

Pengaturan konfigurasi untuk pemicu dan pengikatan http.

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

id

ID unik untuk host pekerjaan. Dapat berupa GUID huruf kecil dengan tanda hubung dihapus. Diperlukan saat berjalan secara lokal. Saat menjalankan di Azure, kami menyarankan Anda untuk tidak mengatur nilai ID. ID dibuat secara otomatis di Azure saat id dihilangkan.

Jika Anda berbagi akun Penyimpanan di beberapa aplikasi fungsi, pastikan setiap aplikasi fungsi memiliki id yang berbeda. Anda dapat menghilangkan properti id atau mengatur setiap aplikasi fungsi id secara manual ke nilai yang berbeda. Pemicu timer menggunakan kunci penyimpanan untuk memastikan bahwa hanya akan ada satu instans timer ketika aplikasi fungsi diskalakan ke beberapa instans. Jika dua aplikasi fungsi berbagi yang sama id dan masing-masing menggunakan pemicu timer, hanya satu timer yang berjalan.

{
    "id": "9f4ea53c5136457d883d685e57164f08"
}

pencatat

Mengontrol pemfilteran untuk log yang ditulis oleh objek ILogger atau berdasarkan context.log.

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

antrean

Pengaturan konfigurasi untuk Pemicu dan pengikatan antrean penyimpanan.

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

SendGrid

Pengaturan konfigurasi untuk pengikatan output SendGrind

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

serviceBus

Pengaturan konfigurasi untuk pemicu dan pengikatan Bus Layanan.

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

database tunggal

Pengaturan konfigurasi untuk perilaku kunci Database Tunggal. Untuk informasi selengkapnya, lihat Masalah GitHub tentang dukungan tunggal.

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

pelacakan

Versi 1.x

Pengaturan konfigurasi untuk log yang Anda buat dengan menggunakan objek TraceWriter. Untuk mempelajari selengkapnya, lihat [C# Pengelogan].

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

watchDirectories

Sekumpulan direktori kode bersama yang harus dipantau perubahannya. Memastikan bahwa ketika kode dalam direktori ini diubah, perubahan diambil oleh fungsi Anda.

{
    "watchDirectories": [ "Shared" ]
}

Langkah berikutnya