Skip to content

Use headers to add link anchors #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
haotianw465 merged 1 commit into from
Feb 26, 2018
Merged

Use headers to add link anchors #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
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