Skip to main content
Version: 3.5.0

Output: azure-monitor

Send data to an Azure monitor

Field Summary

Field NameTypeDescriptionDefault
retryRetryFor operations that could potentially fail-
batchinteger or the 'document'Maximum number of events in an output batch. If 'document' send on end of document-
timeoutintervalInterval after which the batch is sent, to keep throughput going100ms
headertemplated textPut a header line before the batch-
footertemplated textPut a header line after the last line of the batch-
use-document-markerboolEnrich the pipe metadata with a document marker (for document handling in batch mode)false
workspace-idstringThe workspace ID for this Azure Log Monitor instance-
shared-keystringThe share key for this Azure Log Monitor instance-
log-typestringThe Log Type for this Azure Log Monitor instance-
time-generated-fieldfieldThe field containing the the event time for this event, the field should contain data in ISO 8601 format YYYY-MM-DDThh:mm:ssZ-

Fields

retry

Type: Retry

For operations that could potentially fail

Field NameTypeDescriptionDefault
countintegerHow many attempts to make before declaring failure-
pausedurationHow long to pause before re-trying-
foreverboolKeep trying until success is declaredfalse

  count

Type: integer

How many attempts to make before declaring failure

Example

Pipe Language Snippet:

exec:
command: echo 'one two'
retry:
count: 1

Output:

{"_raw":"one two"}

  pause

Type: duration

How long to pause before re-trying

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Example

Pipe Language Snippet:

exec:
command: echo 'one two'
retry:
count: 6
pause: 10s

Output:

{"_raw":"one two"}

  forever

Type: bool

Default: false

Keep trying until success is declared

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Example

Pipe Language Snippet:

exec:
command: echo 'one two'
retry:
forever: true

Output:

{"_raw":"one two"}

batch

Type: integer or the 'document'

Maximum number of events in an output batch. If 'document' send on end of document

timeout

Type: interval

Default: 100ms

Interval after which the batch is sent, to keep throughput going

Type: templated text

Put a header line before the batch

Type: templated text

Put a header line after the last line of the batch

use-document-marker

Type: bool

Default: false

Enrich the pipe metadata with a document marker (for document handling in batch mode)

workspace-id

Type: string

The workspace ID for this Azure Log Monitor instance

shared-key

Type: string

The share key for this Azure Log Monitor instance

log-type

Type: string

The Log Type for this Azure Log Monitor instance

time-generated-field

Type: field

The field containing the the event time for this event, the field should contain data in ISO 8601 format YYYY-MM-DDThh:mm:ssZ