Add support for automated resource detection #263

robertlaurin · 2020-05-14T16:39:32Z

This adds support for populating a resource with with Telemetry data
as well as Google Cloud Platform environment metata data.

For #230

Example usage

OpenTelemetry::SDK.configure do |c|
  c.resource = OpenTelemetry::SDK::Resources::AutoDetector.detect
end

robertlaurin · 2020-05-14T16:43:03Z

sdk/lib/opentelemetry/sdk/resources/detectors/google_cloud_platform.rb

+
+            resource_labels = {}
+            resource_labels[CLOUD_RESOURCE[:provider]] = 'gcp'
+            resource_labels[CLOUD_RESOURCE[:account_id]] = gcp_env.project_id || ''


This deserves a second set of eyes I'm not totally sure this is the correct value being set here, I was following the work done on the JS library https://github.com/open-telemetry/opentelemetry-js/pull/899/files#diff-2ae8d53e5ba7424080459738d6bc210bR45

From the spec

The cloud account id used to identify different entities.

But this is using project-id from https://cloud.google.com/compute/docs/storing-retrieving-metadata#default

project-id seems wrong, but the metadata doesn't supply the account ID. I would suggest leaving this as-is and opening an issue in the spec repo asking for clarification.

mwear

This is off to a good start @robertlaurin. I made a first pass of comments and realize it's a draft.

sdk/lib/opentelemetry/sdk/correlation_context.rb

sdk/lib/opentelemetry/sdk/resources/auto_detector.rb

sdk/lib/opentelemetry/sdk/resources/detectors/google_cloud_platform.rb

sdk/opentelemetry-sdk.gemspec

sdk/lib/opentelemetry/sdk/resources/auto_detector.rb

sdk/lib/opentelemetry/sdk/resources/detectors/telemetry.rb

sdk/lib/opentelemetry/sdk/trace/tracer_provider.rb

sdk/lib/opentelemetry/sdk/configurator.rb

sdk/lib/opentelemetry/sdk/trace/tracer.rb

sdk/lib/opentelemetry/sdk/resources/detectors/google_cloud_platform.rb

sdk/lib/opentelemetry/sdk/configurator.rb

sdk/lib/opentelemetry/sdk/resources/constants.rb

resource-detectors/lib/opentelemetry/resource/detectors/google_cloud_platform.rb

resource-detectors/lib/opentelemetry/resource/detectors/auto_detector.rb

fbogsany · 2020-06-03T14:57:08Z

Related: open-telemetry/oteps#111

fbogsany · 2020-06-12T01:41:48Z

@robertlaurin can you please resolve any out-of-date comments above and rebase? This LGTM and I’ve approved it, but it wasn’t clear to me if you still had unresolved questions. Selfishly, I need this merged for my work on the OTLP exporter 😄 .

robertlaurin · 2020-06-12T14:55:46Z

@fbogsany I've resolved every I believe to be resolved 😄

There's only two points left that I'd like to leave to some one else to resolve.

I don't think this one is a problem but I raised it just to get a second set of eyes on it.
#263 (comment)

The long message thread here, once again I think this one is good but I'd like to leave it to either you or @mwear to sign off on it.
#263 (comment)
#263 (comment)

sdk/lib/opentelemetry/sdk/trace/tracer.rb

fbogsany · 2020-06-12T17:49:51Z

sdk/lib/opentelemetry/sdk/trace/tracer.rb

@@ -56,7 +54,8 @@ def internal_create_span(result, name, kind, trace_id, span_id, parent_span_id,
            attributes = attributes&.merge(result.attributes) || result.attributes
            active_trace_config = OpenTelemetry.tracer_provider.active_trace_config
            active_span_processor = OpenTelemetry.tracer_provider.active_span_processor
-            Span.new(context, name, kind, parent_span_id, active_trace_config, active_span_processor, attributes, links, start_timestamp || Time.now, @resource, @instrumentation_library)
+            resource = OpenTelemetry.tracer_provider.resource
+            Span.new(context, name, kind, parent_span_id, active_trace_config, active_span_processor, attributes, links, start_timestamp || Time.now, resource, @instrumentation_library)


I think this is incorrect. Or at least unnecessary. We should remove the resource parameter -- for now, can you just pass nil?

What the issue here exactly? A span should have a reference to a resource.

A span needs a reference to an InstrumentationLibrary. The Resource is global (a singleton). I don’t see the need to attach the same Resource reference to every span when it is always available from OpenTelemetry.tracer_provider.resource.

Unfortunately, that's a current design flaw of the Ruby library. Technically, multiple TracerProviders should be able to exist in a single process. They should be able to have different resources, but share the same export pipeline. So, the resource is not exactly a global singleton. It's my understanding that in some languages, it's common to have multiple applications per process. .NET is one that I'm aware of. This was discussed somewhat in open-telemetry/opentelemetry-specification#508 and I am supposed to be writing some clarifying language for the spec about this topic.

For the Ruby SDK. I think it's fine to have a single TracerProvider configured by default, as long as we allow additional ones to be instantiated. We'll need to make sure that references go through TracerProvider instances, rather than the classes. There are few places we were need to clean up static references in this regard.

I'll try to get some more clarification about the multiple TracerProvider situation at the spec SIG tomorrow. I've heard that it's a use case, but given that you can only have one global TracerProvider at the API level, I'm not really sure how this works in practice, or if it's necessarily a use case that needs to be preserved.

This is the relevant portion of the spec: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#tracerprovider

Normally, the TracerProvider is expected to be accessed from a central place. Thus, the API SHOULD provide a way to set/register and access a global default TracerProvider.

Notwithstanding any global TracerProvider, some applications may want to or have to use multiple TracerProvider instances, e.g. to have different configuration (like SpanProcessors) for each (and consequently for the Tracers obtained from them), or because its easier with dependency injection frameworks. Thus, implementations of TracerProvider SHOULD allow creating an arbitrary number of TracerProvider instances.

Noting that the spec lists this as a SHOULD, not a MUST.

If I'm following correctly, for the sdk/lib/opentelemetry/sdk/trace/tracer.rb code could we not "just" pass in a reference to the tracer_provider that created it? The tracer_provider is accessed in multiple places within the tracer.rb class already, why not pass it in as part of the initializer for the tracer?

That would solve the issue of supporting multiple tracer_providers for this particular code path, no?

It would also remove some of the implicit coupling that the tracer has on the tracer_provider existing.
https://github.com/robertlaurin/opentelemetry-ruby/blob/cf02a49c38e230f805dcfd9bbb39b8b9a8caabfb/sdk/lib/opentelemetry/sdk/trace/tracer.rb#L27

You're following correctly @robertlaurin. I think the core issue is that because of the multiple TracerProvider use case, each span needs a reference to a resource. Ultimately, this is because TracerProviders can be initialized with different resources, but share the same export pipeline. As you point out, we can support this use case pretty easily passing a TracerProvider to a Tracer during initialization and maintaining a reference to it.

I'm not sure how much of this needs to be addressed in this PR. It would be fine to create issues for additional work that isn't directly related.

I agree that I don't want to grow this PR into additional work that isn't directly related.
I think this change here a43ce3a leaves the code in a good places to be improved on.

mwear

This looks pretty good to me, just a few comments. I'd like to get a little more clarification as to the questions around the instrumentation library.

resource-detectors/lib/opentelemetry/resource/detectors.rb

resource-detectors/test/opentelemetry/detectors/google_cloud_platform_test.rb

sdk/lib/opentelemetry/sdk/trace/tracer.rb

mwear · 2020-06-12T19:40:16Z

sdk/lib/opentelemetry/sdk/trace/tracer.rb

@@ -56,7 +54,8 @@ def internal_create_span(result, name, kind, trace_id, span_id, parent_span_id,
            attributes = attributes&.merge(result.attributes) || result.attributes
            active_trace_config = OpenTelemetry.tracer_provider.active_trace_config
            active_span_processor = OpenTelemetry.tracer_provider.active_span_processor
-            Span.new(context, name, kind, parent_span_id, active_trace_config, active_span_processor, attributes, links, start_timestamp || Time.now, @resource, @instrumentation_library)
+            resource = OpenTelemetry.tracer_provider.resource
+            Span.new(context, name, kind, parent_span_id, active_trace_config, active_span_processor, attributes, links, start_timestamp || Time.now, resource, @instrumentation_library)


What the issue here exactly? A span should have a reference to a resource.

sdk/lib/opentelemetry/sdk/trace/tracer.rb

linux-foundation-easycla · 2020-06-16T17:34:33Z

The committers are authorized under a signed CLA.

✅ Robert (2d359bc, f764a9d, e281fe0, 5fa5ac0, 42ba8f3, c012c60, ec04cac, 09aa570, ec14e07, f042d83, 5115d3d, cf02a49)

fbogsany · 2020-06-18T01:09:42Z

LGTM. Needs a rebase, but otherwise 👍

This adds support for populating a resource with with Telemetry data as well as Google Cloud Platform environment metata data. For open-telemetry#230

To avoid introducing third party dependencies to the SDK for optional functionality resource detection has been extracted into its own gem.

The specification requires a Telemetry::SDK resource, this adds a method for create it directly from the resource class. This also initializes it by default on the configurator. The resource setter on the configurator class will merge the default resource with the one provided.

…lass

Add resource documentation for configurator. Update comments for resource constants. Simplify resource merging in auto detector.

The tracer carries a reference to the tracer_provider that initialized it to begin supporting multiple tracer providers.

robertlaurin requested review from bai, dazuma, elskwid, fbogsany, luvtechno and mwear as code owners May 14, 2020 16:39

robertlaurin commented May 14, 2020

View reviewed changes

robertlaurin force-pushed the feature--resource-auto-detection-230 branch 3 times, most recently from dba4e58 to af12336 Compare May 14, 2020 17:59

robertlaurin marked this pull request as draft May 14, 2020 18:59

robertlaurin force-pushed the feature--resource-auto-detection-230 branch from af12336 to 9f68043 Compare May 14, 2020 21:08

mwear reviewed May 15, 2020

View reviewed changes

fbogsany reviewed May 20, 2020

View reviewed changes

sdk/lib/opentelemetry/sdk/trace/tracer.rb Outdated Show resolved Hide resolved

fbogsany reviewed May 20, 2020

View reviewed changes

sdk/lib/opentelemetry/sdk/trace/tracer.rb Outdated Show resolved Hide resolved

ibawt reviewed May 20, 2020

View reviewed changes

sdk/lib/opentelemetry/sdk/resources/detectors/google_cloud_platform.rb Outdated Show resolved Hide resolved

robertlaurin commented May 21, 2020

View reviewed changes

sdk/lib/opentelemetry/sdk/configurator.rb Show resolved Hide resolved

robertlaurin force-pushed the feature--resource-auto-detection-230 branch from 078eb83 to ec04cac Compare May 25, 2020 16:07

robertlaurin marked this pull request as ready for review May 25, 2020 18:27

fbogsany reviewed May 31, 2020

View reviewed changes

sdk/lib/opentelemetry/sdk/configurator.rb Show resolved Hide resolved

fbogsany reviewed May 31, 2020

View reviewed changes

sdk/lib/opentelemetry/sdk/resources/constants.rb Outdated Show resolved Hide resolved

fbogsany reviewed May 31, 2020

View reviewed changes

resource-detectors/lib/opentelemetry/resource/detectors/google_cloud_platform.rb Show resolved Hide resolved

fbogsany reviewed May 31, 2020

View reviewed changes

resource-detectors/lib/opentelemetry/resource/detectors/auto_detector.rb Outdated Show resolved Hide resolved

fbogsany approved these changes Jun 12, 2020

View reviewed changes

fbogsany reviewed Jun 12, 2020

View reviewed changes

sdk/lib/opentelemetry/sdk/trace/tracer.rb Outdated Show resolved Hide resolved

fbogsany reviewed Jun 12, 2020

View reviewed changes

mwear reviewed Jun 12, 2020

View reviewed changes

fbogsany approved these changes Jun 18, 2020

View reviewed changes

robertlaurin added 13 commits June 18, 2020 07:57

Add support for automated resource detection

1e86b93

This adds support for populating a resource with with Telemetry data as well as Google Cloud Platform environment metata data. For open-telemetry#230

Fix typo typo in correlation context module

eefd0fd

Extract resource detection into a gem

eafa97f

To avoid introducing third party dependencies to the SDK for optional functionality resource detection has been extracted into its own gem.

Add resource-detectors README

219f382

Add comment to disable Style/AccessModifierDeclarations in resource c…

8cf9f9d

…lass

Adjust tracer to use instrumentation library

22c047e

Re-add tracer_tests for name and version

9e2bcd4

Add method documentation, update comments

c7e10c4

Add resource documentation for configurator. Update comments for resource constants. Simplify resource merging in auto detector.

Update copyright year, revert incorrect comment

c986362

Fix typo in gcp resource detector test

7a8a9c6

Set tracer resource in initializer

3674ce5

Add tracer_provider reference to tracer

83780db

The tracer carries a reference to the tracer_provider that initialized it to begin supporting multiple tracer providers.

robertlaurin force-pushed the feature--resource-auto-detection-230 branch from a43ce3a to 83780db Compare June 18, 2020 12:02

fbogsany merged commit 0099668 into open-telemetry:master Jun 23, 2020

This was referenced Jun 29, 2020

resource autodetection #230

Closed

SDK: should Resource initialization use env vars only? #99

Closed

fbogsany linked an issue Jul 8, 2020 that may be closed by this pull request

resource autodetection #230

Closed

This was referenced Jun 14, 2022

Add AWS EC2 resource autodetection open-telemetry/opentelemetry-ruby-contrib#20

Closed

Add resource autodetection from environment labels #292

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for automated resource detection #263

Add support for automated resource detection #263

robertlaurin commented May 14, 2020 •

edited

robertlaurin May 14, 2020

fbogsany Jun 12, 2020

mwear left a comment

fbogsany commented Jun 3, 2020

fbogsany commented Jun 12, 2020

robertlaurin commented Jun 12, 2020

fbogsany Jun 12, 2020

mwear Jun 12, 2020

fbogsany Jun 13, 2020

mwear Jun 15, 2020 •

edited

mwear Jun 15, 2020

mwear Jun 15, 2020

robertlaurin Jun 16, 2020 •

edited

mwear Jun 16, 2020

mwear Jun 16, 2020

robertlaurin Jun 17, 2020

mwear left a comment

mwear Jun 12, 2020

linux-foundation-easycla bot commented Jun 16, 2020 •

edited

fbogsany commented Jun 18, 2020

Add support for automated resource detection #263

Add support for automated resource detection #263

Conversation

robertlaurin commented May 14, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mwear left a comment

Choose a reason for hiding this comment

fbogsany commented Jun 3, 2020

fbogsany commented Jun 12, 2020

robertlaurin commented Jun 12, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mwear Jun 15, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robertlaurin Jun 16, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mwear left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Jun 16, 2020 • edited

fbogsany commented Jun 18, 2020

robertlaurin commented May 14, 2020 •

edited

mwear Jun 15, 2020 •

edited

robertlaurin Jun 16, 2020 •

edited

linux-foundation-easycla bot commented Jun 16, 2020 •

edited