Skip to content

Commit

Permalink
Use headers to add link anchors (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
mwunderl authored and haotianw465 committed Feb 26, 2018
1 parent 3f30877 commit b9dbaf1
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ provides guidance for using the SDK and module-level documentation.

## Quick Start

**Configuration**
### Configuration

```python
from aws_xray_sdk.core import xray_recorder
Expand All @@ -62,7 +62,7 @@ xray_recorder.configure(
)
```

**Start a custom segment/subsegment**
### Start a custom segment/subsegment

```python
from aws_xray_sdk.core import xray_recorder
Expand All @@ -81,7 +81,7 @@ xray_recorder.end_subsegment()
xray_recorder.end_segment()
```

**Capture**
### Capture

```python
from aws_xray_sdk.core import xray_recorder
Expand All @@ -104,7 +104,7 @@ async def main():
await myfunc()
```

**Trace AWS Lambda functions**
### Trace AWS Lambda functions

```python
from aws_xray_sdk.core import xray_recorder
Expand All @@ -123,7 +123,7 @@ def lambda_handler(event, context):
# ... some other code
```

**Patch third-party libraries**
### Patch third-party libraries

```python
from aws_xray_sdk.core import patch
Expand All @@ -132,7 +132,7 @@ libs_to_patch = ('boto3', 'mysql', 'requests')
patch(libs_to_patch)
```

**Add Django middleware**
### Add Django middleware

In django settings.py, use the following.

Expand All @@ -148,7 +148,7 @@ MIDDLEWARE = [
]
```

**Add Flask middleware**
### Add Flask middleware

```python
from aws_xray_sdk.core import xray_recorder
Expand All @@ -160,7 +160,7 @@ xray_recorder.configure(service='fallback_name', dynamic_naming='*mysite.com*')
XRayMiddleware(app, xray_recorder)
```

**Add aiohttp middleware**
### Add aiohttp middleware
```python
from aiohttp import web

Expand All @@ -176,7 +176,7 @@ app.router.add_get("/", handler)
web.run_app(app)
```

**Use SQLAlchemy ORM**
### Use SQLAlchemy ORM
The SQLAlchemy integration requires you to override the Session and Query Classes for SQL Alchemy

SQLAlchemy integration uses subsegments so you need to have a segment started before you make a query.
Expand All @@ -197,7 +197,7 @@ xray_recorder.configure(service='fallback_name', dynamic_naming='*mysite.com*')
XRayMiddleware(app, xray_recorder)
```

**Add Flask-SQLAlchemy**
### Add Flask-SQLAlchemy

```python
from aws_xray_sdk.core import xray_recorder
Expand Down

0 comments on commit b9dbaf1

Please sign in to comment.