Page History

/**
 * Implementations are thread *safe @paramso nameplugins may use the PluginMetrics instance from  The name of the metric
     * @param description A human-readable description to include in the metricmultiple threads
 */
public interface PluginMetrics extends Closeable {

    /**
     * @paramCreate tagsa {@link MetricName} with the given name,  additional key/value attributes of the metricdescription and tags. The group will be set to "plugins"
     */
    MetricName metricName(String name, String description, Map<String, String> tags);

 Tags to uniquely identify the plugins are automatically added to the provided tags
     /**
     * Add@param aname metric to monitor an object that implements {@link MetricValueProvider}. This metric won't be associated with anyThe name of the metric
     * sensor.@param Thisdescription isA ahuman-readable waydescription to exposeinclude existingin values as metrics.the metric
     *
 @param tags      * @param metricNameadditional Thekey/value nameattributes of the metric
     */
 @param metricValueProvider The metric value provider associated with this metricMetricName metricName(String name, String description, Map<String, String> tags);

     * @throws IllegalArgumentException if/**
     * Add a metric with same name already exists.
     */to monitor an object that implements {@link MetricValueProvider}. This metric won't be associated with any
    void addMetric(MetricName metricName, MetricValueProvider<?> metricValueProvider);

    /**
     * Remove a metric if it exists* sensor. This is a way to expose existing values as metrics.
     *
     * @param metricName The name of the metric
     * @throws@param IllegalArgumentExceptionmetricValueProvider ifThe themetric pluginvalue hasprovider not already created a metric associated with this namemetric
     */
    void removeMetric @throws IllegalArgumentException if a metric with same name already exists.
     */
    void addMetric(MetricName metricName, MetricValueProvider<?> metricValueProvider);

    /**
     * CreateRemove a sensormetric withif theit givenexists.
 unique name. The name must*
 only be unique for the* plugin,@param sometricName differentThe pluginsname can useof the same names.metric
     *
 @throws IllegalArgumentException if the plugin has * @param name The sensornot already created a metric with this name
     * @return The sensor/
    void removeMetric(MetricName metricName);

     * @throws IllegalArgumentException if/**
     * Create a sensor with samethe namegiven alreadyunique existsname. forThe thisname plugin
must only be unique for */
the plugin, so different Sensorplugins sensor(String name);

    /**can use the same names.
     *
 Remove a sensor (if it* exists)@param andname itsThe associatedsensor metrics.name
     *
 @return The sensor
  *  @param name* The@throws nameIllegalArgumentException ofif thea sensor towith same bename removed
already exists for this plugin
 * @throws IllegalArgumentException if the*/
 plugin has not alreadySensor created a sensor with this namesensor(String name);

    /**
     */
 Remove a  voidsensor removeSensor(Stringif name);
}

/**
 * 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

/**
 * 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@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 @paraminstance keyimplements TheMonitorable, configuration
 key* forset the class.
 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 key The configuration key for the classes.   
 * @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.
 * @return The list of configured instances.
 */
public <T> List<T> getConfiguredInstances(String key, List<String> classNames, Class<T> t, Map<String, Object> configOverrides, Metrics metrics)