Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit c0ec5fb

Browse files
authored
Add a table of currently implemented samplers (#37)
1 parent 16c36a2 commit c0ec5fb

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ bottom of the webpage.
4747

4848
If you would like to provide your own reporter, create a class that implements `ReporterInterface`.
4949

50-
Currently implemented reporters:
50+
#### Currently implemented reporters
5151

5252
| Class | Description |
5353
| ----- | ----------- |
@@ -86,6 +86,15 @@ and you include the cache/apcu-adapter composer package, we will set up the cach
8686
You can also choose to use the `RandomSampler` which simply samples a flat
8787
percentage of requests.
8888

89+
#### Currently implemented samplers
90+
91+
| Class | Description |
92+
| ----- | ----------- |
93+
| [AlwaysOffSampler](src/Trace/Sampler/AlwaysOffSampler.php) | Never trace any requests |
94+
| [AlwaysOnSampler](src/Trace/Sampler/AlwaysOnSampler.php) | Trace all requests |
95+
| [QpsSampler](src/Trace/Sampler/QpsSampler.php) | Trace X requests per second. Requires a PSR-6 cache implementation |
96+
| [RandomSampler](src/Trace/Sampler/RandomSampler.php) | Trace X percent of requests. |
97+
8998
```php
9099
use OpenCensus\Trace\Reporter\EchoReporter;
91100
use OpenCensus\Trace\Sampler\RandomSampler;

0 commit comments

Comments
 (0)