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.

Sign up for GitHub

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

Drop link to Python benchmarks, and copyedits #2598

Merged
merged 2 commits into from
Apr 13, 2023
Merged

Drop link to Python benchmarks, and copyedits #2598

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ac832e
Drop link to Python benchmarks, and copyedits
chalin Apr 13, 2023
4fcb178
Merge branch 'main' into chalin-im-python-drop-benchmark-link-2023-04-13
cartermp Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 16 additions & 19 deletions content/en/docs/instrumentation/python/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,27 @@ OpenTelemetry-Python supports Python 3.6 and higher.

The API and SDK packages are available on PyPI, and can be installed via pip:

```console
$ pip install opentelemetry-api
$ pip install opentelemetry-sdk
```sh
pip install opentelemetry-api
pip install opentelemetry-sdk
```

In addition, there are several extension packages which can be installed
separately as:

```console
$ pip install opentelemetry-exporter-{exporter}
$ pip install opentelemetry-instrumentation-{instrumentation}
```sh
pip install opentelemetry-exporter-{exporter}
pip install opentelemetry-instrumentation-{instrumentation}
```

These are for exporter and instrumentation packages respectively. The Jaeger,
Zipkin, Prometheus, OTLP and OpenCensus Exporters can be found in the
[exporter](https://github.com/open-telemetry/opentelemetry-python/blob/main/exporter/)
directory of the repository. Instrumentations and additional exporters can be
found in the
[Contrib repo instrumentation](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation)
found in the contrib repo
[instrumentation](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation)
and
[Contrib repo exporter](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/exporter)
[exporter](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/exporter)
directories.

## Extensions
Expand All @@ -53,21 +53,18 @@ situation, you may want to install the packages directly from the repo. This can
be done by cloning the repository and doing an
[editable install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs):

```console
$ git clone https://github.com/open-telemetry/opentelemetry-python.git
$ cd opentelemetry-python
$ pip install -e ./opentelemetry-api
$ pip install -e ./opentelemetry-sdk
```sh
git clone https://github.com/open-telemetry/opentelemetry-python.git
cd opentelemetry-python
pip install -e ./opentelemetry-api
pip install -e ./opentelemetry-sdk
```

## Repositories and benchmarks

- Main repo:
[opentelemetry-python](https://github.com/open-telemetry/opentelemetry-python)
- Main repo: [opentelemetry-python][]
- Contrib repo: [opentelemetry-python-contrib][]
- [Performance benchmarks][]

[opentelemetry-python]: https://github.com/open-telemetry/opentelemetry-python
[opentelemetry-python-contrib]:
https://github.com/open-telemetry/opentelemetry-python-contrib
[performance benchmarks]:
https://open-telemetry.github.io/opentelemetry-python/benchmarks/