THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Code Block | ||
|---|---|---|
| ||
public interface PluginMetrics extends Closeable {
/**
* Create a {@link MetricName} with the given name, description and tags. The group will be set to "plugins"
* Tags to uniquely identify the plugins are automatically added to the provided tags
*
* @param name The name of the metric
* @param description A human-readable description to include in the metric
* @param tags additional key/value attributes of the metric
*/
MetricName metricName(String name, String description, Map<String, String> tags);
/**
* Add a metric to monitor an object that implements {@link MetricValueProvider}. This metric won't be associated with any
* sensor. This is a way to expose existing values as metrics.
*
* @param metricName The name of the metric
* @param metricValueProvider The metric value provider associated with this metric
* @throws IllegalArgumentException if a metric with same name already exists.
*/
void addMetric(MetricName metricName, MetricValueProvider<?> metricValueProvider);
/**
* Remove a metric if it exists.
*
* @param metricName The name of the metric
*/
void removeMetric(MetricName metricName);
/**
* Create a sensor with the given unique name. The name must only be unique for the plugin, so different plugins can use the same names.
*
* @param name The sensor name
* @return The sensor
* @throws IllegalArgumentException if a sensor with same name already exists. for this plugin
*/
Sensor sensor(String name);
/**
* Remove a sensor (if it exists) and its associated metrics.
*
* @param name The name of the sensor to be removed
*/
void removeSensor(String name);
} |
The PluginMetrics interface implements Closeable. Calling the close() method removed all metrics and sensors created by this plugin.
New methods will be added to AbstractConfig so new plugin instances implementing Monitorable can get a PluginMetrics instance.
| Code Block | ||||
|---|---|---|---|---|
| ||||
/**
* Get a configured instance of the give class specified by the given configuration key. If the object implements
* Configurable configure it using the configuration. If the object implements Monitorable, set the appropriate PluginMetrics for that instance.
*
* @param key The configuration key for the class.
* @param t The interface the class should implement.
* @param metrics The metrics registry to use to build the PluginMetrics instance if the class implements Monitorable.
* @return A configured instance of the class.
*/
public <T> T getConfiguredInstance(String key, Class<T> t, Metrics metrics);
/**
* Get a configured instance of the give class specified by the given configuration key. If the object implements
* Configurable configure it using the configuration. If the object implements Monitorable, set the appropriate PluginMetrics for that instance.
*
* @param key The configuration key for the class.
* @param t The interface the class should implement.
* @param configOverrides override origin configs.
* @param metrics The metrics registry to use to build the PluginMetrics instance if the class implements Monitorable.
* @return A configured instance of the class.
*/
public <T> T getConfiguredInstance(String key, Class<T> t, Map<String, Object> configOverrides, Metrics metrics);
/**
* Get a list of configured instances of the given class specified by the given configuration key. The configuration
* may specify either null or an empty string to indicate no configured instances. If an instance implements Monitorable,
* set the appropriate PluginMetrics for that instance. In both cases, this method returns an empty list to indicate no configured instances.
* @param key The configuration key for the class.
* @param t The interface the class should implement.
* @param configOverrides Configuration overrides to use.
* @param metrics The metrics registry to use to build the PluginMetrics instances for each class that implements Monitorable.
* @return The list of configured instances.
*/
public <T> List<T> getConfiguredInstances(String key, Class<T> t, Map<String, Object> configOverrides, Metrics metrics);
/**
* Get a list of configured instances of the given class specified by the given configuration key. The configuration
* may specify either null or an empty string to indicate no configured instances. If an instance implements Monitorable,
* set the appropriate PluginMetrics for that instance. In both cases, this method returns an empty list to indicate no configured instances.
* @param classNames The list of class names of the instances to create.
* @param t The interface the class should implement.
* @param configOverrides Configuration overrides to use.
* @param metrics The metrics registry to use to build the PluginMetrics instances for each class that implements Monitorable.
* @param configKey The value used to set the config tag for metrics from this plugin.
* @return The list of configured instances.
*/
public <T> List<T> getConfiguredInstances(List<String> classNames, Class<T> t, Map<String, Object> configOverrides, Metrics metrics, String configKey) |
Proposed Changes
When instantiating a class, if it implements Monitorable, the withPluginMetrics() method will be called. If the class is also Configurable, withPluginMetrics() will be always called after configure(). Metrics registered by plugins will inherit the prefix/namespace from the current Metrics instance, these are: kafka.producer, kafka.consumer, kafka.connect, kafka.streams and kafka.server. Tags will be added to metrics and sensors tags created via the PluginMetrics interface to unique identify each instance.
...