-
Notifications
You must be signed in to change notification settings - Fork 77
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
Move TestExporter to avoid requiring pytest #368
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2439fdd
Move TestExporter to avoid requiring pytest
alexmojaki 5cbe1da
Update generated stubs
alexmojaki 2f08c3a
Release v0.50.1
alexmojaki 786dc09
Export TestExporter from logfire.testing
alexmojaki fcc2106
Skip redis tests in 3.8
alexmojaki File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| from __future__ import annotations | ||
|
|
||
| import os | ||
| import re | ||
| import sys | ||
| from collections.abc import Sequence | ||
| from pathlib import Path | ||
| from typing import Any, Mapping, cast | ||
|
|
||
| from opentelemetry import trace | ||
| from opentelemetry.sdk.trace import Event, ReadableSpan | ||
| from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult | ||
| from opentelemetry.semconv.resource import ResourceAttributes | ||
| from opentelemetry.semconv.trace import SpanAttributes | ||
|
|
||
| from ..constants import ATTRIBUTES_SPAN_TYPE_KEY, RESOURCE_ATTRIBUTES_PACKAGE_VERSIONS | ||
|
|
||
|
|
||
| class TestExporter(SpanExporter): | ||
| """A SpanExporter that stores exported spans in a list for asserting in tests.""" | ||
|
|
||
| # NOTE: Avoid test discovery by pytest. | ||
| __test__ = False | ||
|
|
||
| def __init__(self) -> None: | ||
| self.exported_spans: list[ReadableSpan] = [] | ||
|
|
||
| def export(self, spans: Sequence[ReadableSpan]) -> SpanExportResult: | ||
| """Exports a batch of telemetry data.""" | ||
| self.exported_spans.extend(spans) | ||
| return SpanExportResult.SUCCESS | ||
|
|
||
| def clear(self) -> None: | ||
| """Clears the collected spans.""" | ||
| self.exported_spans = [] | ||
|
|
||
| def exported_spans_as_dict( | ||
| self, | ||
| fixed_line_number: int | None = 123, | ||
| strip_filepaths: bool = True, | ||
| include_resources: bool = False, | ||
| include_package_versions: bool = False, | ||
| include_instrumentation_scope: bool = False, | ||
| _include_pending_spans: bool = False, | ||
| _strip_function_qualname: bool = True, | ||
| ) -> list[dict[str, Any]]: | ||
| """The exported spans as a list of dicts. | ||
|
|
||
| Args: | ||
| fixed_line_number: The line number to use for all spans. | ||
| strip_filepaths: Whether to strip the filepaths from the exported spans. | ||
| include_resources: Whether to include the resource attributes in the exported spans. | ||
| include_package_versions: Whether to include the package versions in the exported spans. | ||
| include_instrumentation_scope: Whether to include the instrumentation scope in the exported spans. | ||
|
|
||
| Returns: | ||
| A list of dicts representing the exported spans. | ||
| """ | ||
|
|
||
| def process_attribute(name: str, value: Any) -> Any: | ||
| if name == 'code.filepath' and strip_filepaths: | ||
| try: | ||
| return Path(value).name | ||
| except ValueError: # pragma: no cover | ||
| return value | ||
| if name == 'code.lineno' and fixed_line_number is not None: | ||
| return fixed_line_number | ||
| if name == 'code.function': | ||
| if sys.version_info >= (3, 11) and _strip_function_qualname: | ||
| return value.split('.')[-1] | ||
| if name == ResourceAttributes.PROCESS_PID: | ||
| assert value == os.getpid() | ||
| return 1234 | ||
| if name == ResourceAttributes.SERVICE_INSTANCE_ID: | ||
| if re.match(r'^[0-9a-f]{32}$', value): | ||
| return '0' * 32 | ||
| return value | ||
|
|
||
| def build_attributes(attributes: Mapping[str, Any] | None) -> dict[str, Any] | None: | ||
| if attributes is None: # pragma: no branch | ||
| return None # pragma: no cover | ||
| attributes = { | ||
| k: process_attribute(k, v) | ||
| for k, v in attributes.items() | ||
| if k != RESOURCE_ATTRIBUTES_PACKAGE_VERSIONS or include_package_versions | ||
| } | ||
| if 'telemetry.sdk.version' in attributes: | ||
| attributes['telemetry.sdk.version'] = '0.0.0' | ||
| return attributes | ||
|
|
||
| def build_event(event: Event) -> dict[str, Any]: | ||
| res: dict[str, Any] = { | ||
| 'name': event.name, | ||
| 'timestamp': event.timestamp, | ||
| } | ||
| if event.attributes: # pragma: no branch | ||
| res['attributes'] = attributes = dict(event.attributes) | ||
| if SpanAttributes.EXCEPTION_STACKTRACE in attributes: | ||
| last_line = next( # pragma: no branch | ||
| line.strip() | ||
| for line in reversed( | ||
| cast(str, event.attributes[SpanAttributes.EXCEPTION_STACKTRACE]).split('\n') | ||
| ) | ||
| if line.strip() | ||
| ) | ||
| attributes[SpanAttributes.EXCEPTION_STACKTRACE] = last_line | ||
| return res | ||
|
|
||
| def build_instrumentation_scope(span: ReadableSpan) -> dict[str, Any]: | ||
| if include_instrumentation_scope: | ||
| return {'instrumentation_scope': span.instrumentation_scope and span.instrumentation_scope.name} | ||
| else: | ||
| return {} | ||
|
|
||
| def build_span(span: ReadableSpan) -> dict[str, Any]: | ||
| context = span.context or trace.INVALID_SPAN_CONTEXT | ||
| res: dict[str, Any] = { | ||
| 'name': span.name, | ||
| 'context': { | ||
| 'trace_id': context.trace_id, | ||
| 'span_id': context.span_id, | ||
| 'is_remote': context.is_remote, | ||
| }, | ||
| 'parent': { | ||
| 'trace_id': span.parent.trace_id, | ||
| 'span_id': span.parent.span_id, | ||
| 'is_remote': span.parent.is_remote, | ||
| } | ||
| if span.parent | ||
| else None, | ||
| 'start_time': span.start_time, | ||
| 'end_time': span.end_time, | ||
| **build_instrumentation_scope(span), | ||
| 'attributes': build_attributes(span.attributes), | ||
| } | ||
| if span.events: | ||
| res['events'] = [build_event(event) for event in span.events] | ||
| if include_resources: | ||
| resource_attributes = build_attributes(span.resource.attributes) | ||
| res['resource'] = { | ||
| 'attributes': resource_attributes, | ||
| } | ||
| return res | ||
|
|
||
| spans = [build_span(span) for span in self.exported_spans] | ||
| return [ | ||
| span | ||
| for span in spans | ||
| if _include_pending_spans is True | ||
| or (span.get('attributes', {}).get(ATTRIBUTES_SPAN_TYPE_KEY, 'span') != 'pending_span') | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Kludex it's not critical but I don't know why there isn't a stub for
exporters.testwhen I runrye run generate-stubs. There's other stubs in theexportersfolder.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's because the
testingmodule is not in the__init__.py.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm talking about
logfire._internal.exporters.test, notlogfire.testingThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, because we don't include private objects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'd need to add
--include-privateon thestubgencommand for it to appear, I think...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But all the other internal exporter files are there