io.cdap.cdap.etl.api

Interface StageMetrics

All Superinterfaces:

Metrics

public interface StageMetrics
extends Metrics

The interface exposes method for emitting user metrics from ETL stage.

Method Summary

Modifier and Type	Method and Description
void	count(String metricName, int delta) Increases the value of the specific metric by delta.
void	gauge(String metricName, long value) Sets the specific metric to the provided value.
void	pipelineCount(String metricName, int delta) Increases the value of the specific metric by delta.
void	pipelineGauge(String metricName, long value) Sets the specific metric to the provided value.

Method Detail

count

void count(String metricName,
           int delta)

Increases the value of the specific metric by delta. Metrics name will be prefixed by the stage id, hence it will be aggregated for the current stage.

Specified by:

count in interface Metrics

Parameters:

metricName - Name of the counter. Use alphanumeric characters in metric names.

delta - The value to increase by.

gauge

void gauge(String metricName,
           long value)

Sets the specific metric to the provided value. Metrics name will be prefixed by the stage id, hence it will be aggregated for the current stage.

Specified by:

gauge in interface Metrics

Parameters:

metricName - Name of the counter. Use alphanumeric characters in metric names.

value - The value to be set.

pipelineCount

void pipelineCount(String metricName,
                   int delta)

Increases the value of the specific metric by delta. Metrics emitted will be aggregated for the whole ETL pipeline.

Parameters:

metricName - Name of the counter. Use alphanumeric characters in metric names.

delta - The value to increase by.

pipelineGauge

void pipelineGauge(String metricName,
                   long value)

Sets the specific metric to the provided value. Metrics emitted will be aggregated for the whole ETL pipeline.

Parameters:

metricName - Name of the counter. Use alphanumeric characters in metric names.

value - The value to be set.