[Instrumentation Base] Improve install failure messages
Follow up form this discussion https://github.com/open-telemetry/opentelemetry-ruby/discussions/1050, there is value in improve the quality of the failure to install messages. We could increase the detail to identify which specific checks failed to provide a better set of bread crumbs for users to follow in the event they have instrumentation failing to install.
In the meantime, Is there any way to work out why installs fail? I'm using ruby-instrumentation-all and most of them fail (some I expect to since we don't use all of the gems that can be instrumented).
W, [2023-02-09T21:06:21.984939 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Trilogy failed to install
W, [2023-02-09T21:06:21.989706 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::ActionPack failed to install
W, [2023-02-09T21:06:21.989763 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::ActiveJob failed to install
W, [2023-02-09T21:06:21.989794 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::ActiveRecord failed to install
W, [2023-02-09T21:06:21.989823 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::ActionView failed to install
W, [2023-02-09T21:06:21.993184 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Bunny failed to install
W, [2023-02-09T21:06:21.993227 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::LMDB failed to install
W, [2023-02-09T21:06:21.993252 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::HTTP failed to install
W, [2023-02-09T21:06:21.993273 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Koala failed to install
W, [2023-02-09T21:06:21.993314 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::ActiveModelSerializers failed to install
W, [2023-02-09T21:06:21.994035 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Dalli failed to install
W, [2023-02-09T21:06:21.995062 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Ethon failed to install
W, [2023-02-09T21:06:22.008720 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::GraphQL failed to install
W, [2023-02-09T21:06:22.010296 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Mongo failed to install
W, [2023-02-09T21:06:22.010323 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Mysql2 failed to install
W, [2023-02-09T21:06:22.011343 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::PG failed to install
W, [2023-02-09T21:06:22.011371 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Que failed to install
W, [2023-02-09T21:06:22.011394 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Racecar failed to install
W, [2023-02-09T21:06:22.011434 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Rails failed to install
W, [2023-02-09T21:06:22.012282 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Rdkafka failed to install
W, [2023-02-09T21:06:22.015132 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Resque failed to install
W, [2023-02-09T21:06:22.015168 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::RubyKafka failed to install
W, [2023-02-09T21:06:22.019887 #40354] WARN -- : Instrumentation: OpenTelemetry::Instrumentation::Sinatra failed to install
I was mainly trying to get rails instrumentation working at bare minimum, but ActiveJob and ActiveRecord, ActiveView would be nice too.
Update: Oh, we need to bump to Rails 5.2 at minimum (looks like that's already being worked on in our app so I'll wait a bit). source
@NickLarsenNZ unfortunately we don't yet have better logging in this area yet. And, even more unfortunately, the minimum supported Rails version is now Rails 6 (since Rails 5 went EOL last summer): https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/307
👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.
I am using Roda, and have this error: OpenTelemetry::Instrumentation::Mongo failed to install, anyone know why ?