Documentation Grafana Cloud Observe and act Instrument and send data Grafana Alloy Reference Components otelcol otelcol.encoding.jsonlog

otelcol.encoding.jsonlog

otelcol.encoding.jsonlog encodes and decodes OpenTelemetry log records as JSON. It exposes a handler that compatible otelcol components can use to marshal and unmarshal logs.

You can specify multiple otelcol.encoding.jsonlog components by giving them different labels.

Usage

Alloy Copy

otelcol.encoding.jsonlog "<LABEL>" {
}

Arguments

You can use the following arguments with otelcol.encoding.jsonlog:

The array_mode argument controls the JSON document shape. When array_mode is true, unmarshaled input must be a JSON array of objects, and marshaled output is a JSON array. When array_mode is false, unmarshaled input can be a single JSON object or a stream of concatenated JSON objects, including newline-delimited JSON. Marshaled output contains one JSON object per line when array_mode is false and there are multiple log records.

The mode argument supports the following values:

• body marshals each log record’s body and requires the body to be a map.
• body_with_inline_attributes marshals each log record as an object containing its body, resourceAttributes, and logAttributes fields when those fields aren’t empty.

The mode argument affects marshaling only. During unmarshaling, the component stores each JSON object as a log record body.

Blocks

The otelcol.encoding.jsonlog component doesn’t support any blocks. You can configure this component with arguments.

Exported fields

The following fields are exported and can be referenced by other components:

Component health

otelcol.encoding.jsonlog is only reported as unhealthy if given an invalid configuration.

Debug information

otelcol.encoding.jsonlog doesn’t expose any component-specific debug information.

Debug metrics

otelcol.encoding.jsonlog doesn’t expose any component-specific debug metrics.

Examples

otelcol.receiver.awss3

This example uses otelcol.encoding.jsonlog to decode newline-delimited JSON log records from S3 objects with keys that end in .jsonl. The receiver forwards the decoded logs to otelcol.exporter.debug:

Alloy Copy

otelcol.encoding.jsonlog "default" {
	array_mode = false
}

otelcol.receiver.awss3 "default" {
	start_time = "2024-01-01 01:00"
	end_time   = "2024-01-02"

	s3downloader {
		region    = "us-west-1"
		s3_bucket = "mybucket"
		s3_prefix = "logs"
	}

	encoding {
		extension = otelcol.encoding.jsonlog.default.handler
		suffix    = ".jsonl"
	}

	output {
		logs = [otelcol.exporter.debug.default.input]
	}
}

otelcol.exporter.debug "default" {}