opentelemetry-python-contrib icon indicating copy to clipboard operation
opentelemetry-python-contrib copied to clipboard

opentelemetry package

Open owais opened this issue 4 years ago • 2 comments
trafficstars

Description

  • Add new opentelemetry package.
  • Add instrument and bootstrap commands to the new package.
  • Python code is purely lift and shift. I've tried to not make any changes or fixes to commands in this PR.
  • Updated the generate command to generate local bootstrap_gen.py

Part of: https://docs.google.com/document/d/1qb05E45hEGbxKQ7UVXpB-7aGTN7Pjh4vok1l07weudA/edit#heading=h.rkrrdheasnx9

Role of the new package

This package builds on top of other lower level "concepts" to make it easier for users to consume OpenTelemetry. This includes things like easier configuration/setup with one function call (automatically sets up tracing pipeline, propagators, etc but allows customization), easier instrumentation with a single function call (automatically finds and instruments relevant packages), auto-instrumentation with CLI command, easier installation of instrumentation packages using a CLI command or optional dependencies.

In other words, this package can become the official OpenTelemetry package that most users would install. Users shouldn't have to care or learn about other "lower level" packages or details. Advanced users can still skip this package and achieve everything this package does with custom code by manually setting up the SDK, importing and instrumenting specific instrumentation packages, etc.

Type of change

Please delete options that are not relevant.

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • [x] Manual tests
  • [x] Unit tests

Does This PR Require a Core Repo Change?

  • [x] Yes. - Link to PR: https://github.com/open-telemetry/opentelemetry-python/pull/2173
  • [ ] No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • [x] Followed the style guidelines of this project
  • [x] Changelogs have been updated
  • [x] Unit tests have been added
  • [x] Documentation has been updated

owais avatar Oct 03 '21 00:10 owais