Class JwksRefresherMetrics

java.lang.Object

io.confluent.kafka.server.plugins.auth.oauth.JwksRefresherMetrics

public class JwksRefresherMetrics
extends Object

Metrics for JwksRefresher. Follows the AuthStoreMetrics pattern.

Metric group: "confluent-jwks-expedited-refresh-metrics".

Sensors are created lazily, keyed by (result, provider) where provider is the JWKS endpoint hostname, and are never evicted. Cardinality is therefore bounded by the number of configured OIDC provider hosts (not by request volume), which is small and stable, so the maps do not grow unbounded over the broker's lifetime.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JwksRefresherMetrics.EvictionReason	Reason an overlay cache entry was evicted.
static enum	JwksRefresherMetrics.FetchResult	Outcomes of a JWKS fetch attempt.
static enum	JwksRefresherMetrics.RefreshResult	Outcomes of a maybeExpediteRefresh call.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROUP_NAME

Constructor Summary

Constructors

Constructor	Description
JwksRefresherMetrics(org.apache.kafka.common.metrics.Metrics metrics, Supplier<Integer> overlaySize)

Method Summary

Modifier and Type	Method	Description
void	recordEviction(JwksRefresherMetrics.EvictionReason reason)
void	recordFetch(JwksRefresherMetrics.FetchResult result, String provider)
void	recordFetchFailure(JwksFetchServiceClient.FetchFailureReason reason, String provider)	Records a failed fetch tagged by its JwksFetchServiceClient.FetchFailureReason.
void	recordFetchLatency(JwksRefresherMetrics.FetchResult result, String provider, long latencyMs)
void	recordRefresh(JwksRefresherMetrics.RefreshResult result, String provider)
static void	recordWiringFailure(org.apache.kafka.common.metrics.Metrics metrics)	Records a failure to build the JwksRefresher itself (e.g.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GROUP_NAME

public static final String GROUP_NAME

See Also:

• Constant Field Values

Constructor Details

JwksRefresherMetrics

public JwksRefresherMetrics(org.apache.kafka.common.metrics.Metrics metrics,
 Supplier<Integer> overlaySize)

Method Details

recordRefresh

public void recordRefresh(JwksRefresherMetrics.RefreshResult result,
 String provider)

recordFetch

public void recordFetch(JwksRefresherMetrics.FetchResult result,
 String provider)

recordFetchFailure

public void recordFetchFailure(JwksFetchServiceClient.FetchFailureReason reason,
 String provider)

Records a failed fetch tagged by its JwksFetchServiceClient.FetchFailureReason.

recordFetchLatency

public void recordFetchLatency(JwksRefresherMetrics.FetchResult result,
 String provider,
 long latencyMs)

recordEviction

public void recordEviction(JwksRefresherMetrics.EvictionReason reason)

recordWiringFailure

public static void recordWiringFailure(org.apache.kafka.common.metrics.Metrics metrics)

Records a failure to build the JwksRefresher itself (e.g. the misconfiguration caught around JwksRefresher.create). Static, and takes Metrics directly, because this failure happens before any refresher (and therefore any instance of this class) exists.