Interface Baggage

Baggage represents collection of key-value pairs with optional metadata. Each key of Baggage is associated with exactly one value. Baggage may be used to annotate and enrich telemetry data.

Since

1.0.0

interface Baggage {
    clear(): @opentelemetry/api.Baggage;
    getAllEntries(): [string, @opentelemetry/api.BaggageEntry][];
    getEntry(key: string): @opentelemetry/api.BaggageEntry | undefined;
    removeEntries(...key: string[]): @opentelemetry/api.Baggage;
    removeEntry(key: string): @opentelemetry/api.Baggage;
    setEntry(
        key: string,
        entry: @opentelemetry/api.BaggageEntry,
    ): @opentelemetry/api.Baggage;
}

Index

Methods

clear getAllEntries getEntry removeEntries removeEntry setEntry

Methods

clear

clear(): @opentelemetry/api.Baggage
Returns a new baggage with no entries

Returns @opentelemetry/api.Baggage
- Defined in api/build/src/baggage/types.d.ts:65

getAllEntries

getAllEntries(): [string, @opentelemetry/api.BaggageEntry][]
Get a list of all entries in the Baggage

Returns [string, @opentelemetry/api.BaggageEntry][]
- Defined in api/build/src/baggage/types.d.ts:42

getEntry

getEntry(key: string): @opentelemetry/api.BaggageEntry | undefined
Get an entry from Baggage if it exists
Parameters
- key: string
  The key which identifies the BaggageEntry
Returns @opentelemetry/api.BaggageEntry | undefined
- Defined in api/build/src/baggage/types.d.ts:38

removeEntries

removeEntries(...key: string[]): @opentelemetry/api.Baggage
Returns a new baggage with the entries from the current bag except the removed entries
Parameters
- ...key: string[]
  keys identifying the entries to be removed
Returns @opentelemetry/api.Baggage
- Defined in api/build/src/baggage/types.d.ts:61

removeEntry

removeEntry(key: string): @opentelemetry/api.Baggage
Returns a new baggage with the entries from the current bag except the removed entry
Parameters
- key: string
  key identifying the entry to be removed
Returns @opentelemetry/api.Baggage
- Defined in api/build/src/baggage/types.d.ts:55

setEntry

setEntry(
key: string,
entry: @opentelemetry/api.BaggageEntry,
): @opentelemetry/api.Baggage
Returns a new baggage with the entries from the current bag and the specified entry
Parameters
- key: string
  string which identifies the baggage entry
- entry: @opentelemetry/api.BaggageEntry
  BaggageEntry for the given key
Returns @opentelemetry/api.Baggage
- Defined in api/build/src/baggage/types.d.ts:49