Skip to content

Commit 0f2cc57

Browse files
committed
chore: Update README.md file.
Signed-off-by: Paulo Vital <[email protected]>
1 parent 548a72b commit 0f2cc57

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,13 @@ Any feedback is welcome. Happy Python visibility.
1515
1616
## Installation
1717

18-
Instana remotely instruments your Python web servers automatically via [Instana AutoTrace™️]. To configure which Python processes this applies to, see the [configuration page].
18+
You can use automatic installation or manual installation as described in the following sections:
1919

20-
## Manual Installation
20+
### Automatic installation
21+
22+
Instana remotely instruments your Python applications automatically by [Instana AutoTrace webhook] in Kubernetes and Red Hat OpenShift clusters. However, if you prefer to install the package manually, see [Manual Installation](#manual-installation) as follows.
23+
24+
### Manual Installation
2125

2226
If you wish to instrument your applications manually, you can install the package with the following into the `virtualenv`, `pipenv`, or container (hosted on [PyPI]):
2327

@@ -27,15 +31,15 @@ or to alternatively update an existing installation:
2731

2832
pip install -U instana
2933

30-
### Activating Without Code Changes
34+
#### Activating Without Code Changes
3135

3236
The Instana package can then be activated _without any code changes required_ by setting the following environment variable for your Python application:
3337

3438
export AUTOWRAPT_BOOTSTRAP=instana
3539

3640
This will cause the Instana Python package to instrument your Python application automatically. Once it finds the Instana host agent, it will report Python metrics and distributed traces.
3741

38-
### Activating via Import
42+
#### Activating With Code Changes
3943

4044
Alternatively, if you prefer the manual method, import the `instana` package inside of your Python application:
4145

@@ -57,11 +61,11 @@ Want to instrument other languages? See our [Node.js], [Go], [Ruby] instrumenta
5761

5862
<!-- Reference links -->
5963
[Instana]: https://www.instana.com/ "IBM Instana Observability"
60-
[Instana AutoTrace™️]: https://www.ibm.com/docs/en/instana-observability/current?topic=kubernetes-instana-autotrace-webhook "Instana AutoTrace"
64+
[Instana AutoTrace webhook]: https://www.ibm.com/docs/en/instana-observability/current?topic=kubernetes-instana-autotrace-webhook "Instana AutoTrace webhook"
6165
[configuration page]: https://www.ibm.com/docs/en/instana-observability/current?topic=package-python-configuration-configuring-instana#general "Instana Python package configuration"
6266
[PyPI]: https://pypi.python.org/pypi/instana "Instana package at PyPI"
6367
[installation document]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package#installation-methods "Instana Python package installation methods"
64-
[documentation portal]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package "Instana Python package documentation"
68+
[documentation portal]: https://ibm.biz/monitoring-python "Monitoring Python - IBM documentation"
6569
[Node.js]: https://github.com/instana/nodejs "Instana Node.JS Tracer"
6670
[Go]: https://github.com/instana/golang-sensor "Instana Go Tracer"
6771
[Ruby]: https://github.com/instana/ruby-sensor "Instana Ruby Tracer"

0 commit comments

Comments
 (0)