Skip to content
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

Jump to bottom

[Doc fix] improve doc about sampling configuration #406

Merged
merged 2 commits into from
Sep 25, 2023
Merged

[Doc fix] improve doc about sampling configuration #406

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bea199
improve doc about sampling configuration
srprash Sep 25, 2023
07b56e9
Merge branch 'master' into doc_update
srprash Sep 25, 2023
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
7 changes: 6 additions & 1 deletion docs/configurations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,18 @@ To turn off sampling, use code like the following::
from aws_xray_sdk.core import xray_recorder
xray_recorder.configure(sampling=False)

You can also configure the sampling rules::
By default, the SDK uses sampling rules configured in your AWS account. You can also configure the backup sampling rules locally::

xray_recorder.configure(sampling_rules=your_rules)

The input can either be an absolute path to your sampling rule
*.json* file or a dictionary.

To use only local rules for sampling, configure the recorder with a ``LocalSampler``::

from aws_xray_sdk.core.sampling.local.sampler import LocalSampler
xray_recorder.configure(sampler=LocalSampler())

The following code is an example of a rule configuration::

{
Expand Down