semantic-conventions icon indicating copy to clipboard operation
semantic-conventions copied to clipboard

Published 20 hours ago • verified publisher icon open-telemetry

Add Geo fields from Elastic Common Schema

Open AlexanderWert opened this issue 3 years ago • 5 comments

What are you trying to achieve?

Some observability use cases require localization of resources. Examples are:

  • Observability of mobile devices: Geographically localizing the mobile devices provides valuable insights into how mobile apps perform depending on their location.
  • For applications that are geographically distributed across multiple regions and data centers, the geo location can provide useful insights as well.

Having an additional geo namespace on the resource attributes serves use cases as outlined above and allows to filter and group data by geo locations.

As part of the OTEP to support the Elastic Common Schema (ECS), we propose to start with adopting the rich set of the ECS geo fields as a new namespace in the resource attributes.

Additional context.

This is related to this OTEP: https://github.com/open-telemetry/oteps/pull/199

See attached Draft PR for detailed proposal / context: https://github.com/open-telemetry/opentelemetry-specification/pull/2835

AlexanderWert avatar Sep 26 '22 06:09 AlexanderWert

  1. For mobile devices, the geo attributes will be changing as the user moves around and they cannot be updated on the Resource currently. This PR will have to wait until https://github.com/open-telemetry/oteps/pull/208 is resolved or there's another mechanism introduced that allows changing attributes on a Resource.
  2. For apps running in data centers, I believe the customers will have to run a Geo mapping service to map the IP to the geo coordinates. If for some reason this service is unavailable, there should be a way to pass the original source IP in the Resource so that the telemetry backends can use that for the geo mapping. Can you include support for that in this PR or add a reference to it if it's already there?

scheler avatar Sep 26 '22 16:09 scheler

Please hold until OTEP to merge.

rbailey7210 avatar Sep 30 '22 15:09 rbailey7210

Mentioned here https://github.com/open-telemetry/oteps/blob/main/text/0199-support-elastic-common-schema-in-opentelemetry.md#scope-and-overlap-of-ecs-and-otel-semconv

Related to https://github.com/open-telemetry/semantic-conventions/pull/351

martinkuba avatar Apr 23 '24 16:04 martinkuba

@trask I don't have permissions to move this issue to the https://github.com/open-telemetry/semantic-conventions repo. Could you move it?

danielgblanco avatar May 13 '24 09:05 danielgblanco

I've added the triage:rejected:declined label for the spec repo, but I'm leaving the issue open until moved to the semconv repo.

danielgblanco avatar May 13 '24 09:05 danielgblanco