Skip to content

Commit e3be59b

Browse files
committed
Updated README per instrumentation changes.
1 parent 9729bbc commit e3be59b

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,32 +18,29 @@ Any and all feedback is welcome. Happy Python visibility.
1818

1919
## Installation
2020

21-
For this BETA, we currently support tracing of Django and Flask applications. For Django, the process requires no code modification although the Flask alternative temporarily does. The post BETA objective is for full instrumentation without any code modifications required. This will be happening soon.
21+
For this BETA, we currently support tracing of Django and Flask applications or optionally just runtime monitoring of your Python applications.
2222

23-
## Django Installation
23+
`pip install instana` into the virtual-env or container ([hosted on pypi](https://pypi.python.org/pypi/instana))
2424

25-
There are two steps required to install the the Instana package for your applications:
25+
## Django
2626

27-
1. `pip install instana` into the virtual-env or container ([hosted on pypi](https://pypi.python.org/pypi/instana))
27+
To enable the Django instrumentation, set the following environment variable in your _application boot environment_ and then restart your application:
2828

29-
2. Enable instrumentation for the frameworks in use by setting an environment variable:
30-
`AUTOWRAPT_BOOTSTRAP=instana.django`
29+
`export AUTOWRAPT_BOOTSTRAP=django`
3130

32-
## Flask Installation
31+
## Flask
3332

34-
There are two steps required to install the the Instana package for your applications:
33+
To enable the Django instrumentation, set the following environment variable in your _application boot environment_ and then restart your application:
3534

36-
1. `pip install instana` into the virtual-env or container ([hosted on pypi](https://pypi.python.org/pypi/instana))
35+
`export AUTOWRAPT_BOOTSTRAP=flask`
3736

38-
2. Add the WSGI middleware to your Flask application:
39-
40-
```python
41-
from instana import wsgi
42-
app = Flask('myapp')
43-
...snip...
44-
# Wrap the Flask WSGI app with Instana Middleware
45-
app.wsgi_app = wsgi.iWSGIMiddleware(app.wsgi_app)`
46-
```
37+
## Runtime Monitoring Only
38+
39+
_Note: When the Django or Flask instrumentation is used, runtime monitoring is automatically included. Use this section if you only want to see runtime metrics._
40+
41+
To enable runtime monitoring (without request tracing), set the following environment variable in your _application boot environment_ and then restart your application:
42+
43+
`export AUTOWRAPT_BOOTSTRAP=runtime`
4744

4845
## Usage
4946

0 commit comments

Comments
 (0)