Skip to content

Commit d8f269a

Browse files
committed
Update to follow doc portal updates.
1 parent 1f91d98 commit d8f269a

File tree

1 file changed

+18
-33
lines changed

1 file changed

+18
-33
lines changed

README.md

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Instana
66

7-
The instana package provides Python metrics and traces (request, queue & cross-host) for [Instana](https://www.instana.com/).
7+
The `instana` Python package collects key metrics and distributed traces for [Instana](https://www.instana.com/).
88

99
This package supports Python 2.7 or greater.
1010

@@ -13,52 +13,37 @@ Any and all feedback is welcome. Happy Python visibility.
1313
[![Build Status](https://travis-ci.org/instana/python-sensor.svg?branch=master)](https://travis-ci.org/instana/python-sensor)
1414
[![OpenTracing Badge](https://img.shields.io/badge/OpenTracing-enabled-blue.svg)](http://opentracing.io)
1515

16-
## Usage & Installation
16+
## Installation
1717

18-
The instana package will automatically collect metrics and distributed traces from your Python processes. Just install and go.
18+
None
1919

20-
`pip install instana` into the virtual-env or container ([hosted on pypi](https://pypi.python.org/pypi/instana))
20+
_Instana automatically instruments your Python web servers automatically. No user steps are required. To configure which Python processes this applies to, see the [Configuration page](https://docs.instana.io/ecosystem/python/configuration/#general)._
2121

22-
The Instana package can then be activated _without any code changes required_ by setting the following environment variable for your Python application:
22+
## Manual Installation
2323

24-
export AUTOWRAPT_BOOTSTRAP=instana
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)):
2525

26-
alternatively, if you prefer the manual method, simply import the `instana` package inside of your Python application:
26+
pip install instana
2727

28-
import instana
28+
or to alternatively update an existing installation:
2929

30-
See our detailed [Installation document](INSTALLATION.md) for additional information covering Django, Flask, End-user Monitoring (EUM) and more.
30+
pip install -U instana
3131

32-
## OpenTracing
32+
### Activating Without Code Changes
3333

34-
This Python package supports [OpenTracing](http://opentracing.io/). When using this package, the OpenTracing tracer (`opentracing.tracer`) is automatically set to the `InstanaTracer`.
34+
The Instana package can then be activated _without any code changes required_ by setting the following environment variable for your Python application:
3535

36-
```Python
37-
import opentracing
36+
export AUTOWRAPT_BOOTSTRAP=instana
37+
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.
3839

39-
with opentracing.tracer.start_active_span('asteroid 💫') as pscope:
40-
pscope.span.set_tag(ext.COMPONENT, "Python simple example app")
41-
pscope.span.set_tag(ext.SPAN_KIND, ext.SPAN_KIND_RPC_SERVER)
42-
pscope.span.set_tag(ext.PEER_HOSTNAME, "localhost")
43-
pscope.span.set_tag(ext.HTTP_URL, "/python/simple/one")
44-
pscope.span.set_tag(ext.HTTP_METHOD, "GET")
45-
pscope.span.set_tag(ext.HTTP_STATUS_CODE, 200)
46-
pscope.span.log_kv({"foo": "bar"})
47-
# ... work ...
40+
### Activating via Import
4841

49-
with opentracing.tracer.start_active_span('spacedust 🌚', child_of=pscope.span) as cscope:
50-
cscope.span.set_tag(ext.SPAN_KIND, ext.SPAN_KIND_RPC_CLIENT)
51-
cscope.span.set_tag(ext.PEER_HOSTNAME, "localhost")
52-
cscope.span.set_tag(ext.HTTP_URL, "/python/simple/two")
53-
cscope.span.set_tag(ext.HTTP_METHOD, "POST")
54-
cscope.span.set_tag(ext.HTTP_STATUS_CODE, 204)
55-
cscope.span.set_baggage_item("someBaggage", "someValue")
56-
# ... work ...
57-
```
42+
Alternatively, if you prefer the really manual method, simply import the `instana` package inside of your Python application:
5843

59-
## Configuration
44+
import instana
6045

61-
For details on how to configure the Instana Python package, see [Configuration.md](https://github.com/instana/python-sensor/blob/master/Configuration.md)
46+
See also our detailed [Installation document](https://docs.instana.io/ecosystem/python/installation) for additional information covering Django, Flask, End-user Monitoring (EUM) and more.
6247

6348
## Documentation
6449

0 commit comments

Comments
 (0)