A B C D F G H I L M N O R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractReporter - Class in org.apache.flink.metrics.reporter
-
Base interface for custom metric reporters.
- AbstractReporter() - Constructor for class org.apache.flink.metrics.reporter.AbstractReporter
- addGroup(int) - Method in interface org.apache.flink.metrics.MetricGroup
-
Creates a new MetricGroup and adds it to this groups sub-groups.
- addGroup(String) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- addGroup(String) - Method in interface org.apache.flink.metrics.MetricGroup
-
Creates a new MetricGroup and adds it to this groups sub-groups.
- addGroup(String, String) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- addGroup(String, String) - Method in interface org.apache.flink.metrics.MetricGroup
-
Creates a new key-value MetricGroup pair.
- addSpan(SpanBuilder) - Method in interface org.apache.flink.metrics.MetricGroup
B
- build() - Method in class org.apache.flink.traces.SpanBuilder
- builder(Class<?>, String) - Static method in interface org.apache.flink.traces.Span
C
- CacheMetricGroup - Interface in org.apache.flink.metrics.groups
-
Pre-defined metrics for cache.
- castFrom(MetricGroup) - Static method in interface org.apache.flink.metrics.LogicalScopeProvider
-
Casts the given metric group to a
LogicalScopeProvider
, if it implements the interface. - CharacterFilter - Interface in org.apache.flink.metrics
-
Interface for a character filter function.
- close() - Method in interface org.apache.flink.metrics.reporter.MetricReporter
-
Closes this reporter.
- close() - Method in interface org.apache.flink.traces.reporter.TraceReporter
-
Closes this reporter.
- counter(int) - Method in interface org.apache.flink.metrics.MetricGroup
-
Creates and registers a new
Counter
with Flink. - counter(int, C) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a
Counter
with Flink. - counter(String) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- counter(String) - Method in interface org.apache.flink.metrics.MetricGroup
-
Creates and registers a new
Counter
with Flink. - counter(String, C) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- counter(String, C) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a
Counter
with Flink. - Counter - Interface in org.apache.flink.metrics
-
A Counter is a
Metric
that measures a count. - COUNTER - org.apache.flink.metrics.MetricType
- counters - Variable in class org.apache.flink.metrics.reporter.AbstractReporter
- createCacheMetricGroup() - Static method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- createMetricReporter(Properties) - Method in interface org.apache.flink.metrics.reporter.MetricReporterFactory
-
Creates a new metric reporter.
- createOperatorIOMetricGroup() - Static method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- createOperatorMetricGroup() - Static method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- createSinkWriterMetricGroup() - Static method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- createSourceReaderMetricGroup() - Static method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- createSplitEnumeratorMetricGroup() - Static method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- createTraceReporter(Properties) - Method in interface org.apache.flink.traces.reporter.TraceReporterFactory
-
Creates a new trace reporter.
D
- dec() - Method in interface org.apache.flink.metrics.Counter
-
Decrement the current count by 1.
- dec() - Method in class org.apache.flink.metrics.SimpleCounter
-
Decrement the current count by 1.
- dec() - Method in class org.apache.flink.metrics.ThreadSafeSimpleCounter
-
Decrement the current count by 1.
- dec(long) - Method in interface org.apache.flink.metrics.Counter
-
Decrement the current count by the given value.
- dec(long) - Method in class org.apache.flink.metrics.SimpleCounter
-
Decrement the current count by the given value.
- dec(long) - Method in class org.apache.flink.metrics.ThreadSafeSimpleCounter
-
Decrement the current count by the given value.
F
- filterCharacters(String) - Method in interface org.apache.flink.metrics.CharacterFilter
-
Filter the given string and generate a resulting string from it.
G
- gauge(int, G) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a new
Gauge
with Flink. - gauge(String, G) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- gauge(String, G) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a new
Gauge
with Flink. - Gauge<T> - Interface in org.apache.flink.metrics
-
A Gauge is a
Metric
that calculates a specific value at a point in time. - GAUGE - org.apache.flink.metrics.MetricType
- gauges - Variable in class org.apache.flink.metrics.reporter.AbstractReporter
- getAllVariables() - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- getAllVariables() - Method in interface org.apache.flink.metrics.MetricGroup
-
Returns a map of all variables and their associated value, for example
{"<host>"="host-7", "<tm_id>"="taskmanager-2"}
. - getAttributes() - Method in class org.apache.flink.traces.SimpleSpan
- getAttributes() - Method in interface org.apache.flink.traces.Span
-
Currently returned values can be of type String, Long or Double, however more types can be added in the future.
- getBoolean(String, boolean) - Method in class org.apache.flink.metrics.MetricConfig
-
Searches for the property with the specified key in this property list.
- getCount() - Method in interface org.apache.flink.metrics.Counter
-
Returns the current count.
- getCount() - Method in interface org.apache.flink.metrics.Histogram
-
Get the count of seen elements.
- getCount() - Method in interface org.apache.flink.metrics.Meter
-
Get number of events marked on the meter.
- getCount() - Method in class org.apache.flink.metrics.MeterView
- getCount() - Method in class org.apache.flink.metrics.SimpleCounter
-
Returns the current count.
- getCount() - Method in class org.apache.flink.metrics.ThreadSafeSimpleCounter
-
Returns the current count.
- getDouble(String, double) - Method in class org.apache.flink.metrics.MetricConfig
-
Searches for the property with the specified key in this property list.
- getEndTsMillis() - Method in class org.apache.flink.traces.SimpleSpan
- getEndTsMillis() - Method in interface org.apache.flink.traces.Span
- getFloat(String, float) - Method in class org.apache.flink.metrics.MetricConfig
-
Searches for the property with the specified key in this property list.
- getInteger(String, int) - Method in class org.apache.flink.metrics.MetricConfig
-
Searches for the property with the specified key in this property list.
- getIOMetricGroup() - Method in interface org.apache.flink.metrics.groups.OperatorMetricGroup
- getLogicalScope(CharacterFilter) - Method in interface org.apache.flink.metrics.LogicalScopeProvider
-
Returns the logical scope for the metric group, for example
"taskmanager.job.task"
, with the given filter being applied to all scope components. - getLogicalScope(CharacterFilter, char) - Method in interface org.apache.flink.metrics.LogicalScopeProvider
-
Returns the logical scope for the metric group, for example
"taskmanager.job.task"
, with the given filter being applied to all scope components and the given delimiter being used to concatenate scope components. - getLong(String, long) - Method in class org.apache.flink.metrics.MetricConfig
-
Searches for the property with the specified key in this property list.
- getMax() - Method in class org.apache.flink.metrics.HistogramStatistics
-
Returns the maximum value of the histogram.
- getMean() - Method in class org.apache.flink.metrics.HistogramStatistics
-
Returns the mean of the histogram values.
- getMetricIdentifier(String) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- getMetricIdentifier(String) - Method in interface org.apache.flink.metrics.MetricGroup
-
Returns the fully qualified metric name, for example
"host-7.taskmanager-2.window_word_count.my-mapper.metricName"
. - getMetricIdentifier(String, CharacterFilter) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- getMetricIdentifier(String, CharacterFilter) - Method in interface org.apache.flink.metrics.MetricGroup
-
Returns the fully qualified metric name, for example
"host-7.taskmanager-2.window_word_count.my-mapper.metricName"
. - getMetricType() - Method in interface org.apache.flink.metrics.Counter
- getMetricType() - Method in interface org.apache.flink.metrics.Gauge
- getMetricType() - Method in interface org.apache.flink.metrics.Histogram
- getMetricType() - Method in interface org.apache.flink.metrics.Meter
- getMetricType() - Method in interface org.apache.flink.metrics.Metric
- getMin() - Method in class org.apache.flink.metrics.HistogramStatistics
-
Returns the minimum value of the histogram.
- getName() - Method in class org.apache.flink.traces.SimpleSpan
- getName() - Method in interface org.apache.flink.traces.Span
- getNumBytesInCounter() - Method in interface org.apache.flink.metrics.groups.OperatorIOMetricGroup
-
The total number of input bytes since the task started.
- getNumBytesOutCounter() - Method in interface org.apache.flink.metrics.groups.OperatorIOMetricGroup
-
The total number of output bytes since the task started.
- getNumBytesSendCounter() - Method in interface org.apache.flink.metrics.groups.SinkWriterMetricGroup
-
The total number of output send bytes since the task started.
- getNumCommittablesAlreadyCommittedCounter() - Method in interface org.apache.flink.metrics.groups.SinkCommitterMetricGroup
-
The total number of already committed committables.
- getNumCommittablesFailureCounter() - Method in interface org.apache.flink.metrics.groups.SinkCommitterMetricGroup
-
The total number of committable failures.
- getNumCommittablesRetryCounter() - Method in interface org.apache.flink.metrics.groups.SinkCommitterMetricGroup
-
The total number of committable retry.
- getNumCommittablesSuccessCounter() - Method in interface org.apache.flink.metrics.groups.SinkCommitterMetricGroup
-
The total number of successful committables.
- getNumCommittablesTotalCounter() - Method in interface org.apache.flink.metrics.groups.SinkCommitterMetricGroup
-
The total number of committables arrived.
- getNumRecordsInCounter() - Method in interface org.apache.flink.metrics.groups.OperatorIOMetricGroup
-
The total number of input records since the operator started.
- getNumRecordsInErrorsCounter() - Method in interface org.apache.flink.metrics.groups.SourceReaderMetricGroup
-
The total number of record that failed to consume, process, or emit.
- getNumRecordsOutCounter() - Method in interface org.apache.flink.metrics.groups.OperatorIOMetricGroup
-
The total number of output records since the operator started.
- getNumRecordsOutErrorsCounter() - Method in interface org.apache.flink.metrics.groups.SinkWriterMetricGroup
-
The total number of records failed to send.
- getNumRecordsSendCounter() - Method in interface org.apache.flink.metrics.groups.SinkWriterMetricGroup
-
The total number of records have been sent to the downstream system.
- getNumRecordsSendErrorsCounter() - Method in interface org.apache.flink.metrics.groups.SinkWriterMetricGroup
-
The total number of records failed to send.
- getQuantile(double) - Method in class org.apache.flink.metrics.HistogramStatistics
-
Returns the value for the given quantile based on the represented histogram statistics.
- getRate() - Method in interface org.apache.flink.metrics.Meter
-
Returns the current rate of events per second.
- getRate() - Method in class org.apache.flink.metrics.MeterView
- getScope() - Method in class org.apache.flink.traces.SimpleSpan
- getScope() - Method in interface org.apache.flink.traces.Span
- getScopeComponents() - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- getScopeComponents() - Method in interface org.apache.flink.metrics.MetricGroup
-
Gets the scope as an array of the scope components, for example
["host-7", "taskmanager-2", "window_word_count", "my-mapper"]
. - getStartTsMillis() - Method in class org.apache.flink.traces.SimpleSpan
- getStartTsMillis() - Method in interface org.apache.flink.traces.Span
- getStatistics() - Method in interface org.apache.flink.metrics.Histogram
-
Create statistics for the currently recorded elements.
- getStdDev() - Method in class org.apache.flink.metrics.HistogramStatistics
-
Returns the standard deviation of the distribution reflected by the histogram statistics.
- getString(String, String) - Method in class org.apache.flink.metrics.MetricConfig
- getValue() - Method in interface org.apache.flink.metrics.Gauge
-
Calculates and returns the measured value.
- getValues() - Method in class org.apache.flink.metrics.HistogramStatistics
-
Returns the elements of the statistics' sample.
- getWrappedMetricGroup() - Method in interface org.apache.flink.metrics.LogicalScopeProvider
-
Returns the underlying metric group.
H
- histogram(int, H) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a new
Histogram
with Flink. - histogram(String, H) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- histogram(String, H) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a new
Histogram
with Flink. - Histogram - Interface in org.apache.flink.metrics
-
Histogram interface to be used with Flink's metrics system.
- HISTOGRAM - org.apache.flink.metrics.MetricType
- histograms - Variable in class org.apache.flink.metrics.reporter.AbstractReporter
- HistogramStatistics - Class in org.apache.flink.metrics
-
Histogram statistics represent the current snapshot of elements recorded in the histogram.
- HistogramStatistics() - Constructor for class org.apache.flink.metrics.HistogramStatistics
- hitCounter(Counter) - Method in interface org.apache.flink.metrics.groups.CacheMetricGroup
-
The number of cache hits.
I
- inc() - Method in interface org.apache.flink.metrics.Counter
-
Increment the current count by 1.
- inc() - Method in class org.apache.flink.metrics.SimpleCounter
-
Increment the current count by 1.
- inc() - Method in class org.apache.flink.metrics.ThreadSafeSimpleCounter
-
Increment the current count by 1.
- inc(long) - Method in interface org.apache.flink.metrics.Counter
-
Increment the current count by the given value.
- inc(long) - Method in class org.apache.flink.metrics.SimpleCounter
-
Increment the current count by the given value.
- inc(long) - Method in class org.apache.flink.metrics.ThreadSafeSimpleCounter
-
Increment the current count by the given value.
L
- latestLoadTimeGauge(Gauge<Long>) - Method in interface org.apache.flink.metrics.groups.CacheMetricGroup
-
The time spent for the latest load operation.
- loadCounter(Counter) - Method in interface org.apache.flink.metrics.groups.CacheMetricGroup
-
The number of times to load data into cache from external system.
- log - Variable in class org.apache.flink.metrics.reporter.AbstractReporter
- LogicalScopeProvider - Interface in org.apache.flink.metrics
-
Extension for metric groups that support logical scopes.
M
- markEvent() - Method in interface org.apache.flink.metrics.Meter
-
Mark occurrence of an event.
- markEvent() - Method in class org.apache.flink.metrics.MeterView
- markEvent(long) - Method in interface org.apache.flink.metrics.Meter
-
Mark occurrence of multiple events.
- markEvent(long) - Method in class org.apache.flink.metrics.MeterView
- meter(int, M) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a new
Meter
with Flink. - meter(String, M) - Method in class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- meter(String, M) - Method in interface org.apache.flink.metrics.MetricGroup
-
Registers a new
Meter
with Flink. - Meter - Interface in org.apache.flink.metrics
-
Metric for measuring throughput.
- METER - org.apache.flink.metrics.MetricType
- meters - Variable in class org.apache.flink.metrics.reporter.AbstractReporter
- MeterView - Class in org.apache.flink.metrics
-
A MeterView provides an average rate of events per second over a given time period.
- MeterView(int) - Constructor for class org.apache.flink.metrics.MeterView
- MeterView(Counter) - Constructor for class org.apache.flink.metrics.MeterView
- MeterView(Counter, int) - Constructor for class org.apache.flink.metrics.MeterView
- MeterView(Gauge<? extends Number>) - Constructor for class org.apache.flink.metrics.MeterView
- Metric - Interface in org.apache.flink.metrics
-
Common super interface for all metrics.
- MetricConfig - Class in org.apache.flink.metrics
-
A properties class with added utility method to extract primitives.
- MetricConfig() - Constructor for class org.apache.flink.metrics.MetricConfig
- MetricGroup - Interface in org.apache.flink.metrics
-
A MetricGroup is a named container for
Metrics
and further metric subgroups. - MetricReporter - Interface in org.apache.flink.metrics.reporter
-
Metric reporters are used to export
Metrics
to an external backend. - MetricReporterFactory - Interface in org.apache.flink.metrics.reporter
-
MetricReporter
factory. - MetricType - Enum in org.apache.flink.metrics
-
Enum describing the different metric types.
- missCounter(Counter) - Method in interface org.apache.flink.metrics.groups.CacheMetricGroup
-
The number of cache misses.
N
- NO_OP_FILTER - Static variable in interface org.apache.flink.metrics.CharacterFilter
- notifyOfAddedMetric(Metric, String, MetricGroup) - Method in class org.apache.flink.metrics.reporter.AbstractReporter
- notifyOfAddedMetric(Metric, String, MetricGroup) - Method in interface org.apache.flink.metrics.reporter.MetricReporter
-
Called when a new
Metric
was added. - notifyOfAddedSpan(Span) - Method in interface org.apache.flink.traces.reporter.TraceReporter
- notifyOfRemovedMetric(Metric, String, MetricGroup) - Method in class org.apache.flink.metrics.reporter.AbstractReporter
- notifyOfRemovedMetric(Metric, String, MetricGroup) - Method in interface org.apache.flink.metrics.reporter.MetricReporter
-
Called when a
Metric
was removed. - numCachedBytesGauge(Gauge<Long>) - Method in interface org.apache.flink.metrics.groups.CacheMetricGroup
-
The number of bytes used by cache.
- numCachedRecordsGauge(Gauge<Long>) - Method in interface org.apache.flink.metrics.groups.CacheMetricGroup
-
The number of records in cache.
- numLoadFailuresCounter(Counter) - Method in interface org.apache.flink.metrics.groups.CacheMetricGroup
-
The number of load failures.
O
- open(MetricConfig) - Method in interface org.apache.flink.metrics.reporter.MetricReporter
-
Configures this reporter.
- open(MetricConfig) - Method in interface org.apache.flink.traces.reporter.TraceReporter
-
Configures this reporter.
- OperatorCoordinatorMetricGroup - Interface in org.apache.flink.metrics.groups
-
Special
MetricGroup
representing an Operator coordinator. - OperatorIOMetricGroup - Interface in org.apache.flink.metrics.groups
-
Metric group that contains shareable pre-defined IO-related metrics for operators.
- OperatorMetricGroup - Interface in org.apache.flink.metrics.groups
-
Special
MetricGroup
representing an Operator. - org.apache.flink.metrics - package org.apache.flink.metrics
- org.apache.flink.metrics.groups - package org.apache.flink.metrics.groups
- org.apache.flink.metrics.reporter - package org.apache.flink.metrics.reporter
- org.apache.flink.traces - package org.apache.flink.traces
- org.apache.flink.traces.reporter - package org.apache.flink.traces.reporter
R
- report() - Method in interface org.apache.flink.metrics.reporter.Scheduled
-
Report the current measurements.
S
- Scheduled - Interface in org.apache.flink.metrics.reporter
-
Interface for reporters that actively send out data periodically.
- setAttribute(String, double) - Method in class org.apache.flink.traces.SpanBuilder
-
Additional attribute to be attached to this
Span
. - setAttribute(String, long) - Method in class org.apache.flink.traces.SpanBuilder
-
Additional attribute to be attached to this
Span
. - setAttribute(String, String) - Method in class org.apache.flink.traces.SpanBuilder
-
Additional attribute to be attached to this
Span
. - setCurrentPendingCommittablesGauge(Gauge<Integer>) - Method in interface org.apache.flink.metrics.groups.SinkCommitterMetricGroup
-
The pending committables.
- setCurrentSendTimeGauge(Gauge<Long>) - Method in interface org.apache.flink.metrics.groups.SinkWriterMetricGroup
-
Sets an optional gauge for the time it takes to send the last record.
- setEndTsMillis(long) - Method in class org.apache.flink.traces.SpanBuilder
-
Optionally you can manually set the
Span
's endTs. - setPendingBytesGauge(Gauge<Long>) - Method in interface org.apache.flink.metrics.groups.SourceReaderMetricGroup
-
Sets an optional gauge for the number of bytes that have not been fetched by the source. e.g.
- setPendingRecordsGauge(Gauge<Long>) - Method in interface org.apache.flink.metrics.groups.SourceReaderMetricGroup
-
Sets an optional gauge for the number of records that have not been fetched by the source.
- setStartTsMillis(long) - Method in class org.apache.flink.traces.SpanBuilder
-
Optionally you can manually set the
Span
's startTs. - setUnassignedSplitsGauge(G) - Method in interface org.apache.flink.metrics.groups.SplitEnumeratorMetricGroup
-
Sets an optional gauge for the number of splits that have been enumerated but not yet assigned.
- SimpleCounter - Class in org.apache.flink.metrics
-
A simple low-overhead
Counter
that is not thread-safe. - SimpleCounter() - Constructor for class org.apache.flink.metrics.SimpleCounter
- SimpleSpan - Class in org.apache.flink.traces
-
Basic implementation of
Span
. - SimpleSpan(String, String, long, long, HashMap<String, Object>) - Constructor for class org.apache.flink.traces.SimpleSpan
- SinkCommitterMetricGroup - Interface in org.apache.flink.metrics.groups
-
Pre-defined metrics for sinks.
- SinkWriterMetricGroup - Interface in org.apache.flink.metrics.groups
-
Pre-defined metrics for sinks.
- size() - Method in class org.apache.flink.metrics.HistogramStatistics
-
Returns the size of the statistics' sample.
- SourceReaderMetricGroup - Interface in org.apache.flink.metrics.groups
-
Pre-defined metrics for
SourceReader
. - Span - Interface in org.apache.flink.traces
-
Span represents something that happened in Flink at certain point of time, that will be reported to a
TraceReporter
. - SpanBuilder - Class in org.apache.flink.traces
-
Builder used to construct
Span
. - SplitEnumeratorMetricGroup - Interface in org.apache.flink.metrics.groups
-
Pre-defined metrics for
SplitEnumerator
.
T
- ThreadSafeSimpleCounter - Class in org.apache.flink.metrics
-
A simple low-overhead
Counter
that is thread-safe. - ThreadSafeSimpleCounter() - Constructor for class org.apache.flink.metrics.ThreadSafeSimpleCounter
- toString() - Method in class org.apache.flink.traces.SimpleSpan
- TraceReporter - Interface in org.apache.flink.traces.reporter
-
Trace reporters are used to export
Spans
to an external backend. - TraceReporterFactory - Interface in org.apache.flink.traces.reporter
-
TraceReporter
factory.
U
- UnregisteredMetricsGroup - Class in org.apache.flink.metrics.groups
-
A special
MetricGroup
that does not register any metrics at the metrics registry and any reporters. - UnregisteredMetricsGroup() - Constructor for class org.apache.flink.metrics.groups.UnregisteredMetricsGroup
- update() - Method in class org.apache.flink.metrics.MeterView
- update() - Method in interface org.apache.flink.metrics.View
-
This method will be called regularly to update the metric.
- update(long) - Method in interface org.apache.flink.metrics.Histogram
-
Update the histogram with the given value.
- UPDATE_INTERVAL_SECONDS - Static variable in interface org.apache.flink.metrics.View
-
The interval in which metrics are updated.
V
- valueOf(String) - Static method in enum org.apache.flink.metrics.MetricType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.flink.metrics.MetricType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- View - Interface in org.apache.flink.metrics
-
An interface for metrics which should be updated in regular intervals by a background thread.
All Classes All Packages