Package com.hazelcast.jet.core.metrics

Class MetricNames

java.lang.Object

com.hazelcast.jet.core.metrics.MetricNames

public final class MetricNames
extends Object

Each metric provided by Jet has a specific name which conceptually identifies what it's being used to measure. Besides their name metrics also have a description made up by tags, but those are more like attributes which describe a specific instance of the metric and are not directly part of the identity of the metric.

The constants described here represent the various names metrics can take in Jet.

Since:

Jet 3.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COALESCED_WM	Tracks the highest watermark observed on all the input queues of a particular incoming Edge of a certain Vertex.
static final String	DISTRIBUTED_BYTES_IN	Tracks the data volume (bytes) coming in over the network for DISTRIBUTED input Edges of particular Vertex instances running on various Processors.
static final String	DISTRIBUTED_BYTES_OUT	Tracks the data volume (bytes) going out over the network for DISTRIBUTED output Edges of particular Vertex instances running on various Processors.
static final String	DISTRIBUTED_ITEMS_IN	Counts data items coming in over the network for DISTRIBUTED input Edges of particular Vertex instances running on various Processors.
static final String	DISTRIBUTED_ITEMS_OUT	Counts data items going out over the network for DISTRIBUTED output Edges of particular Vertex instances running on various Processors.
static final String	EMITTED_COUNT	Counts the data items emitted on outgoing Edges of particular Vertex instances running on various Processors.
static final String	EXECUTION_COMPLETION_TIME	Tracks the completion time of a given execution of a specific job.
static final String	EXECUTION_START_TIME	Tracks the start time of a given execution of a specific job.
static final String	IS_USER_CANCELLED	Indicates whether the job was cancelled by the user.
static final String	JOB_EXECUTIONS_COMPLETED	Number of job executions finished on the Jet cluster.
static final String	JOB_EXECUTIONS_STARTED	Number of job executions started on the Jet cluster.
static final String	JOB_STATUS	Numerical ID of the job's status.
static final String	JOBS_COMPLETED_SUCCESSFULLY	Number of jobs successfully completed by the Jet cluster.
static final String	JOBS_COMPLETED_WITH_FAILURE	Number of jobs that have failed on the Jet cluster.
static final String	JOBS_SUBMITTED	Number of jobs submitted to the Jet cluster.
static final String	LAST_FORWARDED_WM	Tracks the last watermark emitted by a particular Processor of a particular Vertex.
static final String	LAST_FORWARDED_WM_LATENCY	Tracks the difference between the last emitted watermark and the system time of a particular Processor of a particular Vertex.
static final String	QUEUES_CAPACITY	Tracks the total capacity of all input queues of a particular Vertex on a particular Processor.
static final String	QUEUES_SIZE	Tracks the total size of all input queues of a particular Vertex on a particular Processor.
static final String	RECEIVED_BATCHES	Counts incoming data item batches on input Edges of particular Vertex instances running on various Processors.
static final String	RECEIVED_COUNT	Counts incoming data items on input Edges of particular Vertex instances running on various Processors.
static final String	SNAPSHOT_BYTES	Tracks the total number of bytes written in the last snapshot by a particular Vertex.
static final String	SNAPSHOT_KEYS	Tracks the total number of keys written in the last snapshot by a particular Vertex.
static final String	TOP_OBSERVED_WM	Tracks the highest coalesced watermark observed on all input Edges of a particular Vertex (i.e. the highest watermark observed on all input queues of that Vertex).

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

RECEIVED_COUNT

public static final String RECEIVED_COUNT

Counts incoming data items on input Edges of particular Vertex instances running on various Processors. These in turn can be identified based on the MetricTags.ORDINAL, MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

RECEIVED_BATCHES

public static final String RECEIVED_BATCHES

Counts incoming data item batches on input Edges of particular Vertex instances running on various Processors. These in turn can be identified based on the MetricTags.ORDINAL, MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

QUEUES_SIZE

public static final String QUEUES_SIZE

Tracks the total size of all input queues of a particular Vertex on a particular Processor. They both can be identified based on the MetricTags.VERTEX and MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

QUEUES_CAPACITY

public static final String QUEUES_CAPACITY

Tracks the total capacity of all input queues of a particular Vertex on a particular Processor. They both can be identified based on the MetricTags.VERTEX and MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

EMITTED_COUNT

public static final String EMITTED_COUNT

Counts the data items emitted on outgoing Edges of particular Vertex instances running on various Processors. These in turn can be identified based on the MetricTags.ORDINAL, MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

When the MetricTags.ORDINAL tag contains the value "snapshot" then the count contains the number of snapshots saved by the Processor.

See Also:

• Constant Field Values

TOP_OBSERVED_WM

public static final String TOP_OBSERVED_WM

Tracks the highest coalesced watermark observed on all input Edges of a particular Vertex (i.e. the highest watermark observed on all input queues of that Vertex). The Vertex and the Processor can be identified based on the MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

COALESCED_WM

public static final String COALESCED_WM

Tracks the highest watermark observed on all the input queues of a particular incoming Edge of a certain Vertex. The Vertex and the Processor can be identified based on the MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

LAST_FORWARDED_WM

public static final String LAST_FORWARDED_WM

Tracks the last watermark emitted by a particular Processor of a particular Vertex. The Vertex and the Processor can be identified based on the MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

LAST_FORWARDED_WM_LATENCY

public static final String LAST_FORWARDED_WM_LATENCY

Tracks the difference between the last emitted watermark and the system time of a particular Processor of a particular Vertex. The Vertex and the Processor can be identified based on the MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

SNAPSHOT_BYTES

public static final String SNAPSHOT_BYTES

Tracks the total number of bytes written in the last snapshot by a particular Vertex. The name of the vertex can be found in the MetricTags.VERTEX tag of the metric.

Since:

Jet 4.0

See Also:

• Constant Field Values

SNAPSHOT_KEYS

public static final String SNAPSHOT_KEYS

Tracks the total number of keys written in the last snapshot by a particular Vertex. The name of the vertex can be found in the MetricTags.VERTEX tag of the metric.

Since:

Jet 4.0

See Also:

• Constant Field Values

EXECUTION_START_TIME

public static final String EXECUTION_START_TIME

Tracks the start time of a given execution of a specific job. The execution and the job can be identified based on the MetricTags.EXECUTION & MetricTags.JOB tags of the metric. It uses System.currentTimeMillis() to get the time on the job start.

Since:

Jet 4.0

See Also:

• Constant Field Values

EXECUTION_COMPLETION_TIME

public static final String EXECUTION_COMPLETION_TIME

Tracks the completion time of a given execution of a specific job. The execution and the job can be identified based on the MetricTags.EXECUTION & MetricTags.JOB tags of the metric. It uses System.currentTimeMillis() to get the time on the job completion.

Since:

Jet 4.0

See Also:

• Constant Field Values

DISTRIBUTED_ITEMS_IN

public static final String DISTRIBUTED_ITEMS_IN

Counts data items coming in over the network for DISTRIBUTED input Edges of particular Vertex instances running on various Processors. These in turn can be identified based on the MetricTags.ORDINAL, MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

DISTRIBUTED_BYTES_IN

public static final String DISTRIBUTED_BYTES_IN

Tracks the data volume (bytes) coming in over the network for DISTRIBUTED input Edges of particular Vertex instances running on various Processors. These in turn can be identified based on the MetricTags.ORDINAL, MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

DISTRIBUTED_ITEMS_OUT

public static final String DISTRIBUTED_ITEMS_OUT

Counts data items going out over the network for DISTRIBUTED output Edges of particular Vertex instances running on various Processors. These in turn can be identified based on the MetricTags.ORDINAL, MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

DISTRIBUTED_BYTES_OUT

public static final String DISTRIBUTED_BYTES_OUT

Tracks the data volume (bytes) going out over the network for DISTRIBUTED output Edges of particular Vertex instances running on various Processors. These in turn can be identified based on the MetricTags.ORDINAL, MetricTags.VERTEX & MetricTags.PROCESSOR tags of the metric.

See Also:

• Constant Field Values

JOB_STATUS

public static final String JOB_STATUS

Numerical ID of the job's status.

Since:

5.4

See Also:

• Job.getStatus()
• Constant Field Values

IS_USER_CANCELLED

public static final String IS_USER_CANCELLED

Indicates whether the job was cancelled by the user.

Since:

5.4

See Also:

• Job.isUserCancelled()
• Constant Field Values

JOBS_SUBMITTED

public static final String JOBS_SUBMITTED

Number of jobs submitted to the Jet cluster.

This metric is zero on non-master members. When a master fails and a new master takes over, the count is reset.

Since:

Jet 4.0

See Also:

• Constant Field Values

JOBS_COMPLETED_SUCCESSFULLY

public static final String JOBS_COMPLETED_SUCCESSFULLY

Number of jobs successfully completed by the Jet cluster.

This metric is zero on non-master members. When a master fails and a new master takes over, the count is reset.

Since:

Jet 4.0

See Also:

• Constant Field Values

JOBS_COMPLETED_WITH_FAILURE

public static final String JOBS_COMPLETED_WITH_FAILURE

Number of jobs that have failed on the Jet cluster.

This metric is zero on non-master members. When a master fails and a new master takes over, the count is reset.

Since:

Jet 4.0

See Also:

• Constant Field Values

JOB_EXECUTIONS_STARTED

public static final String JOB_EXECUTIONS_STARTED

Number of job executions started on the Jet cluster. Each job can execute multiple times, for example when it's restarted or suspended and then resumed.

This metric is zero on non-master members. When a master fails and a new master takes over, the count is reset.

Since:

Jet 4.0

See Also:

• Constant Field Values

JOB_EXECUTIONS_COMPLETED

public static final String JOB_EXECUTIONS_COMPLETED

Number of job executions finished on the Jet cluster. Each job can execute multiple times, for example when it's restarted or suspended and then resumed.

This metric is zero on non-master members. When a master fails and a new master takes over, the count is reset.

Since:

Jet 4.0

See Also:

• Constant Field Values