Skip to content

Commit

Permalink
better comments
Browse files Browse the repository at this point in the history
  • Loading branch information
FZambia committed Oct 19, 2023
1 parent 139c4c6 commit 5029022
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions config.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,18 @@ type Config struct {
// When zero Centrifuge uses default 30 days which we believe is more than enough
// for most use cases.
HistoryMetaTTL time.Duration
// GetChannelNamespaceLabel if set will be used by Centrifuge to extract channel_group label
// for channel related metrics. Make sure to maintain low cardinality of returned
// GetChannelNamespaceLabel if set will be used by Centrifuge to extract channel_group
// label for channel related metrics. Make sure to maintain low cardinality of returned
// values to avoid issues with Prometheus performance. This function may introduce
// sufficient overhead since it's called in hot paths.
// sufficient overhead since it's called in hot paths - so should be fast.
GetChannelNamespaceLabel func(channel string) string
// ChannelNamespaceLabelForMessagesSent ...
// ChannelNamespaceLabelForMessagesSent enables using GetChannelNamespaceLabel
// function for extracting channel_namespace label for transport_messages_sent and
// transport_messages_sent_size.
ChannelNamespaceLabelForMessagesSent bool
// ChannelNamespaceLabelForMessagesReceived ...
// ChannelNamespaceLabelForMessagesReceived enables using GetChannelNamespaceLabel
// function for extracting channel_namespace label for transport_messages_received and
// transport_messages_received_size.
ChannelNamespaceLabelForMessagesReceived bool
}

Expand Down

0 comments on commit 5029022

Please sign in to comment.