Skip to content

fix: Align TracingHook with spec #342

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

Open
danjuv wants to merge 4 commits into
base: main
Choose a base branch
from
+68 −6
Open

fix: Align TracingHook with spec #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4af8e95
refactor: move after logic to finally_after so evaluation span is cre…
danjuv Feb 7, 2026
8706459
feat: optionally disable exceptions on evaluation errors
danjuv Feb 8, 2026
3188c34
fix: add provider metadata to hook exception
danjuv Feb 11, 2026
bf464a7
chore: given/when/then comments
danjuv Feb 11, 2026
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
15 changes: 13 additions & 2 deletions hooks/openfeature-hooks-opentelemetry/src/openfeature/contrib/hook/opentelemetry/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ class EventAttributes:


class TracingHook(Hook):
def after(
def __init__(self, exclude_exceptions: bool = False):
self.exclude_exceptions = exclude_exceptions

def finally_after(
self,
hook_context: HookContext,
details: FlagEvaluationDetails,
Expand Down Expand Up @@ -60,5 +63,13 @@ def after(
def error(
self, hook_context: HookContext, exception: Exception, hints: HookHints
) -> None:
if self.exclude_exceptions:
return
attributes = {
EventAttributes.KEY: hook_context.flag_key,
EventAttributes.RESULT_VALUE: json.dumps(hook_context.default_value),
}
Comment on lines +68 to +71
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 9, 2026

Choose a reason for hiding this comment

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

medium

To better align with the OpenFeature specification, feature_flag.provider_name should be included in the attributes for an error event when available. This change will also require updating test_error to include provider_metadata in the HookContext and assert this new attribute.

Suggested change
attributes = {
EventAttributes.KEY: hook_context.flag_key,
EventAttributes.RESULT_VALUE: json.dumps(hook_context.default_value),
}
attributes = {
EventAttributes.KEY: hook_context.flag_key,
EventAttributes.RESULT_VALUE: json.dumps(hook_context.default_value),
}
if hook_context.provider_metadata:
attributes[EventAttributes.PROVIDER_NAME] = (
hook_context.provider_metadata.name
)

Copy link
Member

@toddbaert toddbaert Feb 11, 2026

Choose a reason for hiding this comment

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

@danjuv I believe this is correct.

Copy link
Author

@danjuv danjuv Feb 11, 2026

Choose a reason for hiding this comment

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

@toddbaert @federicobond updated

if hook_context.provider_metadata:
attributes[EventAttributes.PROVIDER_NAME] = hook_context.provider_metadata.name
current_span = trace.get_current_span()
current_span.record_exception(exception)
current_span.record_exception(exception, attributes)
59 changes: 55 additions & 4 deletions hooks/openfeature-hooks-opentelemetry/tests/test_otel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@
from openfeature.provider.metadata import Metadata




@pytest.fixture
def mock_get_current_span(monkeypatch):
monkeypatch.setattr(trace, "get_current_span", Mock())


def test_after(mock_get_current_span):
def test_finally_after(mock_get_current_span):
# Given
hook = TracingHook()
hook_context = HookContext(
Expand All @@ -40,7 +42,7 @@ def test_after(mock_get_current_span):
trace.get_current_span.return_value = mock_span

# When
hook.after(hook_context, details, hints={})
hook.finally_after(hook_context, details, hints={})

# Then
mock_span.add_event.assert_called_once_with(
Expand Down Expand Up @@ -79,7 +81,7 @@ def test_after_evaluation_error(mock_get_current_span):
trace.get_current_span.return_value = mock_span

# When
hook.after(hook_context, details, hints={})
hook.finally_after(hook_context, details, hints={})

# Then
mock_span.add_event.assert_called_once_with(
Expand All @@ -102,8 +104,14 @@ def test_error(mock_get_current_span):
flag_type=FlagType.BOOLEAN,
default_value=False,
evaluation_context=EvaluationContext(),
provider_metadata=Metadata(name="test-provider"),
)
exception = Exception()
attributes = {
"feature_flag.key": "flag_key",
"feature_flag.result.value": "false",
"feature_flag.provider.name": "test-provider",
}

mock_span = Mock(spec=Span)
trace.get_current_span.return_value = mock_span
Expand All @@ -112,4 +120,47 @@ def test_error(mock_get_current_span):
hook.error(hook_context, exception, hints={})

# Then
mock_span.record_exception.assert_called_once_with(exception)
mock_span.record_exception.assert_called_once_with(exception, attributes)

def test_error_exclude_exceptions(mock_get_current_span):
# Given
hook = TracingHook(exclude_exceptions=True)
hook_context = HookContext(
flag_key="flag_key",
flag_type=FlagType.BOOLEAN,
default_value=False,
evaluation_context=EvaluationContext(),
)
exception = Exception()

mock_span = Mock(spec=Span)
trace.get_current_span.return_value = mock_span

# When
hook.error(hook_context, exception, hints={})
# Then
mock_span.record_exception.assert_not_called()


def test_error_no_provider_metadata(mock_get_current_span):
# Given
hook = TracingHook()
hook_context = HookContext(
flag_key="flag_key",
flag_type=FlagType.BOOLEAN,
default_value=False,
evaluation_context=EvaluationContext(),
)
exception = Exception()
attributes = {
"feature_flag.key": "flag_key",
"feature_flag.result.value": "false",
}

mock_span = Mock(spec=Span)
trace.get_current_span.return_value = mock_span

# When
hook.error(hook_context, exception, hints={})
# Then
mock_span.record_exception.assert_called_once_with(exception, attributes)