Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update loki.source.kafka.md #3448

Merged
merged 1 commit into from
Apr 4, 2023
Merged

Update loki.source.kafka.md #3448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/sources/flow/reference/components/loki.source.kafka.md
View file
Open in desktop
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