Make it explicit to install distro to get auto-instrumentation working #588
Conversation
srikanthccv
requested review from
a team,
owais and
aabmass
and removed request for
a team
srikanthccv
added
the
Skip Changelog
| @@ -11,11 +11,14 @@ Installation | |||
|
|
|||
| :: | |||
|
|
|||
| pip install opentelemetry-instrumentation | |||
| pip install opentelemetry-distro[otlp] opentelemetry-instrumentation | |||
There was a problem hiding this comment.
I think we should separate out these sections. Right underneath this, an explanation like what you have in the note would be good (users need to install "A" distro), and then have the pip install follow that excerpt. An explanation that opentelemetry-distro contains the default distro would be good too. This way users won't be confused as to why or what the opentelemetry-distro packge is.
There was a problem hiding this comment.
This looks fine but I still think our default recommendation should be to just install the distro and run opentelemetry-instrument as part of getting started docs. It should be followed up with an advanced section that documents other packages and how one may use them without the distro. IMO opentelemetry-distro should be the only or the first package users install when getting started.
|
Completely agree. That will make a huge difference in terms of user experience for the first the time users. Meanwhile, I wanted to add this note since it is not obvious to someone that without a distro auto instrumentation doesn't produce any telemetry. |
|
@ocelotl @lonewolf3739 |
|
^ @lzchen it's green now. |
Description
Fixes open-telemetry/opentelemetry-python#1931