Skip to content

Fix User-Agent header value for OTLP exporters #3128

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 14 commits into from
Jan 24, 2023
Merged

Fix User-Agent header value for OTLP exporters #3128

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
7fce9b8
Update values as required for issue
keithkroeger Jan 10, 2023
fdede26
add CHANGED_FILES link
keithkroeger Jan 10, 2023
3119ae0
update changelog
keithkroeger Jan 10, 2023
322ebef
update test to validate setting
keithkroeger Jan 11, 2023
cf07436
update only oltp exporter
keithkroeger Jan 11, 2023
08990d1
update grpc exporter
keithkroeger Jan 11, 2023
fc094e0
Merge branch 'main' into fidelity-20230110-102534
keithkroeger Jan 13, 2023
7411ae2
Update CHANGELOG.md
keithkroeger Jan 14, 2023
1e0dc14
remove CHANGED_FILES#
keithkroeger Jan 16, 2023
70ec055
Merge branch 'fidelity-20230110-102534' of https://github.com/fidelit…
keithkroeger Jan 16, 2023
104a44c
Merge branch 'main' into fidelity-20230110-102534
keithkroeger Jan 18, 2023
8d6af74
update location of imports for linting
keithkroeger Jan 21, 2023
c724bf7
resolve conflict in CHANGELOG
keithkroeger Jan 21, 2023
6a2df47
Merge branch 'main' into fidelity-20230110-102534
keithkroeger Jan 23, 2023
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add db metric name to semantic conventions
([#3115](https://github.com/open-telemetry/opentelemetry-python/pull/3115))

- Fix User-Agent header value for OTLP exporters to conform to RFC7231 & RFC7230
([#3128](https://github.com/open-telemetry/opentelemetry-python/pull/3128))

## Version 1.15.0/0.36b0 (2022-12-09)

- Regenerate opentelemetry-proto to be compatible with protobuf 3 and 4
Expand Down
2 changes: 1 addition & 1 deletion ...telemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,5 @@
"""
from .version import __version__

_USER_AGENT_HEADER_VALUE = "OTel OTLP Exporter Python/" + __version__
_USER_AGENT_HEADER_VALUE = "OTel-OTLP-Exporter-Python/" + __version__
_OTLP_GRPC_HEADERS = [("user-agent", _USER_AGENT_HEADER_VALUE)]
2 changes: 1 addition & 1 deletion exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ def test_otlp_headers_from_env(self):
# pylint: disable=protected-access
self.assertEqual(
self.exporter._headers,
(("user-agent", "OTel OTLP Exporter Python/" + __version__),),
(("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),),
)

@patch("opentelemetry.exporter.otlp.proto.grpc.exporter._expo")
Expand Down
4 changes: 2 additions & 2 deletions exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_metrics_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
(
("key1", "value1"),
("key2", "VALUE=2"),
("user-agent", "OTel OTLP Exporter Python/" + __version__),
("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
),
)
exporter = OTLPMetricExporter(
Expand All @@ -430,7 +430,7 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
(
("key3", "value3"),
("key4", "value4"),
("user-agent", "OTel OTLP Exporter Python/" + __version__),
("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
),
)

Expand Down
8 changes: 4 additions & 4 deletions exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_trace_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
(
("key1", "value1"),
("key2", "VALUE=2"),
("user-agent", "OTel OTLP Exporter Python/" + __version__),
("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
),
)
exporter = OTLPSpanExporter(
Expand All @@ -293,7 +293,7 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
(
("key3", "value3"),
("key4", "value4"),
("user-agent", "OTel OTLP Exporter Python/" + __version__),
("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
),
)
exporter = OTLPSpanExporter(
Expand All @@ -305,7 +305,7 @@ def test_otlp_headers_from_env(self, mock_ssl_channel, mock_secure):
(
("key5", "value5"),
("key6", "value6"),
("user-agent", "OTel OTLP Exporter Python/" + __version__),
("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),
),
)

Expand Down Expand Up @@ -454,7 +454,7 @@ def test_otlp_headers(self, mock_ssl_channel, mock_secure):
# This ensures that there is no other header than standard user-agent.
self.assertEqual(
exporter._headers,
(("user-agent", "OTel OTLP Exporter Python/" + __version__),),
(("user-agent", "OTel-OTLP-Exporter-Python/" + __version__),),
)

@patch("opentelemetry.exporter.otlp.proto.grpc.exporter.backoff")
Expand Down
2 changes: 1 addition & 1 deletion ...telemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@

_OTLP_HTTP_HEADERS = {
"Content-Type": "application/x-protobuf",
"User-Agent": "OTel OTLP Exporter Python/" + __version__,
"User-Agent": "OTel-OTLP-Exporter-Python/" + __version__,
}


Expand Down
5 changes: 5 additions & 0 deletions exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import responses

from opentelemetry._logs import SeverityNumber
from opentelemetry.exporter.otlp.proto.http.version import __version__
from opentelemetry.exporter.otlp.proto.http import Compression
from opentelemetry.exporter.otlp.proto.http._log_exporter import (
DEFAULT_COMPRESSION,
Expand Down Expand Up @@ -96,6 +97,10 @@ def test_constructor_default(self):
exporter._session.headers.get("Content-Type"),
"application/x-protobuf",
)
self.assertEqual(
exporter._session.headers.get("User-Agent"),
"OTel-OTLP-Exporter-Python/" + __version__,
)

@patch.dict(
"os.environ",
Expand Down
5 changes: 5 additions & 0 deletions exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_span_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import requests
import responses

from opentelemetry.exporter.otlp.proto.http.version import __version__
from opentelemetry.exporter.otlp.proto.http import Compression
from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
DEFAULT_COMPRESSION,
Expand Down Expand Up @@ -67,6 +68,10 @@ def test_constructor_default(self):
exporter._session.headers.get("Content-Type"),
"application/x-protobuf",
)
self.assertEqual(
exporter._session.headers.get("User-Agent"),
"OTel-OTLP-Exporter-Python/" + __version__,
)

@patch.dict(
"os.environ",
Expand Down