MessageSpec

Spec that describes how to instrument a message broker.

Constructor

new MessageSpec(params)

Parameters:
NameTypeDescription
paramsMessageSpecParams
Source

Members

destinationName :number|string|null

If a number, then it indicates the argument position of the name in the instrumented function's parameters list. Otherwise, it is a string name.

Type:
  • number | string | null
Source

destinationType :string|null

Label indicating what type of message broker is being instrumented.

Type:
  • string | null
Source
See
  • {MessageShimTypes}

headers :Object.<string, string>|null

Headers to insert into the request being instrumented.

Type:
  • Object.<string, string> | null
Source

messageHandler :MessageHandlerFunction

A function to handle the result of the instrumented message broker function.

Type:
Source

messageHeaders :MessageBrokerHeadersFn

Function that returns an iterable set of message header objects. The header objects will be modified to include distributed tracing headers so that they will be included in the payloads delivered, and read from, the message broker.

Type:
Source

queue :number|string|null

When a number, indicates the argument position of the message queue in the instrumented function's arguments list. Otherwise, it is a string representing the name of the queue.

Type:
  • number | string | null
Source

routingKey :string|null

The name of the key that provides the routing path for the message broker.

Type:
  • string | null
Source