opentelemetry-android icon indicating copy to clipboard operation
opentelemetry-android copied to clipboard

Add instrumentation details to each README.md

Open breedx-splk opened this issue 11 months ago • 2 comments

New users have no quick/easy way to determine what telemetry is provided by the various instrumentations here. This is a tracking issue and proposal to add specific details about the telemetry generated by each instrumentation.

For each instrumentation module, there should be a corresponding README.md file that provides:

  • a description what the instrumentation does
  • whether it is enabled by default via the agent
  • how to configure it
  • specific details about the instrumentation it provides.

Here is an instrumentation checklist that should be complete before this issue can be closed:

  • [x] Activity (#750)
  • [x] ANR (application not responding) (#787)
  • [x] Crash reporting (#788)
  • [ ] Fragment
  • [ ] HttpUrlConnection
  • [ ] Network (#789)
  • [ ] OkHttp
  • [x] Session (covered in #719)
  • [x] SlowRendering
  • [ ] Startup
  • [ ] Volley

breedx-splk avatar Jan 13 '25 23:01 breedx-splk

@breedx-splk I'd love to take on some of those (e.g. Fragment, Https, Slow Rendering?)

magda-woj avatar Jan 31 '25 20:01 magda-woj

@breedx-splk I'd love to take on some of those (e.g. Fragment, Https, Slow Rendering?)

Great! Thanks. I'll stay away from Fragment then while you take it.

breedx-splk avatar Feb 03 '25 19:02 breedx-splk

@breedx-splk With PR #1242 this should be completed

marcschaeferger avatar Sep 21 '25 13:09 marcschaeferger

Thanks everyone!

breedx-splk avatar Sep 25 '25 16:09 breedx-splk