Skip to content

Commit

Permalink
Update loki.source.kafka.md (#3448)
Browse files Browse the repository at this point in the history
Remove non-recommended additional header as pointed out here: #3412 (comment)
  • Loading branch information
rfratto authored and clayton-cornell committed Aug 14, 2023
1 parent 4820fbf commit 4d87445
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/sources/flow/reference/components/loki.source.kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,21 @@ Name | Type | Description | Defau

`assignor` values can be either `"range"`, `"roundrobin"`, or `"sticky"`.

Labels from the `labels` argument are applied to every message that the component reads.

The `relabel_rules` field can make use of the `rules` export value from a
`loki.relabel` component to apply one or more relabeling rules to log entries
before they're forwarded to the list of receivers in `forward_to`.

In addition to custom labels, the following internal labels prefixed with `__` are available
but are discarded if not relabeled using the `relabel_rules` argument:

- `__meta_kafka_message_key`
- `__meta_kafka_topic`
- `__meta_kafka_partition`
- `__meta_kafka_member_id`
- `__meta_kafka_group_id`

## Blocks

The following blocks are supported inside the definition of `loki.source.kafka`:
Expand Down Expand Up @@ -92,17 +103,6 @@ Name | Type | Description | Default | Required
`password` | `string` | The password to use for SASL authentication. | `""` | no
`use_tls` | `bool` | If true, SASL authentication is executed over TLS. | `false` | no

## Labels

The `labels` map is applied to every message that the component reads.

The following internal labels prefixed with `__` are available but are discarded if not relabeled:
- `__meta_kafka_message_key`
- `__meta_kafka_topic`
- `__meta_kafka_partition`
- `__meta_kafka_member_id`
- `__meta_kafka_group_id`

## Exported fields

`loki.source.kafka` does not export any fields.
Expand Down

0 comments on commit 4d87445

Please sign in to comment.