Package org.apache.pulsar.structuredeventlog.slf4j

Class Slf4jStructuredEventLog

java.lang.Object

org.apache.pulsar.structuredeventlog.slf4j.Slf4jStructuredEventLog

All Implemented Interfaces:

StructuredEventLog

public class Slf4jStructuredEventLog
extends Object
implements StructuredEventLog

Field Summary

Fields

Modifier and Type	Field	Description
static final Slf4jStructuredEventLog	INSTANCE

Constructor Summary

Constructors

Constructor	Description
Slf4jStructuredEventLog()

Method Summary

Modifier and Type	Method	Description
EventResources	newEventResources()	Create an new event resources object, which can be used across multiple root events.
Event	newRootEvent()	Create a new root event.
Event	unstash()	Retrieves an event from the call stack.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final Slf4jStructuredEventLog INSTANCE

Constructor Details

Slf4jStructuredEventLog

public Slf4jStructuredEventLog()

Method Details

newRootEvent

public Event newRootEvent()

Description copied from interface: StructuredEventLog

Create a new root event. Root events occur in response to some external stimulus, such as a user request, a timer being triggered or a threshold being crossed. The level of the event is INFO by default. The root event will generate a new traceId, and will have a empty parent Id. If this information is provided, as can be the case with a user request, they can be set with Event#traceId(String) and Event#parentId(String).

Specified by:

newRootEvent in interface StructuredEventLog

newEventResources

public EventResources newEventResources()

Description copied from interface: StructuredEventLog

Create an new event resources object, which can be used across multiple root events.

Specified by:

newEventResources in interface StructuredEventLog

unstash

public Event unstash()

Description copied from interface: StructuredEventLog

Retrieves an event from the call stack. This can be used, along with Event#stash(), to bridge an event across an API without having to modify the API to pass the event object. For example, the child event, METHOD2, in the following example, will share the traceId with METHOD1, and METHOD1's id will be match the parentId of METHOD2.

 void method1() {
    Event e = logger.newRootEvent()
        .timed()
        .resource("foo", bar);

    e.stash();
    unmodifiableMethod();
    e.log(Events.METHOD1);
 }

 void unmodifiableMethod() {
    logger.unstash().newChildEvent().log(Events.METHOD2);
 }
 

This should be used sparingly.

Specified by:

unstash in interface StructuredEventLog