From 08c3499b3697ac756fae83898eb468ff459c8f6a Mon Sep 17 00:00:00 2001 From: "Eric J. Smith" Date: Thu, 10 Sep 2020 14:16:24 -0500 Subject: [PATCH 1/2] Inconsistent SamplingDecision Names - `NOT_RECORD` - `RECORD` - `RECORD_AND_SAMPLED` Seems like we should pick between present tense or past tense and make it consistent. I am proposing that we use past tense as in it's a decision that has already been made. `NOT_RECORDED`, `RECORDED`, `RECORDED_AND_SAMPLED`. `NOT_RECORD` doesn't make sense. It is not correct English. --- specification/trace/sdk.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/trace/sdk.md b/specification/trace/sdk.md index d96610a133b..55bca716b0c 100644 --- a/specification/trace/sdk.md +++ b/specification/trace/sdk.md @@ -85,10 +85,10 @@ Returns the sampling Decision for a `Span` to be created. It produces an output called `SamplingResult` which contains: * A sampling `Decision`. One of the following enum values: - * `NOT_RECORD` - `IsRecording() == false`, span will not be recorded and all events and attributes + * `NOT_RECORDED` - `IsRecording() == false`, span will not be recorded and all events and attributes will be dropped. - * `RECORD` - `IsRecording() == true`, but `Sampled` flag MUST NOT be set. - * `RECORD_AND_SAMPLED` - `IsRecording() == true` AND `Sampled` flag` MUST be set. + * `RECORDED` - `IsRecording() == true`, but `Sampled` flag MUST NOT be set. + * `RECORDED_AND_SAMPLED` - `IsRecording() == true` AND `Sampled` flag` MUST be set. * A set of span Attributes that will also be added to the `Span`. The returned object must be immutable (multiple calls may return different immutable objects). @@ -107,12 +107,12 @@ The default sampler is `ParentBased(root=AlwaysOn)`. #### AlwaysOn -* Returns `RECORD_AND_SAMPLED` always. +* Returns `RECORDED_AND_SAMPLED` always. * Description MUST be `AlwaysOnSampler`. #### AlwaysOff -* Returns `NOT_RECORD` always. +* Returns `NOT_RECORDED` always. * Description MUST be `AlwaysOffSampler`. #### TraceIdRatioBased From fa5aa317f57c5f6d6c5c1731d321befc9095e098 Mon Sep 17 00:00:00 2001 From: "Eric J. Smith" Date: Fri, 11 Sep 2020 10:30:26 -0500 Subject: [PATCH 2/2] Use imperative names for sampling result --- specification/trace/sdk.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/trace/sdk.md b/specification/trace/sdk.md index 2c25730dc7b..4c74a7de70e 100644 --- a/specification/trace/sdk.md +++ b/specification/trace/sdk.md @@ -93,10 +93,10 @@ Returns the sampling Decision for a `Span` to be created. It produces an output called `SamplingResult` which contains: * A sampling `Decision`. One of the following enum values: - * `NOT_RECORDED` - `IsRecording() == false`, span will not be recorded and all events and attributes + * `IGNORE` - `IsRecording() == false`, span will not be recorded and all events and attributes will be dropped. - * `RECORDED` - `IsRecording() == true`, but `Sampled` flag MUST NOT be set. - * `RECORDED_AND_SAMPLED` - `IsRecording() == true` AND `Sampled` flag` MUST be set. + * `RECORD_ONLY` - `IsRecording() == true`, but `Sampled` flag MUST NOT be set. + * `RECORD_AND_SAMPLE` - `IsRecording() == true` AND `Sampled` flag` MUST be set. * A set of span Attributes that will also be added to the `Span`. The returned object must be immutable (multiple calls may return different immutable objects). @@ -115,12 +115,12 @@ The default sampler is `ParentBased(root=AlwaysOn)`. #### AlwaysOn -* Returns `RECORDED_AND_SAMPLED` always. +* Returns `RECORD_AND_SAMPLE` always. * Description MUST be `AlwaysOnSampler`. #### AlwaysOff -* Returns `NOT_RECORDED` always. +* Returns `IGNORE` always. * Description MUST be `AlwaysOffSampler`. #### TraceIdRatioBased