Skip to content

Commit

Permalink
fixup: casing note
Browse files Browse the repository at this point in the history
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
  • Loading branch information
toddbaert committed Dec 16, 2024
1 parent 2d44c6d commit 5dc802b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion specification/appendix-d-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ The following describes how fields on the [evaluation details](types.md#evaluati
| `error code` | `error.type` | See: [error code](./types.md#error-code) |
| `variant` | `feature_flag.variant` | See: [variant](./glossary.md#variant) |
| `error message` | `feature_flag.evaluation.error.message` | An error message associated with a failed evaluation |
| `reason` | `feature_flag.evaluation.reason` | See: [reason](./types.md#reason) |
| `reason` | `feature_flag.evaluation.reason` | See: [reason](./types.md#resolution-reason) |

> [!NOTE]
> The `error.type` and `feature_flag.evaluation.reason` enumerations use a lowercase "snake_case" convention (see [OpenTelemetry feature-flag log records](https://opentelemetry.io/docs/specs/semconv/feature-flags/feature-flags-logs/)).
> OpenFeature [error codes](types.md#error-code) and [resolution reasons](./types.md#resolution-reason) should be transformed accordingly by integrations which include this data.
### Flag Metadata

Expand All @@ -45,3 +49,4 @@ The following describes how keys in [flag metadata](types.md#flag-metadata) are
| Provider Metadata Field | Log Record Attribute | Notes |
| ----------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------ |
| `name` | `feature_flag.provider_name` | The name of the provider as defined in the `provider metadata`, available in the `hook context`. |
2 changes: 1 addition & 1 deletion specification/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ A structure which contains a subset of the fields defined in the `evaluation det
- variant (string, optional)
- flag metadata ([flag metadata](#flag-metadata), optional)

#### Reason
#### Resolution Reason

A set of pre-defined reasons is enumerated below:

Expand Down

0 comments on commit 5dc802b

Please sign in to comment.