From 5dc802b3643817ae595c7238ca133a2de020aa8e Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Mon, 16 Dec 2024 15:09:03 -0500 Subject: [PATCH] fixup: casing note Signed-off-by: Todd Baert --- specification/appendix-d-observability.md | 7 ++++++- specification/types.md | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/specification/appendix-d-observability.md b/specification/appendix-d-observability.md index e63ca93d..d883b4f9 100644 --- a/specification/appendix-d-observability.md +++ b/specification/appendix-d-observability.md @@ -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 @@ -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`. | + \ No newline at end of file diff --git a/specification/types.md b/specification/types.md index 38524c3a..76009d37 100644 --- a/specification/types.md +++ b/specification/types.md @@ -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: