Skip to content

Update zipkin exporter status code and error tag #1486

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 11 commits into from
Dec 23, 2020
Merged

Update zipkin exporter status code and error tag #1486

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8176973
Update zipkin status code to error tag
srikanthccv Dec 16, 2020
eed4f16
Fix lint
srikanthccv Dec 16, 2020
11065b3
Update test to check OK code
srikanthccv Dec 16, 2020
5f4921b
Fix lint
srikanthccv Dec 16, 2020
032478f
Use .name for status code
srikanthccv Dec 16, 2020
21f537d
Add CHANGELOG entry
srikanthccv Dec 17, 2020
160ec1e
Move changelog entry to changed
srikanthccv Dec 17, 2020
eb26833
Merge branch 'master' into zipkin-status
lzchen Dec 17, 2020
c950961
Merge branch 'master' into zipkin-status
srikanthccv Dec 19, 2020
cf5b289
Merge branch 'master' into zipkin-status
Dec 21, 2020
9bd1a54
Merge branch 'master' into zipkin-status
Dec 22, 2020
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
28 changes: 17 additions & 11 deletions exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,10 @@

from opentelemetry.configuration import Configuration
from opentelemetry.exporter.zipkin.gen import zipkin_pb2
from opentelemetry.instrumentation.utils import status_code_to_str
from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
from opentelemetry.trace import Span, SpanContext, SpanKind
from opentelemetry.trace.status import StatusCode

TRANSPORT_FORMAT_JSON = "json"
TRANSPORT_FORMAT_PROTOBUF = "protobuf"
Expand Down Expand Up @@ -237,14 +239,14 @@ def _translate_to_json(self, spans: Sequence[Span]):
"otel.instrumentation_library.version"
] = span.instrumentation_info.version

if span.status is not None:
zipkin_span["tags"]["otel.status_code"] = str(
span.status.status_code.value
if span.status.status_code is not StatusCode.UNSET:
zipkin_span["tags"]["otel.status_code"] = status_code_to_str(
span.status.status_code
)
if span.status.description is not None:
zipkin_span["tags"][
"otel.status_description"
] = span.status.description
if span.status.status_code is StatusCode.ERROR:
zipkin_span["tags"]["error"] = (
span.status.description or ""
)

if context.trace_flags.sampled:
zipkin_span["debug"] = True
Expand Down Expand Up @@ -317,13 +319,17 @@ def _translate_to_protobuf(self, spans: Sequence[Span]):
}
)

if span.status is not None:
if span.status.status_code is not StatusCode.UNSET:
pbuf_span.tags.update(
{"otel.status_code": str(span.status.status_code.value)}
{
"otel.status_code": status_code_to_str(
span.status.status_code
)
}
)
if span.status.description is not None:
if span.status.status_code is StatusCode.ERROR:
pbuf_span.tags.update(
{"otel.status_description": span.status.description}
{"error": span.status.description or ""}
)

if context.trace_flags.sampled:
Expand Down
22 changes: 8 additions & 14 deletions exporter/opentelemetry-exporter-zipkin/tests/test_zipkin_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,8 @@ def test_export_json(self):
"key_bool": "False",
"key_string": "hello_world",
"key_float": "111.22",
"otel.status_code": "2",
"otel.status_description": "Example description",
"otel.status_code": "ERROR",
"error": "Example description",
},
"debug": True,
"parentId": format(parent_id, "x"),
Expand All @@ -272,10 +272,7 @@ def test_export_json(self):
"duration": durations[1] // 10 ** 3,
"localEndpoint": local_endpoint,
"kind": span_kind,
"tags": {
"key_resource": "some_resource",
"otel.status_code": "1",
},
"tags": {"key_resource": "some_resource"},
"annotations": None,
},
{
Expand All @@ -289,7 +286,6 @@ def test_export_json(self):
"tags": {
"key_string": "hello_world",
"key_resource": "some_resource",
"otel.status_code": "1",
},
"annotations": None,
},
Expand All @@ -304,7 +300,6 @@ def test_export_json(self):
"tags": {
"otel.instrumentation_library.name": "name",
"otel.instrumentation_library.version": "version",
"otel.status_code": "1",
},
"annotations": None,
},
Expand Down Expand Up @@ -383,7 +378,7 @@ def test_export_json_zero_padding(self):
"duration": duration // 10 ** 3,
"localEndpoint": local_endpoint,
"kind": SPAN_KIND_MAP_JSON[SpanKind.INTERNAL],
"tags": {"otel.status_code": "1"},
"tags": {},
"annotations": None,
"debug": True,
"parentId": "0aaaaaaaaaaaaaaa",
Expand Down Expand Up @@ -737,6 +732,7 @@ def test_export_protobuf(self):
otel_spans[1].resource = Resource(
attributes={"key_resource": "some_resource"}
)
otel_spans[1].set_status(Status(StatusCode.OK))
otel_spans[1].end(end_time=end_times[1])

otel_spans[2].start(start_time=start_times[2])
Expand Down Expand Up @@ -775,8 +771,8 @@ def test_export_protobuf(self):
"key_bool": "False",
"key_string": "hello_world",
"key_float": "111.22",
"otel.status_code": "2",
"otel.status_description": "Example description",
"otel.status_code": "ERROR",
"error": "Example description",
},
debug=True,
parent_id=ZipkinSpanExporter.format_pbuf_span_id(
Expand Down Expand Up @@ -809,7 +805,7 @@ def test_export_protobuf(self):
kind=span_kind,
tags={
"key_resource": "some_resource",
"otel.status_code": "1",
"otel.status_code": "OK",
},
),
zipkin_pb2.Span(
Expand All @@ -825,7 +821,6 @@ def test_export_protobuf(self):
tags={
"key_string": "hello_world",
"key_resource": "some_resource",
"otel.status_code": "1",
},
),
zipkin_pb2.Span(
Expand All @@ -841,7 +836,6 @@ def test_export_protobuf(self):
tags={
"otel.instrumentation_library.name": "name",
"otel.instrumentation_library.version": "version",
"otel.status_code": "1",
},
),
],
Expand Down
10 changes: 10 additions & 0 deletions opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@

from opentelemetry.trace.status import StatusCode

CODE_TO_STR = {
StatusCode.UNSET: "UNSET",
StatusCode.OK: "OK",
StatusCode.ERROR: "ERROR",
}


def extract_attributes_from_object(
obj: any, attributes: Sequence[str], existing: Dict[str, str] = None
Expand Down Expand Up @@ -81,3 +87,7 @@ def unwrap(obj, attr: str):
func = getattr(obj, attr, None)
if func and isinstance(func, ObjectProxy) and hasattr(func, "__wrapped__"):
setattr(obj, attr, func.__wrapped__)


def status_code_to_str(code: StatusCode) -> str:
return CODE_TO_STR[code]