Example:
Code Block |
---|
{ "global_overrides": { "debug": false }, "inputs": { "azure": { "id": "<short_unique_id>", "enabled": true, "credentials": { "subscription_id": "<subscription_id_value>", "client_id": "<client_id_value>", "client_secret": "<client_secret_value>", "tenant_id": "<tenant_id_value>" }, "environment": "<environment_value>", "services": { "vm_metrics": { "request_ "request_period_in_seconds": "<request_period_in_seconds_value>", "start_time_in_utc": "<start_time_in_utc_value>", "include_resource_id_patterns": [ "<include_resource_id_patterns_values>" ], "exclude_resource_id_patterns": [ "<exclude_resource_id_patterns_values>" ] } } }, "azure_event_hub": { " ] } } }, "azure_event_hub": { "id": "<short_unique_id>", "enabled": true, "credentials": { "subscription_id": "<subscription_id_value>", "client_id": "<client_id_value>", "client_secret": "<client_secret_value>", "tenant "tenant_id": "<tenant_id_value>" }, "environment": "<environment_value>", "services": { "event_hubs": { "override_pull_report_frequency_seconds": "<override_pull_report_frequency_seconds_value>", "override_consumer_client_ttl_seconds": "<override_consumer_client_ttl_seconds_value>", "queues": { "<queue_name_value>": { "namespace": "<namespace_value>", " "event_hub_name": "<event_hub_name_value>", "event_hub_connection_string": "<event_hub_connection_string_value>", "consumer_group": "<consumer_group_value>", "blob_storage_connection_string": "<blob_storage_connection_string_value>", "blob_storage_container_name": "<blob_storage_container_name_value>", "blob_storage_account_name": "<blob_storage_account_name_value>", " "compatibility_version": "<compatibility_version_value>", "duplicated_messages_mechanism": "<duplicated_messages_mechanism_value>", "override_starting_position": "<override_starting_position_value>", "override_tag": "<override_tag_value>", "extend_tag": "<extend_tag_value>", "client_thread_limit": "<client_thread_limit_value>", "uamqp_transport": "<uamqp_transport_value>", "partition_ids": ["<partition_id>"] } } }, "uamqp_transport": "<uamqp_transport_value>", "partition_ids": [ "<partition_id>" ] } } }, "event_hubs_auto_discover": { "resource_group": "<resource_group_value>", "namespace": "<namespace_value>", "blob_storage_account_name": "<blob_storage_account_name_value>", "blob_storage_connection_string": "<blob_storage_connection_string_value>", "consumer_group": "<consumer_group_value>", "duplicated_messages_mechanism": "<duplicated_messages_mechanism_value>", "override_pull_report_frequency_seconds": "<override_pull_report_frequency_seconds_value>", "override_consumer_client_ttl_seconds": "<override_consumer_client_ttl_seconds_value>", "override_starting_position": "<override_starting_position_value>", "override_blob_storage_container_prefix": "<override_blob_storage_container_prefix_value>", "client_thread_limit": "<client_thread_limit_value>", "uamqp_transport": "<uamqp_transport_value>" } } } } } |
Parameter | Data type | Requirement | Value range / Format | Description |
---|---|---|---|---|
|
| Mandatory | Min length: 1, Max length: 5 | Short, unique ID for input service, used in persistence addressing. Avoid duplicates to prevent collisions. |
|
| Mandatory | Min length: 1 | Tenant ID for Azure authentication. |
|
| Mandatory | Min length: 1 | Client ID for Azure authentication. |
|
| Mandatory | Min length: 1 | Client secret for Azure authentication. |
|
| Mandatory | Min length: 1 | Azure subscription ID. |
|
| Optional | Min length: 1 | Differentiates environments (e.g., dev, prod). Remove if unused. |
|
| Optional | Min: 60 | Custom period in seconds between data pulls, overriding default (300s). |
|
| Optional | UTC datetime format: | Custom start date for data retrieval, for historical data download. Remove if unused. |
|
| Optional | Glob patterns e.g., | Includes resources matching patterns. Remove if unused. |
|
| Optional | Glob patterns e.g., | Excludes resources matching patterns. Remove if unused. |
|
| Mandatory | Min length: 1 | Name for the queue, appears in related logs. |
|
| Mandatory | Min length: 1 | Name of the Event Hub to pull events from. |
|
| Mandatory | Min length: 1 | Connection string for the Event Hub. |
|
| Optional | Min length: 1, Default: | Consumer group for the Event Hub. Defaults to |
|
| Optional | Default: | Enables auto-tagging of events. This value is always true. |
|
| Optional | Min length: 1 | Connection string for blob storage, optional for Azure Blob Storage checkpointing. |
|
| Optional | Min length: 1 | Blob storage container name, required if using Azure Blob Storage checkpointing. |
|
| Optional | Min length: 1 | Blob storage account name, alternative to using connection string for checkpointing. |
|
| Optional | Version strings | Compatibility version for event processing. |
|
| Optional | One of: | Deduplication mechanism for messages: local, global, or none. |
|
| Optional | One of: | Starting position for event |
|
| Optional | Tag-friendly string | Optional tag to override the default tagging mechanism. See Event Hubs Tagging Configuration. |
|
| Optional | Object that can include any of the following properties: default_tag, tag_map, jmespath_refs | Advanced feature. Allows users to add/update various properties of the tag. If the user utilized |
|
| Optional | Default: 60 | Frequency in seconds for reporting pull statistics in logs. |
|
| Optional | Default varies by service | Time-to-live in seconds for consumer clients, after which the collector restarts the pull cycle. |
|
| Mandatory | Min length: 1 | Azure resource group for event hub discovery. |
|
| Mandatory | Min length: 1 | Namespace within Azure for event hub discovery. |
|
| Optional | Min length: 3, Max length: 10; Default: | Prefix for blob storage containers created by auto-discovery service. Remove if unused. |
|
| Optional | Default: | Allows users to override/force |
|
| Optional | List of | Allows to define which partitions are going to be connected by this instance of the collector. It overrides |
|
| Optional | Min value: 1 | Adv feature - most users should use |
...
The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Collector Docker image | SHA-256 hash |
---|---|
|
Use the following command to add the Docker image to the system:
...