Skip to content

Commit e4827a4

Browse files
authored
Merge pull request #142 from chanchiem/master
Added more information about using Django in the README
2 parents fa63cb6 + f431690 commit e4827a4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,15 @@ MIDDLEWARE = [
338338
# ... other middlewares
339339
]
340340
```
341+
342+
You can configure the X-Ray recorder in a Django app under the ‘XRAY_RECORDER’ namespace. For a minimal configuration, the 'AWS_XRAY_TRACING_NAME' is required unless it is specified in an environment variable.
343+
```
344+
XRAY_RECORDER = {
345+
'AWS_XRAY_TRACING_NAME': 'My application', # Required - the segment name for segments generated from incoming requests
346+
}
347+
```
348+
For more information about configuring Django with X-Ray read more about it in the [API reference](https://docs.aws.amazon.com/xray-sdk-for-python/latest/reference/frameworks.html)
349+
341350
#### SQL tracing
342351
If Django's ORM is patched - either using the `AUTO_INSTRUMENT = True` in your settings file
343352
or explicitly calling `patch_db()` - the SQL query trace streaming can then be enabled or

0 commit comments

Comments
 (0)