io.prometheus.client.log4j2

Class InstrumentedAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

io.prometheus.client.log4j2.InstrumentedAppender

All Implemented Interfaces:

Serializable, org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.LifeCycle

@Plugin(name="Prometheus",
        category="Core",
        elementType="appender")
public final class InstrumentedAppender
extends org.apache.logging.log4j.core.appender.AbstractAppender

Log4j2 log statements at various log levels

Example log4j2 configuration:

   <?xml version="1.0" encoding="UTF-8"?>
   <Configuration packages="io.prometheus.client.log4j2">
     <Appenders>
       <Prometheus name="PROMETHEUS"/>
     </Appenders>
     <Loggers>
       <Root level="trace">
         <AppenderRef ref="PROMETHEUS"/>
       </Root>
     </Loggers>
   </Configuration>
 

Example metrics being exported:

   log4j_appender_total{level="trace",} 1.0
   log4j_appender_total{level="debug",} 2.0
   log4j_appender_total{level="info",} 3.0
   log4j_appender_total{level="warn",} 4.0
   log4j_appender_total{level="error",} 5.0
   log4j_appender_total{level="fatal",} 6.0
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

org.apache.logging.log4j.core.LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNTER_NAME

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InstrumentedAppender(String name) Create a new instrumented appender using the default registry.

Method Summary

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent event)
static InstrumentedAppender	createAppender(String name)

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, hasFilter, isFiltered, removeFilter, start, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equals, getState, hashCode, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

isStarted, isStopped, start, stop

Field Detail

COUNTER_NAME

public static final String COUNTER_NAME

See Also:

Constant Field Values

Constructor Detail

InstrumentedAppender

protected InstrumentedAppender(String name)

Create a new instrumented appender using the default registry.

Method Detail

append

public void append(org.apache.logging.log4j.core.LogEvent event)

createAppender

@PluginFactory
public static InstrumentedAppender createAppender(@PluginAttribute(value="name")
                                                                 String name)