com.newrelic.agent

Class HeadersUtil

java.lang.Object

com.newrelic.agent.HeadersUtil

public class HeadersUtil
extends java.lang.Object

Utility methods for consistent processing message headers regardless whether they arrive by HTTP or JMS. The underlying issue is that HTTP header strings (e.g. "X-Some-Header") are syntactically illegal in JMS because dashes are not allowed there. So when given a headers collection, we need to ask its type so we can deduce the key used to retrieve the header value. Presumably we may support additional protocols in the future.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NEWRELIC_APP_DATA_HEADER The response header for returning transaction data to clients.
static java.lang.String	NEWRELIC_APP_DATA_MESSAGE_HEADER
static java.lang.String	NEWRELIC_BAGGAGE_HEADER The request header for storing distributed trace baggage.
static java.util.Set<java.lang.String>	NEWRELIC_HEADERS
static java.lang.String	NEWRELIC_ID_HEADER The request header for storing our cross-process id in external calls.
static java.lang.String	NEWRELIC_ID_MESSAGE_HEADER
static java.lang.String	NEWRELIC_SYNTHETICS_HEADER The request header for tracing a transaction created by New Relic Synthetics
static java.lang.String	NEWRELIC_SYNTHETICS_MESSAGE_HEADER
static java.lang.String	NEWRELIC_TRACE_HEADER The request header for storing our distributed trace payloads.
static java.lang.String	NEWRELIC_TRACE_MESSAGE_HEADER
static java.lang.String	NEWRELIC_TRANSACTION_HEADER The request header for storing our transaction id in external calls.
static java.lang.String	NEWRELIC_TRANSACTION_MESSAGE_HEADER
static int	SYNTHETICS_MAX_VERSION Maximum supported version of New Relic Synthetics protocol.
static int	SYNTHETICS_MIN_VERSION Minimum supported version of New Relic Synthetics protocol.
static int	SYNTHETICS_VERSION_NONE Value that can never appear as a Synthetics protocol version.

Constructor Summary

Constructors

Constructor and Description
HeadersUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	createAndSetDistributedTraceHeaders(Transaction tx, com.newrelic.api.agent.TracedMethod tracedMethod, com.newrelic.api.agent.OutboundHeaders headers) creates new trace context distributed trace headers (and maybe new relic headers) and adds them to the headers object passed in
static java.lang.String	getAppDataHeader(com.newrelic.api.agent.InboundHeaders headers)
static java.lang.String	getIdHeader(com.newrelic.api.agent.InboundHeaders headers)
static java.lang.String	getNewRelicTraceHeader(com.newrelic.api.agent.InboundHeaders headers)
static java.lang.String	getSyntheticsHeader(com.newrelic.api.agent.InboundHeaders headers)
static java.lang.String	getTransactionHeader(com.newrelic.api.agent.InboundHeaders headers)
static void	parseAndAcceptDistributedTraceHeaders(Transaction tx, com.newrelic.api.agent.InboundHeaders inboundHeaders) parse headers from the inbound payload.
static void	setAppDataHeader(com.newrelic.api.agent.OutboundHeaders headers, java.lang.String value)
static void	setIdHeader(com.newrelic.api.agent.OutboundHeaders headers, java.lang.String crossProcessId) HeaderWrapper utility methods.
static void	setNewRelicTraceHeader(com.newrelic.api.agent.OutboundHeaders headers, java.lang.String value)
static void	setSyntheticsHeader(com.newrelic.api.agent.OutboundHeaders headers, java.lang.String value)
static void	setTraceParentHeader(com.newrelic.api.agent.OutboundHeaders headers, java.lang.String value)
static void	setTraceStateHeader(com.newrelic.api.agent.OutboundHeaders headers, java.lang.String value)
static void	setTransactionHeader(com.newrelic.api.agent.OutboundHeaders headers, java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

NEWRELIC_ID_HEADER

public static final java.lang.String NEWRELIC_ID_HEADER

The request header for storing our cross-process id in external calls.

See Also:

Constant Field Values

NEWRELIC_ID_MESSAGE_HEADER

public static final java.lang.String NEWRELIC_ID_MESSAGE_HEADER

See Also:

Constant Field Values

NEWRELIC_TRANSACTION_HEADER

public static final java.lang.String NEWRELIC_TRANSACTION_HEADER

The request header for storing our transaction id in external calls.

See Also:

Constant Field Values

NEWRELIC_TRANSACTION_MESSAGE_HEADER

public static final java.lang.String NEWRELIC_TRANSACTION_MESSAGE_HEADER

See Also:

Constant Field Values

NEWRELIC_APP_DATA_HEADER

public static final java.lang.String NEWRELIC_APP_DATA_HEADER

The response header for returning transaction data to clients.

See Also:

Constant Field Values

NEWRELIC_APP_DATA_MESSAGE_HEADER

public static final java.lang.String NEWRELIC_APP_DATA_MESSAGE_HEADER

See Also:

Constant Field Values

NEWRELIC_SYNTHETICS_HEADER

public static final java.lang.String NEWRELIC_SYNTHETICS_HEADER

The request header for tracing a transaction created by New Relic Synthetics

See Also:

Constant Field Values

NEWRELIC_SYNTHETICS_MESSAGE_HEADER

public static final java.lang.String NEWRELIC_SYNTHETICS_MESSAGE_HEADER

See Also:

Constant Field Values

NEWRELIC_TRACE_HEADER

public static final java.lang.String NEWRELIC_TRACE_HEADER

The request header for storing our distributed trace payloads.

See Also:

Constant Field Values

NEWRELIC_TRACE_MESSAGE_HEADER

public static final java.lang.String NEWRELIC_TRACE_MESSAGE_HEADER

See Also:

Constant Field Values

NEWRELIC_BAGGAGE_HEADER

public static final java.lang.String NEWRELIC_BAGGAGE_HEADER

The request header for storing distributed trace baggage.

See Also:

Constant Field Values

SYNTHETICS_MIN_VERSION

public static final int SYNTHETICS_MIN_VERSION

Minimum supported version of New Relic Synthetics protocol.

See Also:

Constant Field Values

SYNTHETICS_MAX_VERSION

public static final int SYNTHETICS_MAX_VERSION

Maximum supported version of New Relic Synthetics protocol.

See Also:

Constant Field Values

SYNTHETICS_VERSION_NONE

public static final int SYNTHETICS_VERSION_NONE

Value that can never appear as a Synthetics protocol version.

See Also:

Constant Field Values

NEWRELIC_HEADERS

public static final java.util.Set<java.lang.String> NEWRELIC_HEADERS

Constructor Detail

HeadersUtil

public HeadersUtil()

Method Detail

getIdHeader

public static java.lang.String getIdHeader(com.newrelic.api.agent.InboundHeaders headers)

getTransactionHeader

public static java.lang.String getTransactionHeader(com.newrelic.api.agent.InboundHeaders headers)

getAppDataHeader

public static java.lang.String getAppDataHeader(com.newrelic.api.agent.InboundHeaders headers)

getSyntheticsHeader

public static java.lang.String getSyntheticsHeader(com.newrelic.api.agent.InboundHeaders headers)

getNewRelicTraceHeader

public static java.lang.String getNewRelicTraceHeader(com.newrelic.api.agent.InboundHeaders headers)

setIdHeader

public static void setIdHeader(com.newrelic.api.agent.OutboundHeaders headers,
                               java.lang.String crossProcessId)

HeaderWrapper utility methods.

setTransactionHeader

public static void setTransactionHeader(com.newrelic.api.agent.OutboundHeaders headers,
                                        java.lang.String value)

setAppDataHeader

public static void setAppDataHeader(com.newrelic.api.agent.OutboundHeaders headers,
                                    java.lang.String value)

setSyntheticsHeader

public static void setSyntheticsHeader(com.newrelic.api.agent.OutboundHeaders headers,
                                       java.lang.String value)

setNewRelicTraceHeader

public static void setNewRelicTraceHeader(com.newrelic.api.agent.OutboundHeaders headers,
                                          java.lang.String value)

setTraceStateHeader

public static void setTraceStateHeader(com.newrelic.api.agent.OutboundHeaders headers,
                                       java.lang.String value)

setTraceParentHeader

public static void setTraceParentHeader(com.newrelic.api.agent.OutboundHeaders headers,
                                        java.lang.String value)

parseAndAcceptDistributedTraceHeaders

public static void parseAndAcceptDistributedTraceHeaders(Transaction tx,
                                                         com.newrelic.api.agent.InboundHeaders inboundHeaders)

parse headers from the inbound payload. It prioritizes trace context headers over newrelic headers. It then accepts the distributed trace payload if it was able to parse it from the headers.

Parameters:

tx - current transaction

inboundHeaders - the request headers containing the distributed trace payload

createAndSetDistributedTraceHeaders

public static boolean createAndSetDistributedTraceHeaders(Transaction tx,
                                                          com.newrelic.api.agent.TracedMethod tracedMethod,
                                                          com.newrelic.api.agent.OutboundHeaders headers)

creates new trace context distributed trace headers (and maybe new relic headers) and adds them to the headers object passed in

Parameters:

tx - current transaction

tracedMethod - the current traced method, used to grab the span id

headers - outbound headers where distributed trace headers will be added

Returns:

true if the headers were successfully added, false otherwise