pyflink.metrics package

Module contents

class pyflink.metrics.Counter(inner_counter)

Bases: Metric

Counter metric interface. Allows a count to be incremented/decremented during pipeline execution.

dec(n=1)

get_count()

inc(n=1)

class pyflink.metrics.Distribution(inner_distribution)

Bases: Metric

Distribution Metric interface.

Allows statistics about the distribution of a variable to be collected during pipeline execution.

update(value)

class pyflink.metrics.Meter(inner_counter)

Bases: Metric

Meter Metric interface.

Metric for measuring throughput.

get_count()

mark_event(value=1)

class pyflink.metrics.Metric

Bases: object

Base interface of a metric object.

class pyflink.metrics.MetricGroup

Bases: ABC

add_group(name: str, extra: Optional[str] = None) → MetricGroup

Creates a new MetricGroup and adds it to this groups sub-groups.

If extra is not None, creates a new key-value MetricGroup pair. The key group is added to this group’s sub-groups, while the value group is added to the key group’s sub-groups. In this case, the value group will be returned and a user variable will be defined.

counter(name: str) → Counter

Registers a new Counter with Flink.

distribution(name: str) → Distribution

Registers a new Distribution with Flink.

gauge(name: str, obj: Callable[[], int]) → None

Registers a new Gauge with Flink.

meter(name: str, time_span_in_seconds: int = 60) → Meter

Registers a new Meter with Flink.