From e0fb951308f30a0e73bdb8eea9ddc04bffd4ab04 Mon Sep 17 00:00:00 2001 From: David Goffredo Date: Wed, 24 Aug 2022 09:13:02 -0400 Subject: [PATCH] add a disclaimer to the documentation, in preparation for a release (#237) --- doc/configuration.md | 6 ++++++ doc/sampling.md | 3 +++ include/datadog/opentracing.h | 3 +++ 3 files changed, 12 insertions(+) diff --git a/doc/configuration.md b/doc/configuration.md index d6dca1c7..66bee634 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -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. @@ -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. diff --git a/doc/sampling.md b/doc/sampling.md index 67d3af72..0dd3bcb7 100644 --- a/doc/sampling.md +++ b/doc/sampling.md @@ -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. diff --git a/include/datadog/opentracing.h b/include/datadog/opentracing.h index 08d3661d..3fb13508 100644 --- a/include/datadog/opentracing.h +++ b/include/datadog/opentracing.h @@ -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.