Skip to content

Azure Monitor Data Collector

Azure Monitor Data Collector (azure-monitor)

Specialized preset that wraps azure-monitor output parameters so deployments can ship datasets into Azure Log Analytics/Sentinel without hand-authoring http-post jobs.

Observability json

Minimal example

output:
azure-monitor:
shared-key: ~
workspace-id: ~
JSON
{
"output": {
"azure-monitor": {
"shared-key": null,
"workspace-id": null
}
}
}

Contents

Authentication

Authentication
FieldTypeRequiredDescription
shared-keystringBase64-encoded workspace shared key.

Diagnostics

Diagnostics
FieldTypeRequiredDescription
test-urlurl (string)Override endpoint during dry-runs (bypasses workspace+api_version).
Examples: https://example.com/path

Endpoint

Endpoint
FieldTypeRequiredDescription
workspace-idstringAzure Log Analytics workspace ID (customer ID).
ingestion-uristringFull ingestion URI (defaults to https://{workspace}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01).
api-versionstringAPI version appended when ingestion_uri is omitted.

Payload

Payload
FieldTypeRequiredDescription
log-typestringLog-Type assigned inside Azure Monitor.
body-fieldfield (string)Restrict the payload to this field (must contain JSON).
Examples: data_field
time-generated-fieldfield (string)ISO 8601 timestamp field mapped to time-generated-field.
Examples: data_field
resource-idstringAzure Resource ID applied via x-ms-AzureResourceId.

Processing

Processing
FieldTypeRequiredDescription
batchBatchBatching behavior for upstream events.

Reliability

Reliability
FieldTypeRequiredDescription
retryRetryRetry policy applied to Azure Monitor requests.

Schema

Batch Fields

FieldTypeRequiredDescription
fixed-sizenumber (integer)maximum number of events in an output batch.
Examples: 42, 1.2e-10
modeModeIf ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
Allowed values: fixed, document
timeouttime-interval (string)interval after which the batch is sent, to keep throughput going (default 100ms).
Default: 100ms
Examples: 500ms, 2h
headermultiline-text (string)put a header line before the batch.
footermultiline-text (string)put a header line after the last line of the batch.
use-document-markerboolean (bool)Enrich the job metadata with a document marker (for document handling in batch mode).
Default: false
wrap-as-jsonboolean (bool)Format the output batch as a JSON array.
Default: false

Retry Fields

FieldTypeRequiredDescription
timeouttime-interval (string)timeout (e.g. 500ms, 2s etc. - default is 30).
Examples: 500ms, 2h
retriesnumber (integer)number of retries.
Examples: 42, 1.2e-10

Batch - Mode Options

ValueNameDescription
fixedfixedFixed
documentdocumentDocument