@ParametersAreNonnullByDefault public interface

InstrumentationLogger

com.atlassian.jira.instrumentation.InstrumentationLogger
Known Indirect Subclasses

Class Overview

Collects the instrumentation data and saves it to a datastore.

Summary

Public Methods
void clearMemoryBuffer()
Clear all the data collected in the memory buffer.
List<LogEntry> getLogEntriesFromBuffer()
Fetch the current list of statistics stored in memory.
void save(String traceId, Optional<String> spanId, Optional<String> parentSpanId, String path, List<? extends Statistics> requestData, Optional<Long> requestTime)
Saves request data to the queue above.
void save(String traceId, String path, List<? extends Statistics> requestData, Optional<Long> requestTime)
Saves request data to the queue above.

Public Methods

public void clearMemoryBuffer ()

Clear all the data collected in the memory buffer.

public List<LogEntry> getLogEntriesFromBuffer ()

Fetch the current list of statistics stored in memory.

Returns
  • A copy of the current list.

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

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.

Parameters
traceId The ID for this request.
spanId The Zipkin spanId from the request
parentSpanId The Zipkin parent span Id for the request
path the path of the URL.
requestData The list of cache statistics.
requestTime The time of the request in nanoseconds. If zero, we did not collect any time.

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

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.

Parameters
traceId The ID for this request.
path the path of the URL.
requestData The list of cache statistics.
requestTime The time in nanoseconds that the request took to complete.