Skip to content

add detailed error message for grpc exporter #5184

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

Closed
weizhikuan wants to merge 5 commits into from
+18 −5
Closed

add detailed error message for grpc exporter #5184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
edde670
add error message logging for grpc exporter
weizhikuan May 6, 2026
a2b1ec5
update changes
weizhikuan May 7, 2026
eacd78a
consolidate tests
weizhikuan May 8, 2026
4898ff4
update changelog
weizhikuan May 8, 2026
5eb0dec
add the empty line
weizhikuan May 8, 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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

- `opentelemetry-exporter-otlp-proto-grpc`: add detailed error message to the otlp grpc exporter
([#5184](https://github.com/open-telemetry/opentelemetry-python/pull/5184))
- Apply fixes for `UP` ruff rule
([#5133](https://github.com/open-telemetry/opentelemetry-python/pull/5133))
- Switch to SPDX license headers and add CI enforcement
Expand Down
10 changes: 8 additions & 2 deletions ...telemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,10 +507,13 @@ def _export(
or self._shutdown
):
logger.error(
"Failed to export %s to %s, error code: %s",
"Failed to export %s to %s, error code: %s%s",
self._exporting,
self._endpoint,
error.code(), # type: ignore [reportAttributeAccessIssue]
f", details: {error.details()}"
if error.details()
else "",
exc_info=error.code() == StatusCode.UNKNOWN, # type: ignore [reportAttributeAccessIssue]
)
result.error = error
Expand All @@ -519,11 +522,14 @@ def _export(
}
return self._result.FAILURE # type: ignore [reportReturnType]
logger.warning(
"Transient error %s encountered while exporting %s to %s, retrying in %.2fs.",
"Transient error %s encountered while exporting %s to %s, retrying in %.2fs.%s",
error.code(), # type: ignore [reportAttributeAccessIssue]
self._exporting,
self._endpoint,
backoff_seconds,
f" Details: {error.details()}"
if error.details()
else "",
)
shutdown = self._shutdown_in_progress.wait(backoff_seconds)
if shutdown:
Expand Down
11 changes: 8 additions & 3 deletions exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_exporter_mixin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,12 @@ def __init__(
export_result: StatusCode,
optional_retry_nanos: int | None = None,
optional_export_sleep: float | None = None,
optional_details: str | None = None,
):
self.export_result = export_result
self.optional_export_sleep = optional_export_sleep
self.optional_retry_nanos = optional_retry_nanos
self.optional_details = optional_details
self.num_requests = 0

# pylint: disable=invalid-name,unused-argument
Expand All @@ -132,6 +134,8 @@ def Export(self, request, context):
),
)
)
if self.optional_details:
context.set_details(self.optional_details)
context.set_code(self.export_result)

return ExportTraceServiceResponse()
Expand Down Expand Up @@ -589,7 +593,7 @@ def test_timeout_set_correctly(self):
)
after = time.time()
self.assertEqual(
"Failed to export traces to localhost:4317, error code: StatusCode.DEADLINE_EXCEEDED",
"Failed to export traces to localhost:4317, error code: StatusCode.DEADLINE_EXCEEDED, details: Deadline Exceeded",
warning.records[-1].message,
)
self.assertEqual(mock_trace_service.num_requests, 2)
Expand Down Expand Up @@ -617,7 +621,8 @@ def test_permanent_failure(self):
with self.assertLogs(level=WARNING) as warning:
add_TraceServiceServicer_to_server(
TraceServiceServicerWithExportParams(
StatusCode.ALREADY_EXISTS
StatusCode.ALREADY_EXISTS,
optional_details="resource already exists",
),
self.server,
)
Expand All @@ -626,7 +631,7 @@ def test_permanent_failure(self):
)
self.assertEqual(
warning.records[-1].message,
"Failed to export traces to localhost:4317, error code: StatusCode.ALREADY_EXISTS",
"Failed to export traces to localhost:4317, error code: StatusCode.ALREADY_EXISTS, details: resource already exists",
)

metrics_data = self.metric_reader.get_metrics_data()
Expand Down