org.thales.punch.api.ecs

Class ECS

java.lang.Object

org.thales.punch.api.ecs.ECS

public class ECS
extends Object

Documentation of each variables can be found on link: https://www.elastic.co/guide/en/ecs/current/ecs-base.html

This class can be used for various purpose by following ECS format

 - generating exceptions JSON format (in this case message should not be set)
 - generating log JSON format (in this case error should not be set)
 - ...
 

Error example based on ELASTIC APM Server: https://github.com/elastic/apm-server/blob/master/docs/data/elasticsearch/generated/errors.json

Mapping example based on ELASTIC APM Server: https://github.com/elastic/apm-server/blob/master/docs/spec/errors/error.json

Author:

jonathan

Constructor Summary

Constructors

Constructor and Description
ECS(PunchMeta punchMeta)

Method Summary

Modifier and Type	Method and Description
String	currentTimestamp()
void	error(ECSError error)
ECSError	errorJson()
ISettingsMap	host()
ISettingsMap	labels()
void	labels(ISettingsMap labels)
String	logMessage()
void	message(String message)
PunchMeta	punchMeta()
ISettingsMap	service()
void	service(ISettingsMap service)
String[]	tags() NOTE it is possible to set tags through environment variable.
ISettingsMap	userDefinedKeyValues()
void	userDefinedKeyValues(ISettingsMap userDefinedKeyValues)
ECSVersion	version()

Methods inherited from class java.lang.Object

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

Constructor Detail

ECS

public ECS(PunchMeta punchMeta)

Method Detail

error

public void error(ECSError error)

labels

public void labels(ISettingsMap labels)

service

public void service(ISettingsMap service)

userDefinedKeyValues

public void userDefinedKeyValues(ISettingsMap userDefinedKeyValues)

message

public void message(String message)

errorJson

public ECSError errorJson()

version

public ECSVersion version()

currentTimestamp

public String currentTimestamp()

punchMeta

public PunchMeta punchMeta()

logMessage

public String logMessage()

tags

public String[] tags()

NOTE it is possible to set tags through environment variable.

Any environment variables that has for prefix: PUNCHPLATFORM_TAGS will be displayed within the tags key.

Returns:

a str

labels

public ISettingsMap labels()

service

public ISettingsMap service()

host

public ISettingsMap host()

userDefinedKeyValues

public ISettingsMap userDefinedKeyValues()