com.atlassian.jira.instrumentation

Class DefaultInstrumentationLogger

java.lang.Object

com.atlassian.jira.instrumentation.DefaultInstrumentationLogger

All Implemented Interfaces:

InitializingComponent, InstrumentationLogger

@ParametersAreNonnullByDefault
public class DefaultInstrumentationLogger
extends Object
implements InstrumentationLogger, InitializingComponent

Logs the instrumentation data that we have collected to various collection mechanisms.

Since:

v7.1

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	JIRA_INSTRUMENTATION_LAAS_PROPERTY
static String	PARENT_SPAN_ID
protected static String	REQUEST_EXECUTION_TIME
static String	SPAN_ID

Constructor Summary

Constructors

Constructor and Description
DefaultInstrumentationLogger(JiraProperties jiraProperties, FeatureManager featureManager, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
void	afterInstantiation()
protected void	cleanMdc()
void	clearMemoryBuffer() Clear all the data collected in the memory buffer.
protected String	getJsonString(Optional<String> spanId, Optional<String> parentSpanId, LogEntry entry, Optional<Long> requestTime, Optional<Long> startNanoTime) Generates the JSON string object that we can log.
List<LogEntry>	getLogEntriesFromBuffer() Fetch the current list of statistics stored in memory.
protected boolean	isEnabled()
void	pluginFrameworkShuttingDown(com.atlassian.plugin.event.events.PluginFrameworkShuttingDownEvent pluginFrameworkShuttingDownEvent)
void	save(RequestData requestData, List<? extends Statistics> requestStats, Optional<Long> requestTime) Saves request data to the queue above.
void	save(RequestData requestData, List<? extends Statistics> requestStats, Optional<Long> requestTime, Exception exception) Saves request data to the queue above and generates a stacktrace that it inserts in the log.
void	save(String traceId, String path, List<? extends Statistics> requestStats, Optional<Long> requestTime) Saves request data to the queue above.

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_EXECUTION_TIME

protected static final String REQUEST_EXECUTION_TIME

See Also:

Constant Field Values

JIRA_INSTRUMENTATION_LAAS_PROPERTY

protected static final String JIRA_INSTRUMENTATION_LAAS_PROPERTY

See Also:

Constant Field Values

SPAN_ID

public static final String SPAN_ID

See Also:

Constant Field Values

PARENT_SPAN_ID

public static final String PARENT_SPAN_ID

See Also:

Constant Field Values

Constructor Detail

DefaultInstrumentationLogger

public DefaultInstrumentationLogger(JiraProperties jiraProperties,
                                    FeatureManager featureManager,
                                    com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

afterInstantiation

public void afterInstantiation()
                        throws Exception

Specified by:

afterInstantiation in interface InitializingComponent

Throws:

Exception

pluginFrameworkShuttingDown

@EventListener
public void pluginFrameworkShuttingDown(com.atlassian.plugin.event.events.PluginFrameworkShuttingDownEvent pluginFrameworkShuttingDownEvent)

save

public void save(String traceId,
                 String path,
                 List<? extends Statistics> requestStats,
                 Optional<Long> requestTime)

Description copied from interface: InstrumentationLogger

Saves request data to the queue above. The queue will store the last 100 requests by default. As new requests are received the oldest are removed.

Specified by:

save in interface InstrumentationLogger

Parameters:

traceId - The ID for this request.

path - the path of the URL.

requestStats - The list of cache statistics.

requestTime - The time in nanoseconds that the request took to complete.

save

public void save(RequestData requestData,
                 List<? extends Statistics> requestStats,
                 Optional<Long> requestTime)

Description copied from interface: InstrumentationLogger

Saves request data to the queue above. The queue will store the last 100 requests by default. As new requests are received the oldest are removed.

Specified by:

save in interface InstrumentationLogger

Parameters:

requestData - data associated with the request.

requestStats - The list of cache statistics.

requestTime - The time of the request in nanoseconds. If zero, we did not collect any time.

save

public void save(RequestData requestData,
                 List<? extends Statistics> requestStats,
                 Optional<Long> requestTime,
                 @Nullable
                 Exception exception)

Description copied from interface: InstrumentationLogger

Saves request data to the queue above and generates a stacktrace that it inserts in the log. The queue will store the last 100 requests by default. As new requests are received the oldest are removed.

Specified by:

save in interface InstrumentationLogger

Parameters:

requestData - data associated with the request.

requestStats - The list of cache statistics.

requestTime - The time of the request in nanoseconds. If zero, we did not collect any time.

exception - An exception to be included with the log. This can be used if you require a stack trace to be recorded.

getJsonString

protected String getJsonString(Optional<String> spanId,
                               Optional<String> parentSpanId,
                               LogEntry entry,
                               Optional<Long> requestTime,
                               Optional<Long> startNanoTime)

Generates the JSON string object that we can log.

Parameters:

spanId - The Zipkin spanId (if there is one, null otherwise

parentSpanId - The Zipkin parent spanId (if there is on, null otherwise).

entry - The LogEntry data

requestTime - An Optional that may contain the total request time in nanoseconds if applicable.

Returns:

The JSON object as a string.

cleanMdc

protected void cleanMdc()

getLogEntriesFromBuffer

public List<LogEntry> getLogEntriesFromBuffer()

Description copied from interface: InstrumentationLogger

Fetch the current list of statistics stored in memory.

Specified by:

getLogEntriesFromBuffer in interface InstrumentationLogger

Returns:

A copy of the current list.

clearMemoryBuffer

public void clearMemoryBuffer()

Description copied from interface: InstrumentationLogger

Clear all the data collected in the memory buffer.

Specified by:

clearMemoryBuffer in interface InstrumentationLogger

isEnabled

protected boolean isEnabled()