Skip to content

Commit

Permalink
add a disclaimer to the documentation, in preparation for a release (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
dgoffredo authored Aug 24, 2022
1 parent 3db282f commit e0fb951
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,9 @@ order to prevent rejection by peers or other HTTP header policies. This
configuration option is that limit, in bytes.

### Span Sampling Rules
_Note: Span sampling does not work yet, because the necessary Datadog Agent
changes are not yet released._

Span sampling rules allow spans to be sent to Datadog that otherwise would be
dropped due to trace sampling.

Expand All @@ -266,6 +269,9 @@ Sampling][11] section of [sampling.md][6].
- **Default value**: `[]`

### Span Sampling Rules File
_Note: Span sampling does not work yet, because the necessary Datadog Agent
changes are not yet released._

Span sampling rules (see above) can be specified in their own file. The value
of the `DD_SPAN_SAMPLING_RULES_FILE` environment variable is the path to a file
whose contents are the span sampling rules JSON array.
Expand Down
3 changes: 3 additions & 0 deletions doc/sampling.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ environment variable. Note that the environment variable overrides the

Span Sampling
-------------
_Note: Span sampling does not work yet, because the necessary Datadog Agent
changes are not yet released._

Span sampling is used to select spans to keep even when the enclosing
trace is dropped.

Expand Down
3 changes: 3 additions & 0 deletions include/datadog/opentracing.h
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,9 @@ struct TracerOptions {
// serialized tags allowed. Trace-wide tags whose serialized length exceeds
// this limit are not propagated.
uint64_t tags_header_size = 512;
// Note about `span_sampling_rules`: Span sampling does not work yet, because
// the necessary Datadog Agent changes are not yet released.
//
// Rule-based span sampling, which is distinct from rule-based trace
// sampling, is used to determine which spans to keep, if any, when trace
// sampling decides to drop the trace.
Expand Down

0 comments on commit e0fb951

Please sign in to comment.