## Uses of Interface
org.apache.storm.metric.api.IMetric

- Packages that use IMetric
  Package | Description
  --- | ---
  org.apache.storm.daemon.metrics |
  org.apache.storm.executor |
  org.apache.storm.kafka.spout.metrics |
  org.apache.storm.messaging |
  org.apache.storm.metric.api |
  org.apache.storm.metric.api.rpc |
  org.apache.storm.metric.cgroup |
  org.apache.storm.metric.internal |
  org.apache.storm.metrics.hdrhistogram |
  org.apache.storm.metrics.sigar |
  org.apache.storm.task |
  org.apache.storm.trident.operation |

- - ### Uses of IMetric in org.apache.storm.daemon.metrics

    Fields in org.apache.storm.daemon.metrics with type parameters of type IMetric
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,IMetric>` | BuiltinMetrics.`metricMap`

    Methods in org.apache.storm.daemon.metrics with parameters of type IMetric
    Modifier and Type | Method and Description
    --- | ---
    `static void` | BuiltinMetricsUtil.`registerMetric(String name, IMetric metric, Map<String,Object> topoConf, TopologyContext context)`

  - ### Uses of IMetric in org.apache.storm.executor

    Fields in org.apache.storm.executor with type parameters of type IMetric
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<Integer,Map<Integer,Map<String,IMetric>>>` | Executor.`intervalToTaskToMetricToRegistry`

    Methods in org.apache.storm.executor that return types with arguments of type IMetric
    Modifier and Type | Method and Description
    --- | ---
    `Map<Integer,Map<Integer,Map<String,IMetric>>>` | Executor.`getIntervalToTaskToMetricToRegistry()`

  - ### Uses of IMetric in org.apache.storm.kafka.spout.metrics

    Classes in org.apache.storm.kafka.spout.metrics that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `KafkaOffsetMetric<K,V>` This class is used compute the partition and topic level offset metrics.

  - ### Uses of IMetric in org.apache.storm.messaging

    Classes in org.apache.storm.messaging that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DeserializingConnectionCallback` A class that is called when a TaskMessage arrives.

  - ### Uses of IMetric in org.apache.storm.metric.api

    Classes in org.apache.storm.metric.api that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AssignableMetric`
    `class` | `CombinedMetric`
    `class` | `CountMetric`
    `class` | `MultiCountMetric`
    `class` | `MultiReducedMetric`
    `class` | `ReducedMetric`
    `class` | `StateMetric`

  - ### Uses of IMetric in org.apache.storm.metric.api.rpc

    Subinterfaces of IMetric in org.apache.storm.metric.api.rpc
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IShellMetric`

    Classes in org.apache.storm.metric.api.rpc that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AssignableShellMetric`
    `class` | `CombinedShellMetric`
    `class` | `CountShellMetric`
    `class` | `ReducedShellMetric`

  - ### Uses of IMetric in org.apache.storm.metric.cgroup

    Classes in org.apache.storm.metric.cgroup that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CGroupCpu` Report CPU used in the cgroup.
    `class` | `CGroupCpuGuarantee` Report the guaranteed number of ms this worker has requested.
    `class` | `CGroupMemoryLimit` Reports the current memory limit of the cgroup for this worker.
    `class` | `CGroupMemoryUsage` Reports the current memory usage of the cgroup for this worker.
    `class` | `CGroupMetricsBase<T>` Base class for checking if CGroups are enabled, etc.

  - ### Uses of IMetric in org.apache.storm.metric.internal

    Classes in org.apache.storm.metric.internal that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CountStatAndMetric` Acts as a Count Metric, but also keeps track of approximate counts for the last 10 mins, 3 hours, 1 day, and all time.
    `class` | `LatencyStatAndMetric` Acts as a Latency Metric, but also keeps track of approximate latency for the last 10 mins, 3 hours, 1 day, and all time.
    `class` | `MultiCountStatAndMetric<T>` Acts as a MultiCount Metric, but keeps track of approximate counts for the last 10 mins, 3 hours, 1 day, and all time.
    `class` | `MultiLatencyStatAndMetric<T>` Acts as a Latnecy Metric for multiple keys, but keeps track of approximate counts for the last 10 mins, 3 hours, 1 day, and all time.

  - ### Uses of IMetric in org.apache.storm.metrics.hdrhistogram

    Classes in org.apache.storm.metrics.hdrhistogram that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `HistogramMetric` A metric wrapping an HdrHistogram.

  - ### Uses of IMetric in org.apache.storm.metrics.sigar

    Classes in org.apache.storm.metrics.sigar that implement IMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CPUMetric` A metric using Sigar to get User and System CPU utilization for a worker.

  - ### Uses of IMetric in org.apache.storm.task

    Methods in org.apache.storm.task with type parameters of type IMetric
    Modifier and Type | Method and Description
    --- | ---
    `<T extends IMetric> T` | IMetricsContext.`registerMetric(String name, T metric, int timeBucketSizeInSecs)` Deprecated. in favor of metrics v2 (the non-deprecated methods on this class)
    `<T extends IMetric> T` | TopologyContext.`registerMetric(String name, T metric, int timeBucketSizeInSecs)` Deprecated.

    Methods in org.apache.storm.task that return IMetric
    Modifier and Type | Method and Description
    --- | ---
    `IMetric` | TopologyContext.`getRegisteredMetricByName(String name)` Deprecated.

    Constructor parameters in org.apache.storm.task with type arguments of type IMetric
    Constructor and Description
    `TopologyContext(StormTopology topology, Map<String,Object> topoConf, Map<Integer,String> taskToComponent, Map<String,List<Integer>> componentToSortedTasks, Map<String,Map<String,Fields>> componentToStreamToFields, Map<String,Long> blobToLastKnownVersionShared, String stormId, String codeDir, String pidDir, Integer taskId, Integer workerPort, List<Integer> workerTasks, Map<String,Object> defaultResources, Map<String,Object> userResources, Map<String,Object> executorData, Map<Integer,Map<Integer,Map<String,IMetric>>> registeredMetrics, AtomicBoolean openOrPrepareWasCalled, StormMetricRegistry metricRegistry)`

  - ### Uses of IMetric in org.apache.storm.trident.operation

    Methods in org.apache.storm.trident.operation with type parameters of type IMetric
    Modifier and Type | Method and Description
    --- | ---
    `<T extends IMetric> T` | TridentOperationContext.`registerMetric(String name, T metric, int timeBucketSizeInSecs)`

Copyright © 2019 The Apache Software Foundation. All rights reserved.