Variable TelemetryAttributeConst

TelemetryAttribute: {
    CONTEXT_ID: "feature_flag.context.id";
    ERROR_CODE: "error.type";
    ERROR_MESSAGE: "feature_flag.evaluation.error.message";
    FLAG_SET_ID: "feature_flag.set.id";
    KEY: "feature_flag.key";
    PROVIDER: "feature_flag.provider_name";
    REASON: "feature_flag.evaluation.reason";
    VARIANT: "feature_flag.variant";
    VERSION: "feature_flag.version";
} = ...

The attributes of an OpenTelemetry compliant event for flag evaluation.

Type declaration

  • ReadonlyCONTEXT_ID: "feature_flag.context.id"

    The unique identifier for the flag evaluation context. For example, the targeting key.

    • type: string
    • requirement level: recommended
    • example: 5157782b-2203-4c80-a857-dbbd5e7761db
  • ReadonlyERROR_CODE: "error.type"

    Describes a class of error the operation ended with.

    • type: string
    • requirement level: conditionally required
    • condition: reason is error
    • example: flag_not_found
  • ReadonlyERROR_MESSAGE: "feature_flag.evaluation.error.message"

    A message explaining the nature of an error occurring during flag evaluation.

    • type: string
    • requirement level: recommended
    • example: Flag not found
  • ReadonlyFLAG_SET_ID: "feature_flag.set.id"

    The identifier of the flag set to which the feature flag belongs.

    • type: string
    • requirement level: recommended
    • example: proj-1; ab98sgs; service1/dev
  • ReadonlyKEY: "feature_flag.key"

    The lookup key of the feature flag.

    • type: string
    • requirement level: required
    • example: logo-color
  • ReadonlyPROVIDER: "feature_flag.provider_name"

    Describes a class of error the operation ended with.

    • type: string
    • requirement level: recommended
    • example: flag_not_found
  • ReadonlyREASON: "feature_flag.evaluation.reason"

    The reason code which shows how a feature flag value was determined.

    • type: string
    • requirement level: recommended
    • example: targeting_match
  • ReadonlyVARIANT: "feature_flag.variant"

    A semantic identifier for an evaluated flag value.

    • type: string
    • requirement level: conditionally required
    • condition: variant is defined on the evaluation details
    • example: blue; on; true
  • ReadonlyVERSION: "feature_flag.version"

    The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset.

    • type: string
    • requirement level: recommended
    • example: 1.0.0; 2021-01-01