A B C D E F G H I L M N O P Q R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- acceptDistributedTracePayload(DistributedTracePayload) - Method in interface com.newrelic.api.agent.Transaction
-
Accept a distributed trace payload.
- acceptDistributedTracePayload(String) - Method in interface com.newrelic.api.agent.Transaction
-
Accept a distributed trace payload.
- addCustomAttribute(String, boolean) - Method in interface com.newrelic.api.agent.AttributeHolder
-
Adds/Replaces a boolean attribute.
- addCustomAttribute(String, Number) - Method in interface com.newrelic.api.agent.AttributeHolder
-
Adds/Replaces a numerical attribute.
- addCustomAttribute(String, String) - Method in interface com.newrelic.api.agent.AttributeHolder
-
Adds/Replaces a string attribute.
- addCustomAttributes(Map<String, Object>) - Method in interface com.newrelic.api.agent.AttributeHolder
-
Adds/Replaces key/value pairs.
- addCustomParameter(String, boolean) - Static method in class com.newrelic.api.agent.NewRelic
-
Add a key/value pair to the current transaction.
- addCustomParameter(String, Number) - Static method in class com.newrelic.api.agent.NewRelic
-
Add a key/value pair to the current transaction.
- addCustomParameter(String, String) - Static method in class com.newrelic.api.agent.NewRelic
-
Add a key/value pair to the current transaction.
- addCustomParameters(Map<String, Object>) - Static method in class com.newrelic.api.agent.NewRelic
-
Add key/value pairs to the current transaction.
- addOutboundRequestHeaders(OutboundHeaders) - Method in interface com.newrelic.api.agent.Segment
-
Adds headers to the external request so that the request can be recognized on the receiving end.
- addOutboundRequestHeaders(OutboundHeaders) - Method in interface com.newrelic.api.agent.TracedMethod
-
To be called when performing an outbound external request using HTTP or JMS.
- addOutboundResponseHeaders() - Method in interface com.newrelic.api.agent.Transaction
-
Adds headers to the external response so that the response can be recognized on the receiving end.
- addRollupMetricName(String...) - Method in interface com.newrelic.api.agent.TracedMethod
-
Metric names added here will be reported as roll-up metrics.
- Agent - Interface in com.newrelic.api.agent
-
The New Relic Java Agent's API.
- async() - Method in annotation type com.newrelic.api.agent.Trace
-
Tells the agent that this method is asynchronous and that it should be traced if the method is linked to an existing transaction.
- AttributeHolder - Interface in com.newrelic.api.agent
B
- build() - Method in interface com.newrelic.api.agent.DatastoreParameters.Build
-
Build the final
DatastoreParameters
for the API call. - build() - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- build() - Method in interface com.newrelic.api.agent.GenericParameters.Build
-
Build the final
GenericParameters
for the API call. - build() - Method in class com.newrelic.api.agent.GenericParameters.Builder
- build() - Method in interface com.newrelic.api.agent.HttpParameters.Build
-
Build the final
HttpParameters
for the API call. - build() - Method in class com.newrelic.api.agent.HttpParameters.Builder
- build() - Method in interface com.newrelic.api.agent.MessageConsumeParameters.Build
-
Build the final
MessageConsumeParameters
for the API call. - build() - Method in class com.newrelic.api.agent.MessageConsumeParameters.Builder
- build() - Method in interface com.newrelic.api.agent.MessageProduceParameters.Build
-
Build the final
MessageProduceParameters
for the API call. - build() - Method in class com.newrelic.api.agent.MessageProduceParameters.Builder
- Builder(String) - Constructor for class com.newrelic.api.agent.DatastoreParameters.Builder
- Builder(String) - Constructor for class com.newrelic.api.agent.GenericParameters.Builder
- Builder(String) - Constructor for class com.newrelic.api.agent.HttpParameters.Builder
- Builder(String) - Constructor for class com.newrelic.api.agent.MessageConsumeParameters.Builder
- Builder(String) - Constructor for class com.newrelic.api.agent.MessageProduceParameters.Builder
C
- collection(String) - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- collection(String) - Method in interface com.newrelic.api.agent.DatastoreParameters.CollectionParameter
-
Set the name of the collection or table.
- com.newrelic.api.agent - package com.newrelic.api.agent
- Config - Interface in com.newrelic.api.agent
-
Provides access to agent configuration settings.
- convertToWebTransaction() - Method in interface com.newrelic.api.agent.Transaction
-
Turns the current transaction from a background transaction into a web transaction.
- createDistributedTracePayload() - Method in interface com.newrelic.api.agent.Transaction
-
Create a distributed trace payload.
- CUSTOM_HIGH - com.newrelic.api.agent.TransactionNamePriority
-
Use a custom transaction name (user defined).
- CUSTOM_LOW - com.newrelic.api.agent.TransactionNamePriority
-
Use a custom transaction name (user defined).
D
- databaseName(String) - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- databaseName(String) - Method in interface com.newrelic.api.agent.DatastoreParameters.DatabaseParameter
-
Set the name of the database where the query was executed
- DatastoreParameters - Class in com.newrelic.api.agent
-
The input parameters required to report a datastore on the
TracedMethod
. - DatastoreParameters(DatastoreParameters) - Constructor for class com.newrelic.api.agent.DatastoreParameters
- DatastoreParameters.Build - Interface in com.newrelic.api.agent
- DatastoreParameters.Builder - Class in com.newrelic.api.agent
- DatastoreParameters.CollectionParameter - Interface in com.newrelic.api.agent
- DatastoreParameters.DatabaseParameter - Interface in com.newrelic.api.agent
- DatastoreParameters.InstanceParameter - Interface in com.newrelic.api.agent
- DatastoreParameters.OperationParameter - Interface in com.newrelic.api.agent
- DatastoreParameters.SlowQueryParameter - Interface in com.newrelic.api.agent
- DatastoreParameters.SlowQueryWithInputParameter - Interface in com.newrelic.api.agent
- destinationName(String) - Method in class com.newrelic.api.agent.MessageConsumeParameters.Builder
- destinationName(String) - Method in interface com.newrelic.api.agent.MessageConsumeParameters.DestinationNameParameter
-
Set the destination name of the external call.
- destinationName(String) - Method in class com.newrelic.api.agent.MessageProduceParameters.Builder
- destinationName(String) - Method in interface com.newrelic.api.agent.MessageProduceParameters.DestinationNameParameter
-
Set the destination name of the external call.
- destinationType(DestinationType) - Method in class com.newrelic.api.agent.MessageConsumeParameters.Builder
- destinationType(DestinationType) - Method in interface com.newrelic.api.agent.MessageConsumeParameters.DestinationTypeParameter
-
Set the destination type of the external call.
- destinationType(DestinationType) - Method in class com.newrelic.api.agent.MessageProduceParameters.Builder
- destinationType(DestinationType) - Method in interface com.newrelic.api.agent.MessageProduceParameters.DestinationTypeParameter
-
Set the destination type of the external call.
- DestinationType - Enum in com.newrelic.api.agent
-
Used for specifying destination of a message action.
- dispatcher() - Method in annotation type com.newrelic.api.agent.Trace
-
If true, this method will be considered the start of a transaction.
- DistributedTracePayload - Interface in com.newrelic.api.agent
-
Payload used to connect two services in a distributed system.
E
- end() - Method in interface com.newrelic.api.agent.Segment
-
Stops timing the
Segment
and complete the execution on this thread. - endAsync() - Method in interface com.newrelic.api.agent.Segment
-
Stops timing the
Segment
and complete the execution on another thread. - EXCHANGE - com.newrelic.api.agent.DestinationType
-
AMQP Exchange
- excludeFromTransactionTrace() - Method in annotation type com.newrelic.api.agent.Trace
-
Excludes this traced method from transaction traces.
- expire() - Method in interface com.newrelic.api.agent.Token
-
Invalidates the token, making it unable to link work together in a
Transaction
. - extendedInboundHeaders(ExtendedInboundHeaders) - Method in class com.newrelic.api.agent.HttpParameters.Builder
- extendedInboundHeaders(ExtendedInboundHeaders) - Method in interface com.newrelic.api.agent.HttpParameters.InboundHeadersParameter
-
Set the inbound headers on the HTTP call.
- ExtendedInboundHeaders - Class in com.newrelic.api.agent
- ExtendedInboundHeaders() - Constructor for class com.newrelic.api.agent.ExtendedInboundHeaders
- ExtendedRequest - Class in com.newrelic.api.agent
-
A
Request
that provides more information for reporting to New Relic. - ExtendedRequest() - Constructor for class com.newrelic.api.agent.ExtendedRequest
- ExtendedResponse - Class in com.newrelic.api.agent
-
A
Response
that provides more information for reporting to New Relic. - ExtendedResponse() - Constructor for class com.newrelic.api.agent.ExtendedResponse
- ExternalParameters - Interface in com.newrelic.api.agent
-
Interface for passing external parameters into the
TracedMethod
's reportAsExternal.
F
- FRAMEWORK_HIGH - com.newrelic.api.agent.TransactionNamePriority
-
Use for framework instrumentation.
- FRAMEWORK_LOW - com.newrelic.api.agent.TransactionNamePriority
-
Use for framework instrumentation.
G
- GenericParameters - Class in com.newrelic.api.agent
-
Parameters required to report a basic external call using
TracedMethod
's reportAsExternal. - GenericParameters(GenericParameters) - Constructor for class com.newrelic.api.agent.GenericParameters
- GenericParameters(String, URI, String) - Constructor for class com.newrelic.api.agent.GenericParameters
- GenericParameters.Build - Interface in com.newrelic.api.agent
- GenericParameters.Builder - Class in com.newrelic.api.agent
- GenericParameters.ProcedureParameter - Interface in com.newrelic.api.agent
- GenericParameters.UriParameter - Interface in com.newrelic.api.agent
- getAgent() - Static method in class com.newrelic.api.agent.NewRelic
-
Returns the root of the New Relic Java Agent API object hierarchy.
- getAttribute(String) - Method in interface com.newrelic.api.agent.Request
-
Deprecated.Returns the value of the named attribute as an
Object
, ornull
if no attribute of the given name exists. - getBrowserTimingFooter() - Static method in class com.newrelic.api.agent.NewRelic
-
Get the RUM JavaScript footer for the current web transaction.
- getBrowserTimingHeader() - Static method in class com.newrelic.api.agent.NewRelic
-
Get the RUM JavaScript header for the current web transaction.
- getCollection() - Method in class com.newrelic.api.agent.DatastoreParameters
-
Returns the name of the collection or table.
- getConfig() - Method in interface com.newrelic.api.agent.Agent
-
Returns the agent's configuration.
- getContentLength() - Method in class com.newrelic.api.agent.ExtendedResponse
-
The Content-Length for this response
- getContentType() - Method in interface com.newrelic.api.agent.Response
-
Deprecated.Returns the response content type, or
null
if it is not available. - getCookieValue(String) - Method in interface com.newrelic.api.agent.Request
-
Deprecated.Returns the value for the cookie with the given name, or
null
if the cookie does not exist. - getDatabaseName() - Method in class com.newrelic.api.agent.DatastoreParameters
-
Return the name of the database where the query was executed.
- getDestinationName() - Method in class com.newrelic.api.agent.MessageConsumeParameters
- getDestinationName() - Method in class com.newrelic.api.agent.MessageProduceParameters
- getDestinationType() - Method in class com.newrelic.api.agent.MessageConsumeParameters
- getDestinationType() - Method in class com.newrelic.api.agent.MessageProduceParameters
- getExtendedInboundResponseHeaders() - Method in class com.newrelic.api.agent.HttpParameters
-
Returns the headers from the response of the external call.
- getHeader(String) - Method in interface com.newrelic.api.agent.InboundHeaders
-
Returns the value of the specified request header as a
String
. - getHeaders(String) - Method in class com.newrelic.api.agent.ExtendedInboundHeaders
- getHeaderType() - Method in interface com.newrelic.api.agent.InboundHeaders
-
Return the type of header key syntax used for this.
- getHeaderType() - Method in interface com.newrelic.api.agent.OutboundHeaders
-
Return the type of header key syntax used for this.
- getHost() - Method in class com.newrelic.api.agent.DatastoreParameters
-
Returns the name of the host where the datastore is located.
- getInboundHeaders() - Method in class com.newrelic.api.agent.MessageConsumeParameters
- getInboundResponseHeaders() - Method in class com.newrelic.api.agent.HttpParameters
-
Returns the headers from the response of the external call.
- getInputQueryLabel() - Method in class com.newrelic.api.agent.SlowQueryWithInputDatastoreParameters
-
Returns the label denoting the type of input query.
- getInsights() - Method in interface com.newrelic.api.agent.Agent
-
Provides access to the Insights custom events API.
- getLastTracer() - Method in interface com.newrelic.api.agent.Transaction
-
Deprecated.
- getLibrary() - Method in class com.newrelic.api.agent.GenericParameters
-
Returns the name of the framework used to make the connection.
- getLibrary() - Method in class com.newrelic.api.agent.HttpParameters
-
Returns the name of the framework used to make the connection.
- getLibrary() - Method in class com.newrelic.api.agent.MessageConsumeParameters
- getLibrary() - Method in class com.newrelic.api.agent.MessageProduceParameters
- getLinkingMetadata() - Method in interface com.newrelic.api.agent.Agent
-
Returns an opaque map of key/value pairs that can be used to correlate this application in the New Relic backend.
- getLogger() - Method in interface com.newrelic.api.agent.Agent
-
Returns a logger that logs to the New Relic Java agent log file.
- getMethod() - Method in class com.newrelic.api.agent.ExtendedRequest
-
The HTTP method (e.g.
- getMetricAggregator() - Method in interface com.newrelic.api.agent.Agent
-
Returns a metric aggregator that can be used to record metrics that can be viewed through custom dashboards.
- getMetricName() - Method in interface com.newrelic.api.agent.TracedMethod
-
Returns the traced method metric name.
- getOperation() - Method in class com.newrelic.api.agent.DatastoreParameters
-
Returns the datastore operation.
- getOutboundHeaders() - Method in class com.newrelic.api.agent.MessageProduceParameters
- getParameterNames() - Method in interface com.newrelic.api.agent.Request
-
Deprecated.Returns an
Enumeration
ofString
objects containing the names of the parameters contained in this request. - getParameterValues(String) - Method in interface com.newrelic.api.agent.Request
-
Deprecated.Returns an array of
String
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist. - getPathOrId() - Method in class com.newrelic.api.agent.DatastoreParameters
-
Return the path or id of the instance.
- getPort() - Method in class com.newrelic.api.agent.DatastoreParameters
-
Returns the port for the connection to the datastore.
- getProcedure() - Method in class com.newrelic.api.agent.GenericParameters
-
Returns the HTTP method or Java method for the call.
- getProcedure() - Method in class com.newrelic.api.agent.HttpParameters
-
Returns the HTTP method for the call.
- getProduct() - Method in class com.newrelic.api.agent.DatastoreParameters
-
Returns the name of the vendor.
- getQueryConverter() - Method in class com.newrelic.api.agent.SlowQueryDatastoreParameters
-
Returns the converter implementation used to transform the raw query into a string
- getRawInputQuery() - Method in class com.newrelic.api.agent.SlowQueryWithInputDatastoreParameters
-
Returns the raw input query object used for processing.
- getRawInputQueryConverter() - Method in class com.newrelic.api.agent.SlowQueryWithInputDatastoreParameters
-
Returns the converter implementation used to transform the raw input query into a string
- getRawQuery() - Method in class com.newrelic.api.agent.SlowQueryDatastoreParameters
-
Returns the raw query object used for processing.
- getRemoteUser() - Method in interface com.newrelic.api.agent.Request
-
Deprecated.Returns the login of the user making this request, if the user has been authenticated, or
null
if the user has not been authenticated. - getRequestMetadata() - Method in interface com.newrelic.api.agent.Transaction
-
Deprecated.Instead, use the Distributed Tracing API
Transaction.createDistributedTracePayload()
to create a distributed tracing payload andTransaction.acceptDistributedTracePayload(DistributedTracePayload)
to link the services together. - getRequestURI() - Method in interface com.newrelic.api.agent.Request
-
Deprecated.Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
- getResponseMetadata() - Method in interface com.newrelic.api.agent.Transaction
-
Deprecated.Instead, use the Distributed Tracing API. There is no equivalent of this method in Distributed Tracing.
- getSpanId() - Method in interface com.newrelic.api.agent.TraceMetadata
-
Returns the span identifier associated with the current executing span.
- getStatus() - Method in interface com.newrelic.api.agent.Response
-
Deprecated.Returns the status code for this response.
- getStatusMessage() - Method in interface com.newrelic.api.agent.Response
-
Deprecated.Returns the error status message, or
null
if there is none. - getToken() - Method in interface com.newrelic.api.agent.Transaction
-
Creates a
Token
for linking asynchronous work to the currentTransaction
. - getTracedMethod() - Method in interface com.newrelic.api.agent.Agent
-
Returns the current traced method.
- getTracedMethod() - Method in interface com.newrelic.api.agent.Transaction
-
Returns the
TracedMethod
enclosing the caller. - getTraceId() - Method in interface com.newrelic.api.agent.TraceMetadata
-
Returns the currently executing trace identifier.
- getTraceMetadata() - Method in interface com.newrelic.api.agent.Agent
-
Provides access to the Trace Metadata API for details about the currently executing distributed trace.
- getTransaction() - Method in interface com.newrelic.api.agent.Agent
-
Returns the current transaction.
- getTransaction() - Method in interface com.newrelic.api.agent.Segment
-
Get the
Transaction
of thisSegment
. - getTypeName() - Method in enum com.newrelic.api.agent.DestinationType
-
Get the generalized type name of a queue source or destination.
- getUri() - Method in class com.newrelic.api.agent.GenericParameters
-
Returns the URI for the external call.
- getUri() - Method in class com.newrelic.api.agent.HttpParameters
-
Returns the URI for the external call.
- getValue(String) - Method in interface com.newrelic.api.agent.Config
-
Get the value of a setting.
- getValue(String, T) - Method in interface com.newrelic.api.agent.Config
-
Get the value of a setting, returning the default if the value is not present.
H
- HeaderType - Enum in com.newrelic.api.agent
-
Used for specifying header key syntax for
InboundHeaders
andOutboundHeaders
. - HTTP - com.newrelic.api.agent.HeaderType
-
To be used with HTTP and HTTPS requests and responses.
- HttpParameters - Class in com.newrelic.api.agent
-
Use to report an HTTP external call with cross application tracing.
- HttpParameters(HttpParameters) - Constructor for class com.newrelic.api.agent.HttpParameters
- HttpParameters(String, URI, String, InboundHeaders) - Constructor for class com.newrelic.api.agent.HttpParameters
- HttpParameters(String, URI, String, InboundHeaders, ExtendedInboundHeaders) - Constructor for class com.newrelic.api.agent.HttpParameters
- HttpParameters.Build - Interface in com.newrelic.api.agent
- HttpParameters.Builder - Class in com.newrelic.api.agent
- HttpParameters.InboundHeadersParameter - Interface in com.newrelic.api.agent
- HttpParameters.ProcedureParameter - Interface in com.newrelic.api.agent
- HttpParameters.UriParameter - Interface in com.newrelic.api.agent
- httpSafe() - Method in interface com.newrelic.api.agent.DistributedTracePayload
-
Get the distributed trace payload in base64 encoded JSON String format
I
- ignore() - Method in interface com.newrelic.api.agent.Segment
-
Stops tracking the
Segment
and does not report it as part of its parent transaction. - ignore() - Method in interface com.newrelic.api.agent.Transaction
-
Ignore this transaction so that none of its data is reported to the New Relic service.
- ignoreApdex() - Static method in class com.newrelic.api.agent.NewRelic
-
Ignore the current transaction for calculating Apdex score.
- ignoreApdex() - Method in interface com.newrelic.api.agent.Transaction
-
Ignore the current transaction for calculating Apdex score.
- ignoreErrors() - Method in interface com.newrelic.api.agent.Transaction
-
Ignore throwable and http status code errors resulting from this transaction.
- ignoreTransaction() - Static method in class com.newrelic.api.agent.NewRelic
-
Ignore the current transaction.
- inboundHeaders(InboundHeaders) - Method in class com.newrelic.api.agent.HttpParameters.Builder
- inboundHeaders(InboundHeaders) - Method in interface com.newrelic.api.agent.HttpParameters.InboundHeadersParameter
-
Set the inbound headers on the HTTP call.
- inboundHeaders(InboundHeaders) - Method in class com.newrelic.api.agent.MessageConsumeParameters.Builder
- inboundHeaders(InboundHeaders) - Method in interface com.newrelic.api.agent.MessageConsumeParameters.InboundHeadersParameter
-
Set the inbound headers on the external call.
- InboundHeaders - Interface in com.newrelic.api.agent
-
The type-specific headers collection of an inbound message.
- incrementCounter(String) - Method in interface com.newrelic.api.agent.MetricAggregator
-
Increment the count of the metric with the given name.
- incrementCounter(String) - Static method in class com.newrelic.api.agent.NewRelic
-
Increment the metric counter for the given name.
- incrementCounter(String, int) - Method in interface com.newrelic.api.agent.MetricAggregator
-
Increment the count of the metric with the given name.
- incrementCounter(String, int) - Static method in class com.newrelic.api.agent.NewRelic
-
Increment the metric counter for the given name.
- Insights - Interface in com.newrelic.api.agent
-
Used to send custom events to Insights.
- instance(String, Integer) - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- instance(String, Integer) - Method in interface com.newrelic.api.agent.DatastoreParameters.InstanceParameter
-
Set the host and port of the datastore connection used for this query.
- instance(String, String) - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- instance(String, String) - Method in interface com.newrelic.api.agent.DatastoreParameters.InstanceParameter
-
Set the host and pathOrId of the datastore connection used for this query.
- isActive() - Method in interface com.newrelic.api.agent.Token
-
Checks if a token is valid and can be used to link work to the originating
Transaction
associated with the token. - isLoggable(Level) - Method in interface com.newrelic.api.agent.Logger
-
Returns true if the given log level will be logged.
- isSampled() - Method in interface com.newrelic.api.agent.TraceMetadata
-
Returns whether or not the current transaction is sampled from a distributed tracing perspective.
- isTransactionNameSet() - Method in interface com.newrelic.api.agent.Transaction
-
Returns true if the transaction name has been set.
- isWebTransaction() - Method in interface com.newrelic.api.agent.Transaction
-
Returns true if in a web transaction.
L
- leaf() - Method in annotation type com.newrelic.api.agent.Trace
-
A leaf tracer will not have any child tracers.
- library(String) - Static method in class com.newrelic.api.agent.GenericParameters
-
Set the name of the library.
- library(String) - Static method in class com.newrelic.api.agent.HttpParameters
-
Set the name of the library.
- library(String) - Static method in class com.newrelic.api.agent.MessageConsumeParameters
-
Set the name of the library.
- library(String) - Static method in class com.newrelic.api.agent.MessageProduceParameters
-
Set the name of the library.
- link() - Method in interface com.newrelic.api.agent.Token
-
Links the work being done on the current thread back to the originating
Transaction
associated with the token. - linkAndExpire() - Method in interface com.newrelic.api.agent.Token
-
Links the work being done on the current thread back to the originating
Transaction
associated with the token and expires the token. - log(Level, String) - Method in interface com.newrelic.api.agent.Logger
-
Concatenate the given parts and log them at the given level.
- log(Level, String, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with one replacement.
- log(Level, String, Object[]) - Method in interface com.newrelic.api.agent.Logger
-
Do not use.
- log(Level, String, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with two replacements.
- log(Level, String, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with three replacements.
- log(Level, String, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with four replacements.
- log(Level, String, Object, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with five replacements.
- log(Level, String, Object, Object, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with six replacements.
- log(Level, String, Object, Object, Object, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with seven replacements.
- log(Level, String, Object, Object, Object, Object, Object, Object, Object, Object...) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern with seven + any other replacements.
- log(Level, Throwable, String) - Method in interface com.newrelic.api.agent.Logger
-
Log a message with given Throwable information.
- log(Level, Throwable, String, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with one replacement.
- log(Level, Throwable, String, Object[]) - Method in interface com.newrelic.api.agent.Logger
-
Do not use.
- log(Level, Throwable, String, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with two replacements.
- log(Level, Throwable, String, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with three replacements.
- log(Level, Throwable, String, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with four replacements.
- log(Level, Throwable, String, Object, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with five replacements.
- log(Level, Throwable, String, Object, Object, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with six replacements.
- log(Level, Throwable, String, Object, Object, Object, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with seven replacements.
- log(Level, Throwable, String, Object, Object, Object, Object, Object, Object, Object, Object...) - Method in interface com.newrelic.api.agent.Logger
-
Log a message at the given level using the provided pattern and throwable with seven + any other replacements.
- Logger - Interface in com.newrelic.api.agent
-
The Java agent's logging interface.
- logToChild(String, Level, String, Object, Object, Object, Object) - Method in interface com.newrelic.api.agent.Logger
-
Concatenate the given parts and log them at the given level.
M
- markResponseSent() - Method in interface com.newrelic.api.agent.Transaction
-
Marks the time when the last byte of the response left the server as the current timestamp.
- MESSAGE - com.newrelic.api.agent.HeaderType
-
To be used with message queue systems.
- MessageConsumeParameters - Class in com.newrelic.api.agent
-
Creates the parameters to report a message that was pulled from a message queue.
- MessageConsumeParameters(MessageConsumeParameters) - Constructor for class com.newrelic.api.agent.MessageConsumeParameters
- MessageConsumeParameters(String, DestinationType, String, InboundHeaders) - Constructor for class com.newrelic.api.agent.MessageConsumeParameters
- MessageConsumeParameters.Build - Interface in com.newrelic.api.agent
- MessageConsumeParameters.Builder - Class in com.newrelic.api.agent
- MessageConsumeParameters.DestinationNameParameter - Interface in com.newrelic.api.agent
- MessageConsumeParameters.DestinationTypeParameter - Interface in com.newrelic.api.agent
- MessageConsumeParameters.InboundHeadersParameter - Interface in com.newrelic.api.agent
- MessageProduceParameters - Class in com.newrelic.api.agent
-
Creates the parameters to report a message that was sent to a message queue.
- MessageProduceParameters(MessageProduceParameters) - Constructor for class com.newrelic.api.agent.MessageProduceParameters
- MessageProduceParameters(String, DestinationType, String, OutboundHeaders) - Constructor for class com.newrelic.api.agent.MessageProduceParameters
- MessageProduceParameters.Build - Interface in com.newrelic.api.agent
- MessageProduceParameters.Builder - Class in com.newrelic.api.agent
- MessageProduceParameters.DestinationNameParameter - Interface in com.newrelic.api.agent
- MessageProduceParameters.DestinationTypeParameter - Interface in com.newrelic.api.agent
- MessageProduceParameters.OutboundHeadersParameter - Interface in com.newrelic.api.agent
- methodFinished(Object) - Method in interface com.newrelic.api.agent.MethodTracer
-
Deprecated.Called if a method exits successfully.
- methodFinishedWithException(Throwable) - Method in interface com.newrelic.api.agent.MethodTracer
-
Deprecated.Called if a method exits because of an uncaught exception.
- methodInvoked(String, Object, Object[]) - Method in interface com.newrelic.api.agent.MethodTracerFactory
-
Deprecated.Called when an instrumented method is invoked.
- MethodTracer - Interface in com.newrelic.api.agent
-
Deprecated.
- MethodTracerFactory - Interface in com.newrelic.api.agent
-
Deprecated.
- MetricAggregator - Interface in com.newrelic.api.agent
-
This aggregator allows metrics to be reported which can be viewed through custom dashboards.
- metricName() - Method in annotation type com.newrelic.api.agent.Trace
-
Sets the metric name for this tracer.
N
- NAMED_QUEUE - com.newrelic.api.agent.DestinationType
-
Queue with specified name.
- NAMED_TOPIC - com.newrelic.api.agent.DestinationType
-
Topic with a specified name.
- nameTransaction() - Method in annotation type com.newrelic.api.agent.Trace
-
Names the current transaction using this tracer's metric name.
- NewRelic - Class in com.newrelic.api.agent
-
The New Relic API.
- NewRelic() - Constructor for class com.newrelic.api.agent.NewRelic
- noDatabaseName() - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- noDatabaseName() - Method in interface com.newrelic.api.agent.DatastoreParameters.DatabaseParameter
-
No database information recorded.
- noInboundHeaders() - Method in class com.newrelic.api.agent.HttpParameters.Builder
- noInboundHeaders() - Method in interface com.newrelic.api.agent.HttpParameters.InboundHeadersParameter
-
No inbound headers.
- noInstance() - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- noInstance() - Method in interface com.newrelic.api.agent.DatastoreParameters.InstanceParameter
-
No instance information recorded.
- noSlowQuery() - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- noSlowQuery() - Method in interface com.newrelic.api.agent.DatastoreParameters.SlowQueryParameter
-
No slow query information recorded.
- noticeError(String) - Static method in class com.newrelic.api.agent.NewRelic
-
Notice an error and report it to New Relic.
- noticeError(String, boolean) - Static method in class com.newrelic.api.agent.NewRelic
-
Notice an error and report it to New Relic.
- noticeError(String, Map<String, ?>) - Static method in class com.newrelic.api.agent.NewRelic
-
Notice an error and report it to New Relic.
- noticeError(String, Map<String, ?>, boolean) - Static method in class com.newrelic.api.agent.NewRelic
-
Notice an error and report it to New Relic.
- noticeError(Throwable) - Static method in class com.newrelic.api.agent.NewRelic
-
Report an exception to New Relic.
- noticeError(Throwable, boolean) - Static method in class com.newrelic.api.agent.NewRelic
-
Report an exception to New Relic.
- noticeError(Throwable, Map<String, ?>) - Static method in class com.newrelic.api.agent.NewRelic
-
Notice an exception and report it to New Relic.
- noticeError(Throwable, Map<String, ?>, boolean) - Static method in class com.newrelic.api.agent.NewRelic
-
Notice an exception and report it to New Relic.
- NULL - Static variable in annotation type com.newrelic.api.agent.Trace
-
Deprecated.No replacement. Do not use this.
O
- operation(String) - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- operation(String) - Method in interface com.newrelic.api.agent.DatastoreParameters.OperationParameter
-
Set the datastore operation.
- outboundHeaders(OutboundHeaders) - Method in class com.newrelic.api.agent.MessageProduceParameters.Builder
- outboundHeaders(OutboundHeaders) - Method in interface com.newrelic.api.agent.MessageProduceParameters.OutboundHeadersParameter
-
Set the outbound headers on the external call.
- OutboundHeaders - Interface in com.newrelic.api.agent
-
The type-specific headers collection of an outbound message
P
- procedure(String) - Method in class com.newrelic.api.agent.GenericParameters.Builder
- procedure(String) - Method in interface com.newrelic.api.agent.GenericParameters.ProcedureParameter
-
Set the HTTP method or Java method for the call.
- procedure(String) - Method in class com.newrelic.api.agent.HttpParameters.Builder
- procedure(String) - Method in interface com.newrelic.api.agent.HttpParameters.ProcedureParameter
-
Set the HTTP method for the call.
- processRequestMetadata(String) - Method in interface com.newrelic.api.agent.Transaction
-
Deprecated.Instead, use the Distributed Tracing API
Transaction.createDistributedTracePayload()
to create a distributed tracing payload andTransaction.acceptDistributedTracePayload(DistributedTracePayload)
to link the services together. - processResponseMetadata(String) - Method in interface com.newrelic.api.agent.Transaction
-
Deprecated.Instead, use the Distributed Tracing API. There is no equivalent of this method in Distributed Tracing.
- processResponseMetadata(String, URI) - Method in interface com.newrelic.api.agent.Transaction
-
Deprecated.Instead, use the Distributed Tracing API. There is no equivalent of this method in Distributed Tracing.
- product(String) - Static method in class com.newrelic.api.agent.DatastoreParameters
-
Set the name of the vendor.
Q
- QueryConverter<T> - Interface in com.newrelic.api.agent
-
Callers of
DatastoreParameters
that use slowQuery() or slowQueryWithInput() must implement this interface in order to properly record slow queries for their framework.
R
- recordCustomEvent(String, Map<String, ?>) - Method in interface com.newrelic.api.agent.Insights
-
Sends an Insights event for the current application.
- recordMetric(String, float) - Method in interface com.newrelic.api.agent.MetricAggregator
-
Record a metric value for the given name.
- recordMetric(String, float) - Static method in class com.newrelic.api.agent.NewRelic
-
Record a metric value for the given name.
- recordResponseTimeMetric(String, long) - Method in interface com.newrelic.api.agent.MetricAggregator
-
Record a response time in milliseconds for the given metric name.
- recordResponseTimeMetric(String, long) - Static method in class com.newrelic.api.agent.NewRelic
-
Record a response time in milliseconds for the given metric name.
- recordResponseTimeMetric(String, long, long, TimeUnit) - Method in interface com.newrelic.api.agent.MetricAggregator
-
Records a metric that will not be shown in the breakdown of time for a transaction, but can be displayed in a custom dashboard.
- reportAsExternal(ExternalParameters) - Method in interface com.newrelic.api.agent.Segment
-
Reports this traced method as an HTTP external call, datastore external call, or generic external call.
- reportAsExternal(ExternalParameters) - Method in interface com.newrelic.api.agent.TracedMethod
-
Used to report this traced method as an HTTP external call, datastore external call, or general external call.
- Request - Interface in com.newrelic.api.agent
-
Deprecated.since 3.21.0; use
ExtendedRequest
instead. - REQUEST_URI - com.newrelic.api.agent.TransactionNamePriority
-
Use the request URI.
- Response - Interface in com.newrelic.api.agent
-
Deprecated.since 3.41.0; use
ExtendedResponse
instead. - rollupMetricName() - Method in annotation type com.newrelic.api.agent.Trace
-
Specifies one or more rollup metrics names.
S
- Segment - Interface in com.newrelic.api.agent
-
Represents a timed unit of work.
- setAccountName(String) - Static method in class com.newrelic.api.agent.NewRelic
-
Set the account name to associate with the RUM JavaScript footer for the current web transaction.
- setAppServerPort(int) - Static method in class com.newrelic.api.agent.NewRelic
-
Set the app server port which is reported to RPM.
- setHeader(String, String) - Method in interface com.newrelic.api.agent.OutboundHeaders
-
Sets a response header with the given name and value.
- setInstanceName(String) - Static method in class com.newrelic.api.agent.NewRelic
-
Set the instance name in the environment.
- setMetricName(String...) - Method in interface com.newrelic.api.agent.Segment
-
Sets the metric name by concatenating all given metricNameParts with a '/' separating each part.
- setMetricName(String...) - Method in interface com.newrelic.api.agent.TracedMethod
-
Sets the traced method metric name by concatenating all given metricNameParts with a '/' separating each part.
- setProductName(String) - Static method in class com.newrelic.api.agent.NewRelic
-
Set the product name to associate with the RUM JavaScript footer for the current web transaction.
- setRequestAndResponse(Request, Response) - Static method in class com.newrelic.api.agent.NewRelic
-
Sets the request and response instances for the current transaction.
- setServerInfo(String, String) - Static method in class com.newrelic.api.agent.NewRelic
-
Set the dispatcher name and version which is reported to RPM.
- setTransactionName(TransactionNamePriority, boolean, String, String...) - Method in interface com.newrelic.api.agent.Transaction
-
Sets the current transaction's name using the given priority.
- setTransactionName(String, String) - Static method in class com.newrelic.api.agent.NewRelic
-
Set the name of the current transaction.
- setUserName(String) - Static method in class com.newrelic.api.agent.NewRelic
-
Set the user name to associate with the RUM JavaScript footer for the current web transaction.
- setWebRequest(ExtendedRequest) - Method in interface com.newrelic.api.agent.Transaction
-
Sets the request for the current transaction.
- setWebResponse(Response) - Method in interface com.newrelic.api.agent.Transaction
-
Sets the response for the current transaction.
- skipTransactionTrace() - Method in annotation type com.newrelic.api.agent.Trace
-
Deprecated.Use (
Trace.excludeFromTransactionTrace()
) instead. - slowQuery(T, QueryConverter<T>) - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- slowQuery(T, QueryConverter<T>) - Method in interface com.newrelic.api.agent.DatastoreParameters.SlowQueryParameter
-
Set a raw query and queryConverter to be used when reporting this call as a slow query
- SlowQueryDatastoreParameters<T> - Class in com.newrelic.api.agent
-
The input parameters required to report a slow datastore query on the
TracedMethod
. - SlowQueryDatastoreParameters(DatastoreParameters, T, QueryConverter<T>) - Constructor for class com.newrelic.api.agent.SlowQueryDatastoreParameters
- SlowQueryDatastoreParameters(SlowQueryDatastoreParameters<T>) - Constructor for class com.newrelic.api.agent.SlowQueryDatastoreParameters
- slowQueryWithInput(String, T, QueryConverter<T>) - Method in class com.newrelic.api.agent.DatastoreParameters.Builder
- slowQueryWithInput(String, T, QueryConverter<T>) - Method in interface com.newrelic.api.agent.DatastoreParameters.SlowQueryWithInputParameter
-
Set an input query and converter to be used when reporting this call as a slow query.
- SlowQueryWithInputDatastoreParameters<T,I> - Class in com.newrelic.api.agent
-
The input parameters required to report a slow datastore query on the
TracedMethod
including a correlating input query. - SlowQueryWithInputDatastoreParameters(SlowQueryDatastoreParameters<T>, String, I, QueryConverter<I>) - Constructor for class com.newrelic.api.agent.SlowQueryWithInputDatastoreParameters
- startSegment(String) - Method in interface com.newrelic.api.agent.Transaction
-
Starts and returns a
Segment
. - startSegment(String, String) - Method in interface com.newrelic.api.agent.Transaction
-
Starts and returns a
Segment
.
T
- TEMP_QUEUE - com.newrelic.api.agent.DestinationType
-
Temporary queue.
- TEMP_TOPIC - com.newrelic.api.agent.DestinationType
-
Temporary topic.
- text() - Method in interface com.newrelic.api.agent.DistributedTracePayload
-
Get the distributed trace payload in JSON String format.
- Token - Interface in com.newrelic.api.agent
-
Tokens are passed between threads to link asynchronous units of work to the originating
Transaction
associated with the token. - toObfuscatedQueryString(T) - Method in interface com.newrelic.api.agent.QueryConverter
-
Takes a raw query object and return it as a String representing an obfuscated form of the query.
- toRawQueryString(T) - Method in interface com.newrelic.api.agent.QueryConverter
-
Takes a raw query object and returns it as a String representing the query.
- Trace - Annotation Type in com.newrelic.api.agent
-
If you annotate a method with the Trace annotation it will be automatically timed by the New Relic agent with the following measurements: call count calls per minute total call time standard deviation call time min call time max call time A metric representing these measurements will be reporting inside the call scope of the current transaction (e.g., "/servlets/myservlet") so that New Relic can "break out" the response time of a given transaction by specific called methods.
- TracedMethod - Interface in com.newrelic.api.agent
-
Represents a single instance of the timing mechanism associated with a method that is instrumented using the
Trace
annotation. - TraceMetadata - Interface in com.newrelic.api.agent
-
Used to provide information about the currently executing trace.
- tracerFactoryName() - Method in annotation type com.newrelic.api.agent.Trace
-
Deprecated.Do not use.
- Transaction - Interface in com.newrelic.api.agent
-
A transaction represents a unit of work in an application.
- TransactionNamePriority - Enum in com.newrelic.api.agent
-
The priority to give to a call to
Transaction.setTransactionName(TransactionNamePriority, boolean, String, String...)
.
U
- uri(URI) - Method in class com.newrelic.api.agent.GenericParameters.Builder
- uri(URI) - Method in interface com.newrelic.api.agent.GenericParameters.UriParameter
-
Set the URI of the external call.
- uri(URI) - Method in class com.newrelic.api.agent.HttpParameters.Builder
- uri(URI) - Method in interface com.newrelic.api.agent.HttpParameters.UriParameter
-
Set the URI of the external call.
V
- valueOf(String) - Static method in enum com.newrelic.api.agent.DestinationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.newrelic.api.agent.HeaderType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.newrelic.api.agent.TransactionNamePriority
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.newrelic.api.agent.DestinationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.newrelic.api.agent.HeaderType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.newrelic.api.agent.TransactionNamePriority
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes All Packages