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

Class ServiceHealthReportPojo

java.lang.Object

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

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

public class ServiceHealthReportPojo
extends HealthAndAlertInfoPojo

This pojo stores a synthesis status for a tenant, for a given punchplatform monitoring micro-service.

The Aggregator micro-service uses the reports of the other micro-services, and computes its aggregated

Author:

cedric

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceHealthReportPojo.Service

Field Summary

Fields

Modifier and Type	Field and Description
ServiceHealthReportPojo.Service	service Identifies the micro-service that produced this health status information
static String	SERVICE_TYPE_PROPERTY

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
ServiceHealthReportPojo() Constructor for deserialization
ServiceHealthReportPojo(String tenant, ServiceHealthReportPojo.Service service)

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.
static String	getServicesHealthIndexPrefix(String healthIndexPrefix) Compute the ES index prefix for storing the health information about punchplatform tenant sub-fonctions (tenant kafka topics, tenant Elasticsearch Indices, tenant Channel latencies).
ServiceHealthReportPojo	validate()

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_TYPE_PROPERTY

public static final String SERVICE_TYPE_PROPERTY

See Also:

Constant Field Values

service

public ServiceHealthReportPojo.Service service

Identifies the micro-service that produced this health status information

Constructor Detail

ServiceHealthReportPojo

public ServiceHealthReportPojo(String tenant,
                               ServiceHealthReportPojo.Service service)

ServiceHealthReportPojo

public ServiceHealthReportPojo()

Constructor for deserialization

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

validate

public ServiceHealthReportPojo validate()

getServicesHealthIndexPrefix

public static String getServicesHealthIndexPrefix(String healthIndexPrefix)

Compute the ES index prefix for storing the health information about punchplatform tenant sub-fonctions (tenant kafka topics, tenant Elasticsearch Indices, tenant Channel latencies).

This prefix can then be used to derivate 'daily indices' names

Parameters:

healthIndexPrefix - - the prefix of all health indices for the tenant. The returned value will start with this prefix.

Returns:

the Elasticsearch index prefix used to store the health reports of the microservices.