Skip to content
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

Jump to bottom

Map faas.* attributes to generic_task in resource mapping #273

Merged
merged 5 commits into from
Sep 28, 2023
Merged

Map faas.* attributes to generic_task in resource mapping #273

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
12131df
map faas.* attributes to generic_task in resource mapping
dashpole Aug 22, 2023
374c497
address comments
dashpole Sep 22, 2023
4ea1d6d
lint
dashpole Sep 22, 2023
1347df7
change from access to get
dashpole Sep 26, 2023
01694f3
explicitly test unknown_service fallback
dashpole Sep 27, 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 ...sourcedetector-gcp/src/opentelemetry/resourcedetector/gcp_resource_detector/_constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ class ResourceAttributes:
SERVICE_INSTANCE_ID = "service.instance.id"
SERVICE_NAME = "service.name"
SERVICE_NAMESPACE = "service.namespace"
FAAS_INSTANCE = "faas.instance"
FAAS_NAME = "faas.name"


AWS_ACCOUNT = "aws_account"
Expand All @@ -59,3 +61,4 @@ class ResourceAttributes:
REGION = "region"
TASK_ID = "task_id"
ZONE = "zone"
UNKNOWN_SERVICE_PREFIX = "unknown_service"
26 changes: 22 additions & 4 deletions ...resourcedetector-gcp/src/opentelemetry/resourcedetector/gcp_resource_detector/_mapping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,14 @@ def __init__(self, *otel_keys: str, fallback: str = ""):
fallback="global",
),
_constants.NAMESPACE: MapConfig(ResourceAttributes.SERVICE_NAMESPACE),
_constants.JOB: MapConfig(ResourceAttributes.SERVICE_NAME),
_constants.TASK_ID: MapConfig(ResourceAttributes.SERVICE_INSTANCE_ID),
_constants.JOB: MapConfig(
ResourceAttributes.SERVICE_NAME,
ResourceAttributes.FAAS_NAME,
),
_constants.TASK_ID: MapConfig(
ResourceAttributes.SERVICE_INSTANCE_ID,
ResourceAttributes.FAAS_INSTANCE,
),
},
_constants.GENERIC_NODE: {
_constants.LOCATION: MapConfig(
Expand Down Expand Up @@ -168,7 +174,10 @@ def get_monitored_resource(
# fallback to generic_task
if (
ResourceAttributes.SERVICE_NAME in attrs
and ResourceAttributes.SERVICE_INSTANCE_ID in attrs
or ResourceAttributes.FAAS_NAME in attrs
) and (
ResourceAttributes.SERVICE_INSTANCE_ID in attrs
or ResourceAttributes.FAAS_INSTANCE in attrs
):
mr = _create_monitored_resource(_constants.GENERIC_TASK, attrs)
else:
Expand All @@ -186,10 +195,19 @@ def _create_monitored_resource(
for mr_key, map_config in mapping.items():
mr_value = None
for otel_key in map_config.otel_keys:
if otel_key in resource_attrs:
if otel_key in resource_attrs and not str(
resource_attrs[otel_key]
).startswith(_constants.UNKNOWN_SERVICE_PREFIX):
mr_value = resource_attrs[otel_key]
break

if (
aabmass marked this conversation as resolved.
Show resolved Hide resolved
mr_value is None
and ResourceAttributes.SERVICE_NAME in map_config.otel_keys
):
# The service name started with unknown_service, and was ignored above.
mr_value = resource_attrs.get(ResourceAttributes.SERVICE_NAME)

if mr_value is None:
mr_value = map_config.fallback

Expand Down
22 changes: 22 additions & 0 deletions opentelemetry-resourcedetector-gcp/tests/__snapshots__/test_mapping.ambr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,28 @@
'type': 'generic_task',
})
# ---
# name: test_get_monitored_resource[generic task faas]
dict({
'labels': dict({
'job': 'faasname',
'location': 'myregion',
'namespace': 'servicens',
'task_id': 'faasinstance',
}),
'type': 'generic_task',
})
# ---
# name: test_get_monitored_resource[generic task faas fallback]
dict({
'labels': dict({
'job': 'unknown_service',
'location': 'myregion',
'namespace': 'servicens',
'task_id': 'faasinstance',
}),
'type': 'generic_task',
})
# ---
# name: test_get_monitored_resource[generic task fallback region]
dict({
'labels': dict({
Expand Down
21 changes: 20 additions & 1 deletion opentelemetry-resourcedetector-gcp/tests/test_mapping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,25 @@
},
id="generic task fallback global",
),
pytest.param(
{
"service.name": "unknown_service",
"cloud.region": "myregion",
"service.namespace": "servicens",
"faas.name": "faasname",
"faas.instance": "faasinstance",
},
id="generic task faas",
),
pytest.param(
{
"service.name": "unknown_service",
"cloud.region": "myregion",
"service.namespace": "servicens",
"faas.instance": "faasinstance",
},
id="generic task faas fallback",
),
# generic node
pytest.param(
{
Expand Down Expand Up @@ -213,7 +232,7 @@
def test_get_monitored_resource(
otel_attributes: Attributes, snapshot: SnapshotAssertion
) -> None:
resource = Resource.create(otel_attributes)
resource = Resource(otel_attributes)
monitored_resource_data = get_monitored_resource(resource)
as_dict = dataclasses.asdict(monitored_resource_data)
assert as_dict == snapshot
Expand Down