Skip to content

fix: make OTEL evaluation event attribute types compliant to OTEL types #1237

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Sep 26, 2025
Merged

fix: make OTEL evaluation event attribute types compliant to OTEL types #1237

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d421421
fix: make OTEL evaluation event attribute types compliant to OTEL types
lukas-reining Sep 12, 2025
bdf3e68
fix: remove condition for value
lukas-reining Sep 12, 2025
24ac338
fix: test
lukas-reining Sep 12, 2025
6d01a06
fix: add test for object serialization
lukas-reining Sep 12, 2025
81c480f
Update evaluation-event.ts
lukas-reining Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions packages/shared/src/telemetry/evaluation-event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
import { ErrorCode, StandardResolutionReasons, type EvaluationDetails, type FlagValue } from '../evaluation/evaluation';
import type { HookContext } from '../hooks/hooks';
import { ErrorCode, StandardResolutionReasons, type EvaluationDetails, type FlagValue } from '../evaluation';
import type { HookContext } from '../hooks';
import { TelemetryAttribute } from './attributes';
import { TelemetryFlagMetadata } from './flag-metadata';

/**
* Attribute types for OpenTelemetry.
* @see https://github.com/open-telemetry/opentelemetry-js/blob/fbbce6e1c0de86e4c504b5788d876fae4d3bc254/api/src/common/Attributes.ts#L35
*/
export declare type AttributeValue =
| string
| number
| boolean
| Array<null | undefined | string>
| Array<null | undefined | number>
| Array<null | undefined | boolean>;

type EvaluationEvent = {
/**
* The name of the feature flag evaluation event.
Expand All @@ -13,7 +25,7 @@ type EvaluationEvent = {
* @experimental The attributes are subject to change.
* @see https://opentelemetry.io/docs/specs/semconv/feature-flags/feature-flags-logs/
*/
attributes: Record<string, string | number | boolean | FlagValue>;
attributes: Record<string, AttributeValue | undefined>;
};

const FLAG_EVALUATION_EVENT_NAME = 'feature_flag.evaluation';
Expand All @@ -36,12 +48,23 @@ export function createEvaluationEvent(

if (evaluationDetails.variant) {
attributes[TelemetryAttribute.VARIANT] = evaluationDetails.variant;
} else {
attributes[TelemetryAttribute.VALUE] = evaluationDetails.value;
}

if (evaluationDetails.value !== null) {
if (typeof evaluationDetails.value !== 'object') {
attributes[TelemetryAttribute.VALUE] = evaluationDetails.value;
} else {
try {
// Objects are not valid attribute values, so we convert them to a JSON string
attributes[TelemetryAttribute.VALUE] = JSON.stringify(evaluationDetails.value);
} catch {
// We ignore non serializable values
}
}
}

const contextId =
evaluationDetails.flagMetadata[TelemetryFlagMetadata.CONTEXT_ID] || hookContext.context.targetingKey;
evaluationDetails.flagMetadata[TelemetryFlagMetadata.CONTEXT_ID] ?? hookContext.context.targetingKey;
if (contextId) {
attributes[TelemetryAttribute.CONTEXT_ID] = contextId;
}
Expand Down
Loading