Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Flag evaluation event #1440

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

dyladan
Copy link
Member

@dyladan dyladan commented Sep 30, 2024

First draft of feature_flag.evaluation event from the feature flag semantic conventions working group. Based on proposal here: https://docs.google.com/document/d/1sBDD-uifx-Qy0NxtwRcrRAQ48sHQS9dTp6tpArQsoZg/edit

Summary of changes:

  • Replace feature_flag.provider_name with feature_flag.provider.id
  • Rename feature_flag to feature_flag.evaluation
  • Add attributes to feature_flag.evaluation
    • feature_flag.context.id
    • feature_flag.environment.id
    • feature_flag.value
    • feature_flag.version
  • Remove feature flag span event

Copy link

@askpt askpt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a couple of comments; otherwise, it looks good.

@@ -10,7 +10,7 @@ groups:
stability: experimental
brief: The unique identifier of the feature flag.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, I suggested to rename to "The lookup key of the feature flag."

@@ -10,7 +10,7 @@ groups:
stability: experimental
brief: The unique identifier of the feature flag.
examples: ["logo-color"]
- id: feature_flag.provider_name
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest leaving this open. Using an "id" means it is "blocked" only to use IDs, and we can potentially use it for names or other semantically valid values.
I would allow you to use the following examples:
["provider-1", "guid_here", "provider-v1"]

Comment on lines +52 to +57
- id: feature_flag.environment.id
type: string
stability: experimental
examples: ["proj-1", "ab98sgs"]
brief: >
The identifier of the environment which the feature flag belongs to in a flag management system.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- id: feature_flag.environment.id
type: string
stability: experimental
examples: ["proj-1", "ab98sgs"]
brief: >
The identifier of the environment which the feature flag belongs to in a flag management system.
- id: feature_flag.flag_set.id
type: string
stability: experimental
examples: ["proj-1", "ab98sgs", "service1/dev"]
brief: >
The identifier of the flag set, which the feature flag belongs to in a flag management system.

A flag set is defined here as `A collection of related flags. This grouping helps organize feature flags based on their intended use, facilitating easier management and deployment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants