You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Conventions for OpenFeature telemetry signals
4
+
description: Conventions for OpenFeature telemetry signals
5
5
sidebar_position: 5
6
6
---
7
7
8
8
# Appendix D: Observability
9
9
10
10
This document describes conventions for extracting data from the OpenFeature SDK for use in telemetry signals.
11
-
It primarily focuses on providing recommendations for mapping well-known fields in OpenFeature to [OpenTelemetry feature-flag log records][otel-ff-logs] and other semantic conventions.
11
+
It primarily focuses on providing recommendations for mapping well-known fields in OpenFeature to [OpenTelemetry feature-flag event records][otel-ff-events] and other semantic conventions.
12
12
13
13
## Evaluations
14
14
@@ -17,9 +17,9 @@ This is particularly relevant to telemetry-related [hooks](./sections/04-hooks.m
17
17
18
18
### Evaluation Details
19
19
20
-
The following describes how fields on the [evaluation details](types.md#evaluation-details) are mapped to feature flag log records:
20
+
The following describes how fields on the [evaluation details](types.md#evaluation-details) are mapped to feature flag event records:
21
21
22
-
|Log Record Attribute | Source Field or Derived Value from Evaluation Details | Requirement level | Type | Notes |
22
+
|Event Record Attribute | Source Field or Derived Value from Evaluation Details | Requirement level | Type | Notes |
@@ -29,14 +29,14 @@ The following describes how fields on the [evaluation details](types.md#evaluati
29
29
|`error.message`|`error message`|`Conditionally Required`[^3]|`string`| A human-readable error message associated with a failed evaluation. For programmatic purposes, refer to `error code`. |
30
30
31
31
> [!NOTE]
32
-
> The `error.type` and `feature_flag.result.reason` enumerations use a lowercase "snake_case" convention (see [OpenTelemetry feature-flag log records][otel-ff-logs]).
32
+
> The `error.type` and `feature_flag.result.reason` enumerations use a lowercase "snake_case" convention (see [OpenTelemetry feature-flag event records][otel-ff-events]).
33
33
> OpenFeature [error codes](types.md#error-code) and [resolution reasons](./types.md#resolution-reason) should be transformed accordingly by integrations which include this data.
34
34
35
35
### Flag Metadata
36
36
37
-
The following describes how keys in [flag metadata](types.md#flag-metadata) are mapped to feature flag log records:
37
+
The following describes how keys in [flag metadata](types.md#flag-metadata) are mapped to feature flag event records:
38
38
39
-
|Log Record Attribute | Flag Metadata Key | Requirement level | Type | Notes |
39
+
|Event Record Attribute | Flag Metadata Key | Requirement level | Type | Notes |
|`feature_flag.context.id`|`contextId`|`Recommended`|`string`| The context identifier returned in the flag metadata uniquely identifies the subject of the flag evaluation. If not available, the [targeting key](./glossary.md#targeting-key) should be used. |
42
42
|`feature_flag.set.id`|`flagSetId`|`Recommended`|`string`| A logical identifier for the [flag set](./glossary.md#flag-set). |
@@ -47,14 +47,14 @@ The following describes how keys in [flag metadata](types.md#flag-metadata) are
47
47
48
48
### Provider Metadata
49
49
50
-
|Log Record Attribute | Provider Metadata Field | Requirement level | Type | Notes |
50
+
|Event Record Attribute | Provider Metadata Field | Requirement level | Type | Notes |
|`feature_flag.provider.name`|`name`|`Recommended`|`string`| The name of the provider as defined in the `provider metadata`, available in the `hook context`. |
53
53
54
54
## History
55
55
56
56
Feature flags in the OpenTelemetry semantic conventions are currently in development and are marked as experimental.
57
-
The following table describes the history of changes to the OpenTelemetry feature flag log records as it progresses towards a stable release.
57
+
The following table describes the history of changes to the OpenTelemetry feature flag event records as it progresses towards a stable release.
58
58
59
59
| Original Field Name | New Field Name | Semantic Convention Release |
@@ -67,7 +67,7 @@ The following table describes the history of changes to the OpenTelemetry featur
67
67
## Footnotes
68
68
69
69
[^1]: The `variant` field should be included whenever possible as it represents the symbolic name of the flag's returned value (e.g., "on"/"off", "control"/"treatment"). Only omit if the provider doesn't supply this information.
70
-
[^2]: The `value` field should be included whenever a `variant` is unavailable. Large or sensitive values should be redacted or omitted prior to being captured in telemetry signals.
70
+
[^2]: The `value` field is required when a `variant` is not available, and recommended when it is. Considerations should be made for large and/or sensitive values, which should be redacted or omitted prior to being captured in telemetry signals.
71
71
[^3]: Include `error.type` and `error.message`, if and only if an error occurred during a flag evaluation.
0 commit comments