Interface IOTelAttributeLimits

Configuration interface for OpenTelemetry attribute limits. These limits help control the size and number of attributes to prevent excessive memory usage and ensure consistent performance.

Example

const limits: IOTelAttributeLimits = {
  attributeCountLimit: 128,        // Maximum 128 attributes
  attributeValueLengthLimit: 4096  // Maximum 4KB per attribute value
};

Remarks

When limits are exceeded:

  • Additional attributes beyond attributeCountLimit are dropped
  • Attribute values longer than attributeValueLengthLimit are truncated
  • The behavior may vary based on the specific implementation

Since

3.4.0

interface IOTelAttributeLimits {
    attributeCountLimit?: number;
    attributeValueLengthLimit?: number;
}

Properties

attributeCountLimit? attributeValueLengthLimit?

Properties

OptionalattributeCountLimit

attributeCountLimit?: number

Maximum number of attributes allowed per telemetry item.

Remarks

  • Attributes added beyond this limit will be dropped
  • The order of attributes matters; earlier attributes take precedence
  • This limit applies to the total count of attributes, regardless of their type
  • Inherited or default attributes count toward this limit

Default Value

128

Example

// If attributeCountLimit is 5:
span.setAttributes({
  "attr1": "value1",  // Kept
  "attr2": "value2",  // Kept
  "attr3": "value3",  // Kept
  "attr4": "value4",  // Kept
  "attr5": "value5",  // Kept
  "attr6": "value6"   // Dropped (exceeds limit)
});

OptionalattributeValueLengthLimit

attributeValueLengthLimit?: number

Maximum allowed length for attribute values in characters.

Remarks

  • Values longer than this limit will be truncated
  • Applies to string attribute values only
  • Numeric and boolean values are not affected by this limit
  • Array values have this limit applied to each individual element

Default Value

4096

Example

// If attributeValueLengthLimit is 100:
span.setAttribute("description", "a".repeat(200)); // Will be truncated to 100 characters
span.setAttribute("count", 12345);                 // Not affected (number)
span.setAttribute("enabled", true);                // Not affected (boolean)

Settings

Member Visibility

On This Page

Properties