com.facebook.battery.metrics.composite

Class CompositeMetricsCollector

java.lang.Object

com.facebook.battery.metrics.api.SystemMetricsCollector<CompositeMetrics>

com.facebook.battery.metrics.composite.CompositeMetricsCollector

public class CompositeMetricsCollector
extends SystemMetricsCollector<CompositeMetrics>

Composite metrics collector allows batching and using several Metrics Collectors together, keyed by the SystemMetrics they're attached to.

For example, CompositeMetricsCollector collector = new CompositeMetricsCollector() .addMetricsCollector(TimeMetrics.class, new TimeMetricsCollector()) .addMetricsCollector(CpuMetrics.class, new CpuMetricsCollector()); <p>CompositeMetrics snapshot = collector.createMetrics(); collector.getSnapshot(snapshot); <p>long uptimeMs = snapshot.getMetric(TimeMetrics.class).uptimeMs; // etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositeMetricsCollector.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompositeMetricsCollector(CompositeMetricsCollector.Builder builder)

Method Summary

Modifier and Type	Method and Description
CompositeMetrics	createMetrics() Creates an empty instance of the corresponding system metrics.
<S extends SystemMetrics<S>,T extends SystemMetricsCollector<S>> T	getMetricsCollector(java.lang.Class<S> metricsClass) Get the metrics collector associated with a metrics type
boolean	getSnapshot(CompositeMetrics snapshot) Gets the snapshot for all the metrics and returns a CompositeMetrics object with the value

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeMetricsCollector

protected CompositeMetricsCollector(CompositeMetricsCollector.Builder builder)

Method Detail

getMetricsCollector

public <S extends SystemMetrics<S>,T extends SystemMetricsCollector<S>> T getMetricsCollector(java.lang.Class<S> metricsClass)

Get the metrics collector associated with a metrics type

Parameters:

metricsClass - Type of metric

Returns:

Instance of metric collector if metrics class present in map, else null

getSnapshot

public boolean getSnapshot(CompositeMetrics snapshot)

Gets the snapshot for all the metrics and returns a CompositeMetrics object with the value

Specified by:

getSnapshot in class SystemMetricsCollector<CompositeMetrics>

Parameters:

snapshot - snapshot to reuse

Returns:

CompositeMetrics object containing all the snapshot values

createMetrics

public CompositeMetrics createMetrics()

Description copied from class: SystemMetricsCollector

Creates an empty instance of the corresponding system metrics.

Explicitly having this function available reduces a significant amount of boilerplate

Specified by:

createMetrics in class SystemMetricsCollector<CompositeMetrics>

Returns:

New System Metrics object