From fcbbf2ab43dfbae723eb1558d88271703f340911 Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Mon, 16 Dec 2024 14:12:41 -0500 Subject: [PATCH] feat: add appendix D (observability) Signed-off-by: Todd Baert --- specification/README.md | 3 ++ specification/appendix-d-observability.md | 50 +++++++++++++++++++++++ specification/types.md | 2 + 3 files changed, 55 insertions(+) create mode 100644 specification/appendix-d-observability.md diff --git a/specification/README.md b/specification/README.md index eacc107e..50a2862a 100644 --- a/specification/README.md +++ b/specification/README.md @@ -16,8 +16,11 @@ sidebar_position: 0 - [Evaluation Context](./sections/03-evaluation-context.md) - [Hooks](./sections/04-hooks.md) - [Events](./sections/05-events.md) +- [Tracking](./sections/06-tracking.md) - [Appendix A: Included Utilities](./appendix-a-included-utilities.md) - [Appendix B: Gherkin Suites](./appendix-b-gherkin-suites.md) +- [Appendix C: OFREP](./appendix-c-ofrep.md) +- [Appendix D: Observability](./appendix-d-observability.md) ## Conformance diff --git a/specification/appendix-d-observability.md b/specification/appendix-d-observability.md new file mode 100644 index 00000000..3d4aac51 --- /dev/null +++ b/specification/appendix-d-observability.md @@ -0,0 +1,50 @@ +--- +id: appendix-d +title: "Appendix D: Observability" +description: Conventions for OpenFeature telemetry signals +sidebar_position: 5 +--- + +# Appendix D: Observability + +This document describes conventions for extracting data from the OpenFeature SDK for use in telemetry signals. +It primarily focuses on providing recommendations for mapping well-known fields in OpenFeature to [OpenTelemetry feature-flag log records](https://opentelemetry.io/docs/specs/semconv/feature-flags/feature-flags-logs/) and other semantic conventions. + +## Evaluations + +Flag evaluation telemetry comprises data resolved from the provider resolution (evaluation details and flag metadata) as well as metadata about the provider itself. +This is particularly relevant to telemetry-related [hooks](./sections/04-hooks.md). + +### Evaluation Details + +The following describes how fields on the [evaluation details](types.md#evaluation-details) are mapped to feature flag log records: + +| Evaluation Details Field | Log Record Attribute | Notes | +| ------------------------ | --------------------------------------- | ---------------------------------------------------- | +| `flag key` | `feature_flag.key` | See: [flag key](./glossary.md#flag-key) | +| `error code` | `error.type` | See: [error code](./types.md#error-code) | +| `variant`, `value` | `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) | + +> [!NOTE] +> If the provider in question doesn't supply a `variant`, the a string representation of the `value` is used. + +### Flag Metadata + +The following describes how keys in [flag metadata](types.md#flag-metadata) are mapped to feature flag log records: + +| Flag Metadata Key | Log Record Attribute | Notes | +| ----------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contextId` | `feature_flag.context.id` | 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. | +| `flagSetId` | `feature_flag.set.id` | A logical identifier for the [flag set](./glossary.md#flag-set). | +| `flagSetVersion` | `feature_flag.version` | A version string (format unspecified) for the [flag set](./glossary.md#flag-set). | + +> [!NOTE] +> Keys in flag metadata use the "camelCase" casing convention, while the OpenTelemetry standard uses a namespaced "snake_case" convention. + +### Provider Metadata + +| 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`. | diff --git a/specification/types.md b/specification/types.md index b434bfd6..38524c3a 100644 --- a/specification/types.md +++ b/specification/types.md @@ -58,6 +58,8 @@ 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 + A set of pre-defined reasons is enumerated below: | Reason | Explanation |