Skip to content

Commit b9dbaf1

Browse files
mwunderlhaotianw465
authored andcommitted
Use headers to add link anchors (#27)
1 parent 3f30877 commit b9dbaf1

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ provides guidance for using the SDK and module-level documentation.
4848

4949
## Quick Start
5050

51-
**Configuration**
51+
### Configuration
5252

5353
```python
5454
from aws_xray_sdk.core import xray_recorder
@@ -62,7 +62,7 @@ xray_recorder.configure(
6262
)
6363
```
6464

65-
**Start a custom segment/subsegment**
65+
### Start a custom segment/subsegment
6666

6767
```python
6868
from aws_xray_sdk.core import xray_recorder
@@ -81,7 +81,7 @@ xray_recorder.end_subsegment()
8181
xray_recorder.end_segment()
8282
```
8383

84-
**Capture**
84+
### Capture
8585

8686
```python
8787
from aws_xray_sdk.core import xray_recorder
@@ -104,7 +104,7 @@ async def main():
104104
await myfunc()
105105
```
106106

107-
**Trace AWS Lambda functions**
107+
### Trace AWS Lambda functions
108108

109109
```python
110110
from aws_xray_sdk.core import xray_recorder
@@ -123,7 +123,7 @@ def lambda_handler(event, context):
123123
# ... some other code
124124
```
125125

126-
**Patch third-party libraries**
126+
### Patch third-party libraries
127127

128128
```python
129129
from aws_xray_sdk.core import patch
@@ -132,7 +132,7 @@ libs_to_patch = ('boto3', 'mysql', 'requests')
132132
patch(libs_to_patch)
133133
```
134134

135-
**Add Django middleware**
135+
### Add Django middleware
136136

137137
In django settings.py, use the following.
138138

@@ -148,7 +148,7 @@ MIDDLEWARE = [
148148
]
149149
```
150150

151-
**Add Flask middleware**
151+
### Add Flask middleware
152152

153153
```python
154154
from aws_xray_sdk.core import xray_recorder
@@ -160,7 +160,7 @@ xray_recorder.configure(service='fallback_name', dynamic_naming='*mysite.com*')
160160
XRayMiddleware(app, xray_recorder)
161161
```
162162

163-
**Add aiohttp middleware**
163+
### Add aiohttp middleware
164164
```python
165165
from aiohttp import web
166166

@@ -176,7 +176,7 @@ app.router.add_get("/", handler)
176176
web.run_app(app)
177177
```
178178

179-
**Use SQLAlchemy ORM**
179+
### Use SQLAlchemy ORM
180180
The SQLAlchemy integration requires you to override the Session and Query Classes for SQL Alchemy
181181

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

200-
**Add Flask-SQLAlchemy**
200+
### Add Flask-SQLAlchemy
201201

202202
```python
203203
from aws_xray_sdk.core import xray_recorder

0 commit comments

Comments
 (0)