Skip to content

Commit

Permalink
ddtrace/tracer: make doc clearer. (#247)
Browse files Browse the repository at this point in the history
The previous phrasing made it unclear weather the `0.5` argument was for
the amount kept or dropped. Now it's clear that `0.3` means keep 30%.
  • Loading branch information
gbbr committed Jun 1, 2018
1 parent a79177a commit d052956
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions ddtrace/tracer/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
// The tracing client can perform trace sampling. While the trace agent
// already samples traces to reduce bandwidth usage, client sampling reduces
// performance overhead. To make use of it, the package comes with a ready-to-use
// rate sampler that can be passed to the tracer. To use it and cut down 50% of the
// rate sampler that can be passed to the tracer. To use it and keep only 30% of the
// requests, one would do:
// s := tracer.NewRateSampler(0.5)
// s := tracer.NewRateSampler(0.3)
// tracer.Start(tracer.WithSampler(s))
//
// All spans created by the tracer contain a context hereby referred to as the span
Expand Down

0 comments on commit d052956

Please sign in to comment.