Index (co.elastic.apm:apm-agent-api 1.16.0 API)

A C D E G H I N S T V

A

AbstractSpanImpl - Class in co.elastic.apm.api
action() - Method in annotation type co.elastic.apm.api.CaptureSpan: Sets the action of the captured span, used to group similar spans together, for example: `query`.
action() - Method in annotation type co.elastic.apm.api.Traced: Sets the action of the captured span, used to group similar spans together, for example: `query`.
activate() - Method in class co.elastic.apm.api.AbstractSpanImpl
activate() - Method in interface co.elastic.apm.api.Span: Makes this span the active span on the current thread until Scope.close() has been called.
activate() - Method in interface co.elastic.apm.api.Transaction: Makes this transaction the active transaction on the current thread until Scope.close() has been called.
addCustomContext(String, boolean) - Method in interface co.elastic.apm.api.Transaction: Custom context is used to add non-indexed, custom contextual information to transactions.
addCustomContext(String, Number) - Method in interface co.elastic.apm.api.Transaction: Custom context is used to add non-indexed, custom contextual information to transactions.
addCustomContext(String, String) - Method in interface co.elastic.apm.api.Transaction: Custom context is used to add non-indexed, custom contextual information to transactions.
addHeader(String, String) - Method in interface co.elastic.apm.api.HeaderInjector: Injects a header key and value into the underlying request object of an networking library
addLabel(String, boolean) - Method in interface co.elastic.apm.api.Span: Labels are used to add indexed information to transactions, spans, and errors.
addLabel(String, boolean) - Method in interface co.elastic.apm.api.Transaction
addLabel(String, Number) - Method in interface co.elastic.apm.api.Span: Labels are used to add indexed information to transactions, spans, and errors.
addLabel(String, Number) - Method in interface co.elastic.apm.api.Transaction
addLabel(String, String) - Method in interface co.elastic.apm.api.Span: Labels are used to add indexed information to transactions, spans, and errors.
addLabel(String, String) - Method in interface co.elastic.apm.api.Transaction
addTag(String, String) - Method in interface co.elastic.apm.api.Span: Deprecated.
use Span.addLabel(String, String) instead
addTag(String, String) - Method in interface co.elastic.apm.api.Transaction: Deprecated.
use Transaction.addLabel(String, String) instead

C

captureException(Throwable) - Method in class co.elastic.apm.api.AbstractSpanImpl
captureException(Throwable) - Static method in class co.elastic.apm.api.ElasticApm: Deprecated.
use ElasticApm.currentSpan().captureException(Throwable) instead
captureException(Throwable) - Method in interface co.elastic.apm.api.Span: Captures an exception and reports it to the APM server.
CaptureSpan - Annotation Type in co.elastic.apm.api: Annotating a method with @CaptureSpan creates a Span as the child of the currently active span or transaction (ElasticApm.currentSpan()).
CaptureTransaction - Annotation Type in co.elastic.apm.api: Annotating a method with @CaptureTransaction creates a Transaction for that method.
close() - Method in enum co.elastic.apm.api.NoopScope
close() - Method in interface co.elastic.apm.api.Scope: Closing a scope removes the corresponding Span from the current thread.
close() - Method in class co.elastic.apm.api.ScopeImpl
co.elastic.apm.api - module co.elastic.apm.api
co.elastic.apm.api - package co.elastic.apm.api: Contains the public API of the Elastic APM Java agent.
createSpan() - Method in class co.elastic.apm.api.AbstractSpanImpl
createSpan() - Method in interface co.elastic.apm.api.Span: Deprecated.
createSpan() - Method in interface co.elastic.apm.api.Transaction: Deprecated.
currentSpan() - Static method in class co.elastic.apm.api.ElasticApm: Returns the currently active span or transaction.
currentTransaction() - Static method in class co.elastic.apm.api.ElasticApm: Returns the currently running transaction.

D

doSetStartTimestamp(long) - Method in class co.elastic.apm.api.AbstractSpanImpl

E

ElasticApm - Class in co.elastic.apm.api: This class is the main entry point of the public API for the Elastic APM agent.
end() - Method in class co.elastic.apm.api.AbstractSpanImpl
end() - Method in interface co.elastic.apm.api.Span: Ends the span and schedules it to be reported to the APM Server.
end() - Method in interface co.elastic.apm.api.Transaction: End tracking the transaction.
end(long) - Method in class co.elastic.apm.api.AbstractSpanImpl
end(long) - Method in interface co.elastic.apm.api.Span: Ends the span and schedules it to be reported to the APM Server.
ensureParentId() - Method in interface co.elastic.apm.api.Transaction: If the transaction does not have a parent-ID yet, calling this method generates a new ID, sets it as the parent-ID of this transaction, and returns it as a `String`.

G

getAllHeaders(String) - Method in interface co.elastic.apm.api.HeadersExtractor: Returns all values of the provided header name
getFirstHeader(String) - Method in interface co.elastic.apm.api.HeaderExtractor: Returns the value of the provided header name
getId() - Method in class co.elastic.apm.api.AbstractSpanImpl
getId() - Method in interface co.elastic.apm.api.Span: Returns the id of this span (never null)
getId() - Method in interface co.elastic.apm.api.Transaction: Returns the id of this transaction (never null)
getTraceId() - Method in class co.elastic.apm.api.AbstractSpanImpl
getTraceId() - Method in interface co.elastic.apm.api.Span: Returns the id of this trace (never null)

H

HeaderExtractor - Interface in co.elastic.apm.api: Used to extract the first header with a specific header name.
HeaderInjector - Interface in co.elastic.apm.api: Used to inject a header into a networking library's underlying outgoing request object.
HeadersExtractor - Interface in co.elastic.apm.api: Used to extract all header values with a specific header name.

I

injectTraceHeaders(HeaderInjector) - Method in class co.elastic.apm.api.AbstractSpanImpl
injectTraceHeaders(HeaderInjector) - Method in interface co.elastic.apm.api.Span: Allows for manual propagation of the tracing headers.
INSTANCE - co.elastic.apm.api.NoopScope
isSampled() - Method in class co.elastic.apm.api.AbstractSpanImpl
isSampled() - Method in interface co.elastic.apm.api.Span: Returns true if this span is recorded and sent to the APM Server

N

NoopScope - Enum in co.elastic.apm.api

S

Scope - Interface in co.elastic.apm.api: Scopes are designed to be used in combination with try-with-resource statements to remove activated spans from the current thread.
ScopeImpl - Class in co.elastic.apm.api
setName(String) - Method in interface co.elastic.apm.api.Span: The name of the span.
setName(String) - Method in interface co.elastic.apm.api.Transaction: Override the name of the current transaction.
setResult(String) - Method in interface co.elastic.apm.api.Transaction: A string describing the result of the transaction.
setStartTimestamp(long) - Method in interface co.elastic.apm.api.Span: Sets the start timestamp of this event.
setStartTimestamp(long) - Method in interface co.elastic.apm.api.Transaction
setType(String) - Method in interface co.elastic.apm.api.Span: Deprecated.
setType(String) - Method in interface co.elastic.apm.api.Transaction: The type of the transaction.
setUser(String, String, String) - Method in interface co.elastic.apm.api.Transaction: Call this to enrich collected performance data and errors with information about the user/client.
span - Variable in class co.elastic.apm.api.AbstractSpanImpl
Span - Interface in co.elastic.apm.api: A span contains information about a specific code path, executed as part of a Transaction.
startSpan() - Method in class co.elastic.apm.api.AbstractSpanImpl
startSpan() - Method in interface co.elastic.apm.api.Span: Start and return a new custom span with no type, as a child of this span.
startSpan(String, String, String) - Method in class co.elastic.apm.api.AbstractSpanImpl
startSpan(String, String, String) - Method in interface co.elastic.apm.api.Span: Start and return a new typed custom span as a child of this span.
startTransaction() - Static method in class co.elastic.apm.api.ElasticApm: Use this method to create a custom transaction.
startTransactionWithRemoteParent(HeaderExtractor) - Static method in class co.elastic.apm.api.ElasticApm: Similar to ElasticApm.startTransaction() but creates this transaction as the child of a remote parent.
startTransactionWithRemoteParent(HeaderExtractor, HeadersExtractor) - Static method in class co.elastic.apm.api.ElasticApm: Similar to ElasticApm.startTransaction() but creates this transaction as the child of a remote parent.
subtype() - Method in annotation type co.elastic.apm.api.CaptureSpan: Sets the subtype of the captured span, used to group similar spans together, for example: `mysql`.
subtype() - Method in annotation type co.elastic.apm.api.Traced: Sets the subtype of the captured span, used to group similar spans together, for example: `mysql`.

T

Traced - Annotation Type in co.elastic.apm.api: Annotating a method with @Traced creates a Span as the child of the currently active span or transaction (ElasticApm.currentSpan()).
Transaction - Interface in co.elastic.apm.api: A transaction is the data captured by an agent representing an event occurring in a monitored service and groups multiple spans in a logical group.
type() - Method in annotation type co.elastic.apm.api.CaptureSpan: Sets the general type of the captured span, used to group similar spans together, for example: `db`.
type() - Method in annotation type co.elastic.apm.api.CaptureTransaction: The type of the transaction.
type() - Method in annotation type co.elastic.apm.api.Traced: Sets the general type of the captured span or transaction, used to group similar spans together, for example: `db`.
TYPE_REQUEST - Static variable in interface co.elastic.apm.api.Transaction

V

value() - Method in annotation type co.elastic.apm.api.CaptureSpan: The name of the Span.
value() - Method in annotation type co.elastic.apm.api.CaptureTransaction: The name of the Transaction.
value() - Method in annotation type co.elastic.apm.api.Traced: The name of the Span or Transaction.
valueOf(String) - Static method in enum co.elastic.apm.api.NoopScope: Returns the enum constant of this type with the specified name.
values() - Static method in enum co.elastic.apm.api.NoopScope: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I N S T V