Package co.elastic.logging.logback
Class EcsEncoder
- java.lang.Object
-
- ch.qos.logback.core.spi.ContextAwareBase
-
- ch.qos.logback.core.encoder.EncoderBase<ch.qos.logback.classic.spi.ILoggingEvent>
-
- co.elastic.logging.logback.EcsEncoder
-
- All Implemented Interfaces:
ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>,ch.qos.logback.core.spi.ContextAware,ch.qos.logback.core.spi.LifeCycle
public class EcsEncoder extends ch.qos.logback.core.encoder.EncoderBase<ch.qos.logback.classic.spi.ILoggingEvent>
-
-
Constructor Summary
Constructors Constructor Description EcsEncoder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAdditionalField(AdditionalField pair)protected voidaddCustomFields(ch.qos.logback.classic.spi.ILoggingEvent event, StringBuilder builder)Subclasses can override this to add custom fields.voidclose()This method has been removed in logback 1.2.voiddoEncode(Object event)This method has been removed in logback 1.2.byte[]encode(ch.qos.logback.classic.spi.ILoggingEvent event)byte[]footerBytes()byte[]headerBytes()voidinit(OutputStream os)This method has been removed in logback 1.2.voidsetEventDataset(String eventDataset)voidsetIncludeMarkers(boolean includeMarkers)voidsetIncludeOrigin(boolean includeOrigin)voidsetServiceEnvironment(String serviceEnvironment)voidsetServiceName(String serviceName)voidsetServiceNodeName(String serviceNodeName)voidsetServiceVersion(String serviceVersion)voidsetStackTraceAsArray(boolean stackTraceAsArray)voidsetThrowableConverter(ch.qos.logback.classic.pattern.ThrowableHandlingConverter throwableConverter)voidstart()-
Methods inherited from interface ch.qos.logback.core.spi.ContextAware
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext
-
-
-
-
Method Detail
-
headerBytes
public byte[] headerBytes()
-
start
public void start()
- Specified by:
startin interfacech.qos.logback.core.spi.LifeCycle- Overrides:
startin classch.qos.logback.core.encoder.EncoderBase<ch.qos.logback.classic.spi.ILoggingEvent>
-
init
public void init(OutputStream os)
This method has been removed in logback 1.2. To make this lib backwards compatible with logback 1.1 we have implement this method.
-
doEncode
public void doEncode(Object event) throws IOException
This method has been removed in logback 1.2. To make this lib backwards compatible with logback 1.1 we have implement this method. However, since we compile with 1.2.x, this method is not compiled as an interface method, which means that there won't be type erasure. Therefore, we must use aObjectargument for it to be compatible with 1.1.x.- Throws:
IOException
-
close
public void close() throws IOExceptionThis method has been removed in logback 1.2. To make this lib backwards compatible with logback 1.1 we have implement this method.- Throws:
IOException
-
encode
public byte[] encode(ch.qos.logback.classic.spi.ILoggingEvent event)
-
addCustomFields
protected void addCustomFields(ch.qos.logback.classic.spi.ILoggingEvent event, StringBuilder builder)Subclasses can override this to add custom fields. The last character in the StringBuilder will be comma when this is called. You must add a comma after each custom field.
-
footerBytes
public byte[] footerBytes()
-
setServiceName
public void setServiceName(String serviceName)
-
setServiceVersion
public void setServiceVersion(String serviceVersion)
-
setServiceEnvironment
public void setServiceEnvironment(String serviceEnvironment)
-
setServiceNodeName
public void setServiceNodeName(String serviceNodeName)
-
setIncludeMarkers
public void setIncludeMarkers(boolean includeMarkers)
-
setStackTraceAsArray
public void setStackTraceAsArray(boolean stackTraceAsArray)
-
setIncludeOrigin
public void setIncludeOrigin(boolean includeOrigin)
-
addAdditionalField
public void addAdditionalField(AdditionalField pair)
-
setEventDataset
public void setEventDataset(String eventDataset)
-
setThrowableConverter
public void setThrowableConverter(ch.qos.logback.classic.pattern.ThrowableHandlingConverter throwableConverter)
-
-