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

Class TopicInfoPojo

java.lang.Object

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

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

public class TopicInfoPojo
extends HealthAndAlertInfoPojo

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

Author:

cedric

Field Summary

Fields

Modifier and Type	Field and Description
String	cluster
ZonedDateTime	earliest_ts The timestamp associated with the earliest message remaining in the kafka topic.
ZonedDateTime	latest_ts The timestamp associated with the latest message written into the kafka topic.
int	partitionsCount The actual number of partitions in the topic (may not be the same as the count specified in a channel configuration)
Long	stored_message_count The number of messages that are currently stored in the Kafka Topic (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
TopicInfoPojo(String tenant, KafkaTopicPojo topic)

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

topic

public String topic

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

earliest_ts

public ZonedDateTime earliest_ts

The timestamp associated with the earliest message remaining in the kafka topic. Previous messages have been removed by the kafka brokers, based on the topic retention policy.

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_ts

public ZonedDateTime latest_ts

The timestamp associated with the latest message written into the kafka 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.

stored_message_count

public Long stored_message_count

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

partitionsCount

public int partitionsCount

The actual number of partitions in the topic (may not be the same as the count specified in a channel configuration)

Constructor Detail

TopicInfoPojo

public TopicInfoPojo(String tenant,
                     KafkaTopicPojo topic)

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