org.ballerinalang.util.metrics

Interface Counter

All Superinterfaces:

Metric

All Known Implementing Classes:

NoOpCounter

public interface Counter
extends Metric

A monotonically increasing counter metric. Use Gauge Gauge to track a value that goes up and down.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Counter.Builder Builder for Counters.

Method Summary

Modifier and Type	Method and Description
static Counter.Builder	builder(String name) Create new builder for Counter.
double	count()
default void	increment() Increment the counter by one.
void	increment(double amount) Increment the counter by amount.

Methods inherited from interface org.ballerinalang.util.metrics.Metric

getId

Method Detail

builder

static Counter.Builder builder(String name)

Create new builder for Counter.

Parameters:

name - The name of the metric.

Returns:

The builder for Counter.

increment

default void increment()

Increment the counter by one.

increment

void increment(double amount)

Increment the counter by amount.

Parameters:

amount - Amount to add to the counter.

count

double count()

Returns:

The cumulative count since this counter was created.