org.thales.punch.platform.api.es.health

Enum AlertCodePojo

java.lang.Object

java.lang.Enum<AlertCodePojo>

org.thales.punch.platform.api.es.health.AlertCodePojo

All Implemented Interfaces:

Serializable, Comparable<AlertCodePojo>

public enum AlertCodePojo
extends Enum<AlertCodePojo>

This enum class regroups all the monitoring error conditions that are identified by the monitoring microservices of PunchPlatform.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNELS_LATENCY_CRITICAL A channel latency on a monitored part of a channel (as described by the latency tests section in the channel structure) is higher than the error threshold.
CHANNELS_LATENCY_TOO_HIGH A channel latency on a monitored part of a channel (as described by the latency tests section in the channel structure) is higher than the warning threshold.
ELASTICSEARCH_INDICE_NOT_AVAILABLE One of the Elasticsearch indice for a tenant is not available, although the Elasticsearch cluster itself is responding to monitoring queries.
ELASTICSEARCH_INDICE_RESILIENCE_ISSUE One of the Elasticsearch indice for a tenant is non-resilient although it has been configured for resilience.
ELASTICSEARCH_MONITORING_EXCEPTION An exception has occurred during Elasticsearch Monitoring API requests used for monitoring ; as a result, Elasticsearch health status cannot be assessed.
KAFKA_INCORRECT_REPLICATION The current replication count for this partition (number of replica, including the primary) is less than the configured replication in the channel configuration files.
KAFKA_MONITORING_EXCEPTION An exception has occurred during Kafka Monitoring ; as a result, Kafka health status may not be accurate.
KAFKA_NO_IN_SYNC_REPLICA_FOR_PARTITION Although the partition has a leader, it has no data replica synchronized (not even a primary one).
KAFKA_NO_LEADER_FOR_PARTITION No leader broker is identified for a given topic partition in the Kafka Broker that contains the partition.
KAFKA_NO_PARTITION_FOR_TOPIC The Kafka cluster has no declared partition for the topic.
KAFKA_NOT_FULLY_REPLICATED_PARTITION The partition is available for reading and writing, but at least one of its configured partition is not up-to-date as compared with the leader partition.
KAFKA_OFFSETS_MONITORING_EXCEPTION A problem has occurred while connecting to Kafka brokers using kafka consumer library, in order to retrieve offsets and timestamps of messages in the topic.
KAFKA_REPLICATION_MONITORING_EXCEPTION A problem has occurred while connecting to Kafka zookeeper cluster to validate kafka partitions replication.
MONITORING_RECORDING_ERROR A problem has occurred while trying to record a result of the monitoring into Elasticsearch.
PUNCHPLATFORM_TENANT_SERVICE_CRITICAL One of the punchplatform service for a tenant is in error condition.
PUNCHPLATFORM_TENANT_SERVICE_MONITORING_FAILURE One of the punchplatform service for a tenant cannot be monitored.
PUNCHPLATFORM_TENANT_SERVICE_WARNING One of the punchplatform service for a tenant is in warning condition.

Field Summary

Fields

Modifier and Type	Field and Description
HealthLevel.EnumHealth	associatedHealthCondition

Method Summary

Modifier and Type	Method and Description
static AlertCodePojo	valueOf(String name) Returns the enum constant of this type with the specified name.
static AlertCodePojo[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

KAFKA_NO_LEADER_FOR_PARTITION

public static final AlertCodePojo KAFKA_NO_LEADER_FOR_PARTITION

No leader broker is identified for a given topic partition in the Kafka Broker that contains the partition. As a result, the data of that partition is not available for reading or writing.

This could mean either the kafka cluster is not in good health, or that even though the cluster is in good health, all the cluster nodes that host the partition are offline from the cluster, therefore none is available to assume the leader role. This case can happen if you have non-replicated partitions and the kafka broker hosting that partition is down.

KAFKA_NO_IN_SYNC_REPLICA_FOR_PARTITION

public static final AlertCodePojo KAFKA_NO_IN_SYNC_REPLICA_FOR_PARTITION

Although the partition has a leader, it has no data replica synchronized (not even a primary one).

This means the data is not available for reading and may also not be available for writing.

The reason might be that there has been some failover or restart, and the brokers holding copies of the partition are still discussing to identify or rebuild a consistent version.

KAFKA_NOT_FULLY_REPLICATED_PARTITION

public static final AlertCodePojo KAFKA_NOT_FULLY_REPLICATED_PARTITION

The partition is available for reading and writing, but at least one of its configured partition is not up-to-date as compared with the leader partition.

This has no impact on the partition availability. It means the partition is less resilient at the moment than specified by the configuration.

This could come from one of the broker being down or having recently restarted, and in the process of re-synchronizing the missing data.

KAFKA_INCORRECT_REPLICATION

public static final AlertCodePojo KAFKA_INCORRECT_REPLICATION

The current replication count for this partition (number of replica, including the primary) is less than the configured replication in the channel configuration files.

This has no impact on the partition availability.

This means that the actual resilience of the partition is inferior to the resilience intended by the designer of your channel configuration.

KAFKA_REPLICATION_MONITORING_EXCEPTION

public static final AlertCodePojo KAFKA_REPLICATION_MONITORING_EXCEPTION

A problem has occurred while connecting to Kafka zookeeper cluster to validate kafka partitions replication.

This could mean a zookeeper issue, or a connection issue between the monitoring system and the zookeeper cluster.

KAFKA_OFFSETS_MONITORING_EXCEPTION

public static final AlertCodePojo KAFKA_OFFSETS_MONITORING_EXCEPTION

A problem has occurred while connecting to Kafka brokers using kafka consumer library, in order to retrieve offsets and timestamps of messages in the topic.

This could mean the brokers cluster is down or unreachable from the monitoring system nodes.

KAFKA_NO_PARTITION_FOR_TOPIC

public static final AlertCodePojo KAFKA_NO_PARTITION_FOR_TOPIC

The Kafka cluster has no declared partition for the topic.

The topic is not available for writing or reading data.

This could mean the topic has not been created, or some failure has occurred during initialization of the topic (assignment problem?).

MONITORING_RECORDING_ERROR

public static final AlertCodePojo MONITORING_RECORDING_ERROR

A problem has occurred while trying to record a result of the monitoring into Elasticsearch.

The potential impact is an inaccurate monitoring if previously recorded information hides the current status.

This could mean the Elasticsearch cluster used for monitoring data storage is unavaible or unreachable from the monitoring system nodes.

KAFKA_MONITORING_EXCEPTION

public static final AlertCodePojo KAFKA_MONITORING_EXCEPTION

An exception has occurred during Kafka Monitoring ; as a result, Kafka health status may not be accurate.

Please refer to the punchplatform logs to troubleshoot this issue.

CHANNELS_LATENCY_TOO_HIGH

public static final AlertCodePojo CHANNELS_LATENCY_TOO_HIGH

A channel latency on a monitored part of a channel (as described by the latency tests section in the channel structure) is higher than the warning threshold.

This could mean a temporary load of the platform or increase of the input data, causing a faster arrival rate as compared to the maximum processing rate of the channel.

Backlogs and health of the channel must be monitored to identify if the channel needs repair or reconfiguration to process higher rates of input data.

CHANNELS_LATENCY_CRITICAL

public static final AlertCodePojo CHANNELS_LATENCY_CRITICAL

A channel latency on a monitored part of a channel (as described by the latency tests section in the channel structure) is higher than the error threshold.

This could mean a heavy load of the platform or massive increase of the input data, causing a durable faster arrival rate as compared to the maximum processing rate of the channel.

Backlogs and health of the channel must be monitored to identify if the channel needs urgent repair or reconfiguration to process higher rates of input data.

PUNCHPLATFORM_TENANT_SERVICE_CRITICAL

public static final AlertCodePojo PUNCHPLATFORM_TENANT_SERVICE_CRITICAL

One of the punchplatform service for a tenant is in error condition. This means some part of punchplatform data or services is currently not available or not performed correctly.

For troubleshooting details, please refer to this specific service alert messages.

PUNCHPLATFORM_TENANT_SERVICE_MONITORING_FAILURE

public static final AlertCodePojo PUNCHPLATFORM_TENANT_SERVICE_MONITORING_FAILURE

One of the punchplatform service for a tenant cannot be monitored.

This means either the monitoring service for this punchplatform features is not running, or meets an error condition during the monitoring process, or cannot record its results in Elasticsearch.

For troubleshooting details, please refer to this specific service alert messages.

PUNCHPLATFORM_TENANT_SERVICE_WARNING

public static final AlertCodePojo PUNCHPLATFORM_TENANT_SERVICE_WARNING

One of the punchplatform service for a tenant is in warning condition. This means some part of punchplatform processing or services is currently either too slow or not resilient.

For troubleshooting details, please refer to this specific service alert messages.

ELASTICSEARCH_INDICE_RESILIENCE_ISSUE

public static final AlertCodePojo ELASTICSEARCH_INDICE_RESILIENCE_ISSUE

One of the Elasticsearch indice for a tenant is non-resilient although it has been configured for resilience.

This means that although the data is still available for reading and writing, its availability and possibly its consistency in write situation will be put at risk in case of additional failure within the Elasticsearch cluster.

The possible cause is a failure or restart of a data node of the Elasticsearch cluster. The Elasticsearch cluster will automatically repair this situation but this may take some time (from a few minutes to a few hours, depending on the scope of the failure) and may cause less performance of the cluster for request during this resilience reconstruction phase. in warning condition. This means some part of

ELASTICSEARCH_INDICE_NOT_AVAILABLE

public static final AlertCodePojo ELASTICSEARCH_INDICE_NOT_AVAILABLE

One of the Elasticsearch indice for a tenant is not available, although the Elasticsearch cluster itself is responding to monitoring queries.

This means that the indice data is neither available for reading nor for writing.

The possible cause is a failure or restart of a data node of the Elasticsearch cluster (for non-resilient indices) or of several nodes (for resilient indices).

ELASTICSEARCH_MONITORING_EXCEPTION

public static final AlertCodePojo ELASTICSEARCH_MONITORING_EXCEPTION

An exception has occurred during Elasticsearch Monitoring API requests used for monitoring ; as a result, Elasticsearch health status cannot be assessed.

Please refer to the elasticsearch health monitoring service logs to troubleshoot this issue, as well as to the health status of your platform infrastructure and system services, provided by your platform monitoring system.

The possible cause is a failure or restart of a majority of master nodes or of all client/API nodes of the Elasticsearch cluster, or a communication problem between the monitoring system and those nodes.

Field Detail

associatedHealthCondition

public final HealthLevel.EnumHealth associatedHealthCondition

Method Detail

values

public static AlertCodePojo[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AlertCodePojo c : AlertCodePojo.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AlertCodePojo valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null