Interface Resource

An interface that represents a resource. A Resource describes the entity for which signals (metrics or trace) are collected.

This interface is NOT user-implementable. Valid ways to obtain a Resource are by using either of these functions

interface Resource {
    asyncAttributesPending?: boolean;
    attributes: Attributes;
    getRawAttributes(): RawResourceAttribute[];
    merge(other: null | Resource): Resource;
    waitForAsyncAttributes(): Promise<void>;
}

Properties

asyncAttributesPending? attributes

Methods

getRawAttributes merge waitForAsyncAttributes?

Properties

Optional ReadonlyasyncAttributesPending

asyncAttributesPending?: boolean

Check if async attributes have resolved. This is useful to avoid awaiting waitForAsyncAttributes (which will introduce asynchronous behavior) when not necessary.

Returns

true if the resource "attributes" property is not yet settled to its final value

Readonlyattributes

attributes: Attributes

Returns

the Resource's attributes.

Methods

getRawAttributes

merge

  • merge(other: null | Resource): Resource

    Returns a new, merged Resource by merging the current Resource with the other Resource. In case of a collision, other Resource takes precedence.

    Parameters

    • other: null | Resource

      the Resource that will be merged with this.

    Returns Resource

    the newly merged Resource.

OptionalwaitForAsyncAttributes

  • waitForAsyncAttributes(): Promise<void>

    Returns a promise that will never be rejected. Resolves when all async attributes have finished being added to this Resource's attributes. This is useful in exporters to block until resource detection has finished.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods