Azure Monitor Logs
Configuration Options
Required Options
customer_id(required)
The unique identifier for the Log Analytics workspace.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["5ce893d9-2c32-4b6c-91a9-b0887c2de2d6","97ce69d9-b4be-4241-8dbd-d265edcf06c4"] |
log_type(required)
The record type of the data that is being submitted. Can only contain letters, numbers, and underscore (_), and may not exceed 100 characters.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["MyTableName","MyRecordType"] |
inputs(required)
A list of upstream source or transform
IDs. Wildcards (*) are supported.
See configuration for more info.
| Type | Syntax | Default | Example |
|---|---|---|---|
| array | literal | ["my-source-or-transform-id","prefix-*"] |
encoding(required)
Configures the encoding specific sink behavior.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | literal | [] |
shared_key(required)
The primary or the secondary key for the Log Analytics workspace.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["${AZURE_MONITOR_SHARED_KEY_ENV_VAR}","SERsIYhgMVlJB6uPsq49gCxNiruf6v0vhMYE+lfzbSGcXjdViZdV/e5pEMTYtw9f8SkVLf4LFlLCc2KxtRZfCA=="] |
type(required)
The component type. This is a required field for all components and tells Vector which component to use.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["azure_monitor_logs"] |
Advanced Options
azure_resource_id(optional)
Resource ID of the Azure resource the data should be associated with.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/otherResourceGroup/providers/Microsoft.Storage/storageAccounts/examplestorage","/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/examplegroup/providers/Microsoft.SQL/servers/serverName/databases/databaseName"] |
host(optional)
Alternative host for dedicated Azure regions.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ods.opinsights.azure.com | ["ods.opinsights.azure.us","ods.opinsights.azure.cn"] |
buffer(optional)
Configures the sink specific buffer behavior.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | literal | [] |
batch(optional)
Configures the sink batching behavior.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | [] |
healthcheck(optional)
Health check options for the sink.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | [] |
tls(optional)
Configures the TLS options for incoming connections.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | literal | [] |
proxy(optional)
Configures an HTTP(S) proxy for Vector to use. By default, the globally configured proxy is used.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | literal | [] |
How it Works
State
This component is stateless, meaning its behavior is consistent across each input.
Health checks
Health checks ensure that the downstream service is accessible and ready to accept data. This check is performed upon sink initialization. If the health check fails an error will be logged and Vector will proceed to start.
Transport Layer Security (TLS)
Buffers and batches
This component buffers & batches data as shown in the diagram above. You'll notice that Vector treats these concepts differently, instead of treating them as global concepts, Vector treats them as sink specific concepts. This isolates sinks, ensuring services disruptions are contained and delivery guarantees are honored.
Batches are flushed when 1 of 2 conditions are met:
- The batch age meets or exceeds the configured
timeout_secs. - The batch size meets or exceeds the configured
max_sizeormax_events.
Buffers are controlled via the buffer.* options.