Skip to content

Commit

Permalink
improve doc about sampling configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
srprash committed Sep 25, 2023
1 parent 186beda commit 4bea199
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/configurations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@ 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

0 comments on commit 4bea199

Please sign in to comment.