Skip to content

doc: correctly mark field func as deprecated #713

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

Merged
kruskall merged 1 commit into from
Oct 14, 2025
Merged

doc: correctly mark field func as deprecated #713

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
3 changes: 3 additions & 0 deletions kafka/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import (
type SASLMechanism = sasl.Mechanism

// TopicLogFieldFunc is a function that returns a zap.Field for a given topic.
//
// Deprecated: use TopicLogFieldsFunc instead.
type TopicLogFieldFunc func(topic string) zap.Field

Expand Down Expand Up @@ -158,6 +159,7 @@ type CommonConfig struct {
// topic for these metrics:
// - producer.messages.count
// - consumer.messages.fetched
//
// Deprecated: Use TopicAttributesFunc instead.
TopicAttributeFunc TopicAttributeFunc

Expand All @@ -169,6 +171,7 @@ type CommonConfig struct {

// TopicAttributeFunc can be used to create one custom dimension from a Kafka
// topic for log messages.
//
// Deprecated: use TopicLogFieldsFunc instead.
TopicLogFieldFunc TopicLogFieldFunc

Expand Down