Skip to content

Commit e93d8f4

Browse files
committed
Filter invalid resource attribute pairs
1 parent 05e9fe1 commit e93d8f4

File tree

3 files changed

+20
-6
lines changed

3 files changed

+20
-6
lines changed

Diff for: CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
([#2207](https://github.com/open-telemetry/opentelemetry-python/pull/2207))
1111
- remove `X-B3-ParentSpanId` for B3 propagator as per OpenTelemetry specification
1212
([#2237](https://github.com/open-telemetry/opentelemetry-python/pull/2237))
13+
- `opentelemetry-sdk` Sanitize env var resource attribute pairs
14+
([#2256](https://github.com/open-telemetry/opentelemetry-python/pull/2256))
1315

1416
## [1.6.2-0.25b2](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.6.2-0.25b2) - 2021-10-19
1517

Diff for: opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py

+11-6
Original file line numberDiff line numberDiff line change
@@ -266,13 +266,18 @@ class OTELResourceDetector(ResourceDetector):
266266
def detect(self) -> "Resource":
267267
env_resources_items = os.environ.get(OTEL_RESOURCE_ATTRIBUTES)
268268
env_resource_map = {}
269+
269270
if env_resources_items:
270-
env_resource_map = {
271-
key.strip(): value.strip()
272-
for key, value in (
273-
item.split("=") for item in env_resources_items.split(",")
274-
)
275-
}
271+
for item in env_resources_items.split(","):
272+
if item.find("=") == -1:
273+
logger.warning(
274+
"Invalid key value resource attribute pair %s", item
275+
)
276+
continue
277+
278+
key, value = item.split("=", 1)
279+
env_resource_map[key.strip()] = value.strip()
280+
276281
service_name = os.environ.get(OTEL_SERVICE_NAME)
277282
if service_name:
278283
env_resource_map[SERVICE_NAME] = service_name

Diff for: opentelemetry-sdk/tests/resources/test_resources.py

+7
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,13 @@ def test_multiple_with_whitespace(self):
482482
detector.detect(), resources.Resource({"k": "v", "k2": "v2"})
483483
)
484484

485+
def test_invalid_key_value_pairs(self):
486+
detector = resources.OTELResourceDetector()
487+
os.environ[resources.OTEL_RESOURCE_ATTRIBUTES] = "k=v,k2=v2,invalid,,"
488+
self.assertEqual(
489+
detector.detect(), resources.Resource({"k": "v", "k2": "v2"})
490+
)
491+
485492
@mock.patch.dict(
486493
os.environ,
487494
{resources.OTEL_SERVICE_NAME: "test-srv-name"},

0 commit comments

Comments
 (0)