Skip to content

Commit 02fb992

Browse files
committed
Update README.md
Updated a few reported broken links, and fixed grammar issues. Signed-off-by: Paulo Vital <[email protected]>
1 parent 56657d2 commit 02fb992

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,22 @@
44

55
# Instana
66

7-
The `instana` Python package collects key metrics and distributed traces for [Instana](https://www.instana.com/).
7+
The `instana` Python package collects key metrics and distributed traces for [Instana].
88

99
This package supports Python 3.7 or greater.
1010

11-
Any and all feedback is welcome. Happy Python visibility.
11+
Any feedback is welcome. Happy Python visibility.
1212

1313
[![CircleCI](https://circleci.com/gh/instana/python-sensor/tree/master.svg?style=svg)](https://circleci.com/gh/instana/python-sensor/tree/master)
1414
[![OpenTracing Badge](https://img.shields.io/badge/OpenTracing-enabled-blue.svg)](http://opentracing.io)
1515

1616
## Installation
1717

18-
None
19-
20-
_Instana remotely instruments your Python web servers automatically via Instana [AutoTrace™️](https://www.instana.com/supported-technologies/instana-autotrace/). To configure which Python processes this applies to, see the [Configuration page](https://docs.instana.io/ecosystem/python/configuration/#general)._
18+
Instana remotely instruments your Python web servers automatically via [Instana AutoTrace™️]. To configure which Python processes this applies to, see the [configuration page].
2119

2220
## Manual Installation
2321

24-
If you wish to manually instrument your applications you can install the package with the following into the virtualenv, pipenv or container ([hosted on pypi](https://pypi.python.org/pypi/instana)):
22+
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]):
2523

2624
pip install instana
2725

@@ -35,24 +33,36 @@ The Instana package can then be activated _without any code changes required_ by
3533

3634
export AUTOWRAPT_BOOTSTRAP=instana
3735

38-
This will cause the Instana Python package to automatically instrument your Python application. Once it finds the Instana host agent, it will begin to report Python metrics and distributed traces.
36+
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.
3937

4038
### Activating via Import
4139

42-
Alternatively, if you prefer the really manual method, simply import the `instana` package inside of your Python application:
40+
Alternatively, if you prefer the manual method, import the `instana` package inside of your Python application:
4341

4442
import instana
4543

46-
See also our detailed [Installation document](https://www.instana.com/docs/ecosystem/python/#installing) for additional information covering Django, Flask, End-user Monitoring (EUM) and more.
44+
See also our detailed [installation document] for additional information covering Django, Flask, End-user Monitoring (EUM), and more.
4745

4846
## Documentation
4947

50-
You can find more documentation covering supported components and minimum versions in the Instana [documentation portal](https://docs.instana.io/ecosystem/python/).
48+
You can find more documentation covering supported components and minimum versions in the Instana [documentation portal].
5149

5250
## Contributing
5351

5452
Bug reports and pull requests are welcome on GitHub at https://github.com/instana/python-sensor.
5553

5654
## More
5755

58-
Want to instrument other languages? See our [Node.js](https://github.com/instana/nodejs), [Go](https://github.com/instana/golang-sensor), [Ruby](https://github.com/instana/ruby-sensor) instrumentation or [many other supported technologies](https://www.instana.com/supported-technologies/).
56+
Want to instrument other languages? See our [Node.js], [Go], [Ruby] instrumentation or many other [supported technologies].
57+
58+
<!-- Reference links -->
59+
[Instana]: https://www.instana.com/ "IBM Instana Observability"
60+
[Instana AutoTrace™️]: https://www.instana.com/supported-technologies/instana-autotrace/ "Instana AutoTrace"
61+
[configuration page]: https://www.ibm.com/docs/en/instana-observability/current?topic=package-python-configuration-configuring-instana#general "Instana Python package configuration"
62+
[PyPI]: https://pypi.python.org/pypi/instana "Instana package at PyPI"
63+
[installation document]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package#installing "Instana Python package installation"
64+
[documentation portal]: https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-python-instana-python-package "Instana Python package documentation"
65+
[Node.js]: https://github.com/instana/nodejs "Instana Node.JS Tracer"
66+
[Go]: https://github.com/instana/golang-sensor "Instana Go Tracer"
67+
[Ruby]: https://github.com/instana/ruby-sensor "Instana Ruby Tracer"
68+
[supported technologies]: https://www.instana.com/supported-technologies/ "Instana supported technologies"

0 commit comments

Comments
 (0)