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

Class PartitionInfoPojo

java.lang.Object

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

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

public class PartitionInfoPojo
extends HealthAndAlertInfoPojo

Author:

cedric This is an interface class, used to build and output information about a Kafka topic partition status and health. Overall Health status is inherited from HealthAndAlertInfoPojo as well as an alert list that provides reasons of the current health.

Field Summary

Fields

Modifier and Type	Field and Description
String	cluster The logical name of the kafka cluster containing the kafka partition.
Long	earliest_offset The rank number of the first message still available for reading in this topic partition.
ZonedDateTime	earliest_ts The timestamp associated with the oldest message remaining in the kafka partition (older messages have been removed by the kafka brokers, based on the retention policy of the topic.
Long	latest_offset The rank number of the last message written into the kafka partition.
ZonedDateTime	latest_ts The timestamp associated with the newest message written into the kafka partition.
int	partition The id of the topic partition (first partition has an id of 0)
Long	storedMessagesCount The number of messages that are currently stored in the Kafka Partition (i.e.
String	topic The name of the kafka topic as appearing when listing topics using the kafka tools.

Fields inherited from class org.thales.punch.platform.api.es.health.HealthAndAlertInfoPojo

alerts, health, health_code, tenant, TYPE_PROPERTY_NAME, update_ts

Constructor Summary

Constructors

Constructor and Description
PartitionInfoPojo(String tenant, KafkaTopicPojo topic, int partition)

Method Summary

Modifier and Type	Method and Description
String	getAsKeyValuesStringForLogs() Must be provided by concrete subclasses, in order to include all appropriate fields to the user for troubleshooting purpose health level and alerts should not be reported, because their logging is usually sufficiently done through the addAlert(Health, String, Object...) method.

Methods inherited from class java.lang.Object

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

Field Detail

cluster

public String cluster

The logical name of the kafka cluster containing the kafka partition. This matches one of the kafka.clusters subsections in the PunchPlatform settings

topic

public String topic

The name of the kafka topic as appearing when listing topics using the kafka tools.

partition

public int partition

The id of the topic partition (first partition has an id of 0)

earliest_offset

public Long earliest_offset

The rank number of the first message still available for reading in this topic partition. At first creation of a topic partition, its offset begins with message 0. As Time goes by and space is filled up, the Kafka Broker deletes oldest messages. This is the first one not deleted yet.

earliest_ts

public ZonedDateTime earliest_ts

The timestamp associated with the oldest message remaining in the kafka partition (older messages have been removed by the kafka brokers, based on the retention policy of the topic.

This timestamp is generated by Kafka at write time (this is the default : timestamp=write time) or explicitly provided by the writer, in which case, it may be some earlier date, related to the business content of the message.

latest_offset

public Long latest_offset

The rank number of the last message written into the kafka partition. At first creation of a topic partition, its offset begins with message 0, and is increased by 1 at each write into the partition.

latest_ts

public ZonedDateTime latest_ts

The timestamp associated with the newest message written into the kafka partition.

This timestamp is generated by Kafka at write time (this is the default : timestamp=write time) or explicitly provided by the writer, in which case, it may be some earlier date, related to the business content of the message.

storedMessagesCount

public Long storedMessagesCount

The number of messages that are currently stored in the Kafka Partition (i.e. written to kafka, and not yet purged).

Constructor Detail

PartitionInfoPojo

public PartitionInfoPojo(String tenant,
                         KafkaTopicPojo topic,
                         int partition)

Parameters:

tenant - the tenant name

topic - the topic name

partition - the number of partition

Method Detail

getAsKeyValuesStringForLogs

public String getAsKeyValuesStringForLogs()

Description copied from class: HealthAndAlertInfoPojo

Must be provided by concrete subclasses, in order to include all appropriate fields to the user for troubleshooting purpose health level and alerts should not be reported, because their logging is usually sufficiently done through the addAlert(Health, String, Object...) method.

Specified by:

getAsKeyValuesStringForLogs in class HealthAndAlertInfoPojo

Returns:

a string in a (key=value...) format, usable for log/debug/errors string building