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.

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

RuntimeError: Requested component 'jaeger' not found in entry points for 'opentelemetry_exporter' #2062

Closed
srikanthccv opened this issue Aug 22, 2021 · 3 comments · Fixed by #2093
Assignees
Labels
bug Something isn't working

Comments

@srikanthccv
Copy link
Member

From the exporters selection of spec

Known values for OTEL_TRACES_EXPORTER are:

  • "otlp": OTLP
  • "jaeger": Jaeger gRPC
  • "zipkin": Zipkin (Defaults to protobuf format)
  • "none": No automatically configured exporter for traces.

We have split up the exporters based on protocol + serialisation to avoid taking unnecessary dependency so there is no entry point for jaeger. If someone reads the spec and follows that recommendation they will run into this error. We should either add an entry point jaeger or an alias that solves this problem.

@srikanthccv srikanthccv added the bug Something isn't working label Aug 22, 2021
@srikanthccv srikanthccv self-assigned this Aug 22, 2021
@owais
Copy link
Contributor

owais commented Aug 22, 2021

Adding an alias could result in unexpected and hard to debug behavior as someone might expect gRPC and we enable thrift or vice-versa. I think we should do the following:

  1. Update documentation to note actual exporter names (jaeger-thrift, jaeger-grpc, etc)
  2. Handle cases like jaeger but crash early with a helpful error messaging guiding the user towards "jaeger-thrift", "jaeger-grpc" and may be a link to docs.

@srikanthccv
Copy link
Member Author

What do you think about something like this? Update the glue package entry point with exporter default protocol recommended by spec.

diff --git exporter/opentelemetry-exporter-jaeger/setup.cfg exporter/opentelemetry-exporter-jaeger/setup.cfg
index b01b3a8d..7075ea14 100644
--- exporter/opentelemetry-exporter-jaeger/setup.cfg
+++ exporter/opentelemetry-exporter-jaeger/setup.cfg
@@ -44,3 +44,7 @@ install_requires =

 [options.extras_require]
 test =
+
+[options.entry_points]
+opentelemetry_exporter =
+    jaeger = opentelemetry.exporter.jaeger.proto.grpc:JaegerExporter
diff --git exporter/opentelemetry-exporter-zipkin/setup.cfg exporter/opentelemetry-exporter-zipkin/setup.cfg
index 6d2f9740..d3641e48 100644
--- exporter/opentelemetry-exporter-zipkin/setup.cfg
+++ exporter/opentelemetry-exporter-zipkin/setup.cfg
@@ -43,3 +43,7 @@ install_requires =

 [options.extras_require]
 test =
+
+[options.entry_points]
+opentelemetry_exporter =
+    zipkin = opentelemetry.exporter.zipkin.proto.http:ZipkinExporter

@owais
Copy link
Contributor

owais commented Aug 23, 2021

If there are defaults for jaeger,zipkin and otlp recommended by the spec then we should use them for sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants