io.strimzi.kafka.oauth.metrics

Interface SensorKeyProducer

All Known Implementing Classes:

AbstractSensorKeyProducer, IntrospectHttpSensorKeyProducer, IntrospectValidationSensorKeyProducer, JwksHttpSensorKeyProducer, JwksValidationSensorKeyProducer, UserInfoHttpSensorKeyProducer

public interface SensorKeyProducer

An interface representing a SensorKey factory. Different locations in the Strimzi OAuth library create differently named sensors with different attributes. Sensors always come in pairs - one for tracking the successful requests, and one for tracking the failed requests.

Method Summary

Modifier and Type	Method and Description
SensorKey	errorKey(java.lang.Throwable e) Generate a SensorKey for the sensor representing the failed requests
SensorKey	successKey() Generate a SensorKey for the sensor representing the successful requests

Method Detail

successKey

SensorKey successKey()

Generate a SensorKey for the sensor representing the successful requests

Returns:

A SensorKey

errorKey

SensorKey errorKey(java.lang.Throwable e)

Generate a SensorKey for the sensor representing the failed requests

Parameters:

e - The Throwable object to go with the failure

Returns:

A SensorKey