ob-col/receiver/kafkametricsreceiver/documentation.md

kafkametrics

Default Metrics

The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

metrics:
  <metric_name>:
    enabled: false

kafka.brokers

Number of brokers in the cluster.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{brokers}	Sum	Int	Cumulative	false

kafka.consumer_group.lag

Current approximate lag of consumer group at partition of topic

Unit	Metric Type	Value Type
1	Gauge	Int

Attributes

Name	Description	Values
group	The ID (string) of a consumer group	Any Str
topic	The ID (integer) of a topic	Any Str
partition	The number (integer) of the partition	Any Int

kafka.consumer_group.lag_sum

Current approximate sum of consumer group lag across all partitions of topic

Unit	Metric Type	Value Type
1	Gauge	Int

Attributes

Name	Description	Values
group	The ID (string) of a consumer group	Any Str
topic	The ID (integer) of a topic	Any Str

kafka.consumer_group.members

Count of members in the consumer group

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{members}	Sum	Int	Cumulative	false

Attributes

Name	Description	Values
group	The ID (string) of a consumer group	Any Str

kafka.consumer_group.offset

Current offset of the consumer group at partition of topic

Unit	Metric Type	Value Type
1	Gauge	Int

Attributes

Name	Description	Values
group	The ID (string) of a consumer group	Any Str
topic	The ID (integer) of a topic	Any Str
partition	The number (integer) of the partition	Any Int

kafka.consumer_group.offset_sum

Sum of consumer group offset across partitions of topic

Unit	Metric Type	Value Type
1	Gauge	Int

Attributes

Name	Description	Values
group	The ID (string) of a consumer group	Any Str
topic	The ID (integer) of a topic	Any Str

kafka.partition.current_offset

Current offset of partition of topic.

Unit	Metric Type	Value Type
1	Gauge	Int

Attributes

Name	Description	Values
topic	The ID (integer) of a topic	Any Str
partition	The number (integer) of the partition	Any Int

kafka.partition.oldest_offset

Oldest offset of partition of topic

Unit	Metric Type	Value Type
1	Gauge	Int

Attributes

Name	Description	Values
topic	The ID (integer) of a topic	Any Str
partition	The number (integer) of the partition	Any Int

kafka.partition.replicas

Number of replicas for partition of topic

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{replicas}	Sum	Int	Cumulative	false

Attributes

Name	Description	Values
topic	The ID (integer) of a topic	Any Str
partition	The number (integer) of the partition	Any Int

kafka.partition.replicas_in_sync

Number of synchronized replicas of partition

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{replicas}	Sum	Int	Cumulative	false

Attributes

Name	Description	Values
topic	The ID (integer) of a topic	Any Str
partition	The number (integer) of the partition	Any Int

kafka.topic.partitions

Number of partitions in topic.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic
{partitions}	Sum	Int	Cumulative	false

Attributes

Name	Description	Values
topic	The ID (integer) of a topic	Any Str