Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 4.19 KB

README.md

File metadata and controls

95 lines (70 loc) · 4.19 KB

Azure Blob Exporter

This exporter allows you to export metrics, traces, and logs to Azure Blob Storage. Telemetry is exported in OpenTelemetry Protocol JSON format.

Minimum Agent Versions

Supported Pipelines

  • Metrics
  • Logs
  • Traces

How It Works

  1. The exporter marshals any telemetry sent to it into OTLP Json Format. It will apply compression if configured to do so.
  2. Exports telemetry to Azure Blob Storage. See Blob Path for more information on the expected blob path format.

Configuration

Field Type Default Required Description
connection_string string true The connection string to the Azure Blob Storage account. Can be found under the Access keys section of your storage account.
container string true The name of the container in the storage account to save to.
blob_prefix string false An optional prefix to prepend to blob file name.
root_folder string false An optional root folder that will prefix the blob path.
partition string minute true Time granularity of blob name. Valid values are hour or minute.
compression string none false The type of compression applied to the data before sending it to storage. Valid values are none and gzip.

Blob Path

Blob paths will be in the form:

{root_folder}/year=XXXX/month=XX/day=XX/hour=XX/minute=XX

Example Configurations

Minimal Configuration

This configuration only specifies a container and the connection string. The exporter will use the default partition of minute and will not apply compression.

azureblob:
    connection_string: "DefaultEndpointsProtocol=https;AccountName=storage_account_name;AccountKey=storage_account_key;EndpointSuffix=core.windows.net"
    container: "my-container"

Example Blob Names:

year=2021/month=01/day=01/hour=01/minute=00/metrics_{random_id}.json
year=2021/month=01/day=01/hour=01/minute=00/logs_{random_id}.json
year=2021/month=01/day=01/hour=01/minute=00/traces_{random_id}.json

Hour Partition Configuration

This shows specifying a partition of hour and that the minute=XX portion of the blob path will be omitted.

azureblob:
    connection_string: "DefaultEndpointsProtocol=https;AccountName=storage_account_name;AccountKey=storage_account_key;EndpointSuffix=core.windows.net"
    container: "my-container"
    partition: "hour"

Example Blob Names:

year=2021/month=01/day=01/hour=01/metrics_{random_id}.json
year=2021/month=01/day=01/hour=01/logs_{random_id}.json
year=2021/month=01/day=01/hour=01/traces_{random_id}.json

Full Configuration with compression

This configuration shows all fields filled out and that gzip compression is configured.

azureblob:
    connection_string: "DefaultEndpointsProtocol=https;AccountName=storage_account_name;AccountKey=storage_account_key;EndpointSuffix=core.windows.net"
    container: "my-container"
    root_folder: "otel"
    blob_prefix: "linux"
    partition: "minute"
    compression: "gzip"

Example Blob Names:

otel/year=2021/month=01/day=01/hour=01/minute=00/linuxmetrics_{random_id}.json.gz
otel/year=2021/month=01/day=01/hour=01/minute=00/linuxlogs_{random_id}.json.gz
otel/year=2021/month=01/day=01/hour=01/minute=00/linuxtraces_{random_id}.json.gz