Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 3 additions & 32 deletions opentelemetry_configuration.json
Original file line number Diff line number Diff line change
Expand Up @@ -473,35 +473,6 @@
],
"additionalProperties": false
},
"ExperimentalComposableParentBasedSampler": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"root": {
"$ref": "#/$defs/ExperimentalComposableSampler",
"description": "Configures the sampler for spans with no parent."
},
"remote_parent_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler",
"description": "Configures the sampler for spans with a remote parent that is sampled."
},
"remote_parent_not_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler",
"description": "Configures the sampler for spans with a remote parent that is not sampled."
},
"local_parent_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler",
"description": "Configures the sampler for spans with a local parent that is sampled."
},
"local_parent_not_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler",
"description": "Configures the sampler for spans with a local parent that is not sampled."
}
}
},
"ExperimentalComposableProbabilitySampler": {
"type": [
"object",
Expand Down Expand Up @@ -539,9 +510,9 @@
"$ref": "#/$defs/ExperimentalComposableAlwaysOnSampler",
"description": "Configure sampler to be always_on."
},
"parent_based": {
"$ref": "#/$defs/ExperimentalComposableParentBasedSampler",
"description": "Configure sampler to be parent_based."
"parent_threshold": {
"$ref": "#/$defs/ExperimentalComposableSampler",
"description": "Configure sampler to be parent_threshold, delegating to the configured sampler when there is no parent.\n"
},
"probability": {
"$ref": "#/$defs/ExperimentalComposableProbabilitySampler",
Expand Down
89 changes: 9 additions & 80 deletions schema-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3599,69 +3599,6 @@ Usages:
}</pre>
</details>

## ExperimentalComposableParentBasedSampler <a id="experimentalcomposableparentbasedsampler"></a>

> [!WARNING]
> This type is [experimental](README.md#experimental-features).

| Property | Type | Required? | Constraints | Description |
|---|---|---|---|---|
| `local_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a local parent that is not sampled. |
| `local_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a local parent that is sampled. |
| `remote_parent_not_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a remote parent that is not sampled. |
| `remote_parent_sampled` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with a remote parent that is sampled. |
| `root` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configures the sampler for spans with no parent. |

<details>
<summary>Language support status</summary>

| Property | [cpp](#cpp) | [go](#go) | [java](#java) | [js](#js) |
|---|---|---|---|---|
| `local_parent_not_sampled` | unknown | unknown | unknown | unknown |
| `local_parent_sampled` | unknown | unknown | unknown | unknown |
| `remote_parent_not_sampled` | unknown | unknown | unknown | unknown |
| `remote_parent_sampled` | unknown | unknown | unknown | unknown |
| `root` | unknown | unknown | unknown | unknown |
</details>

Constraints:

* `additionalProperties`: `false`

Usages:

* [`ExperimentalComposableSampler.parent_based`](#experimentalcomposablesampler)

<details>
<summary>JSON Schema</summary>

[JSON Schema Source File](./schema/tracer_provider.yaml)
<pre>{
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"root": {
"$ref": "#/$defs/ExperimentalComposableSampler"
},
"remote_parent_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler"
},
"remote_parent_not_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler"
},
"local_parent_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler"
},
"local_parent_not_sampled": {
"$ref": "#/$defs/ExperimentalComposableSampler"
}
}
}</pre>
</details>

## ExperimentalComposableProbabilitySampler <a id="experimentalcomposableprobabilitysampler"></a>

> [!WARNING]
Expand Down Expand Up @@ -3719,7 +3656,7 @@ Usages:
|---|---|---|---|---|
| `always_off` | [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | `false` | No constraints. | Configure sampler to be always_off. |
| `always_on` | [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | `false` | No constraints. | Configure sampler to be always_on. |
| `parent_based` | [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | `false` | No constraints. | Configure sampler to be parent_based. |
| `parent_threshold` | [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | `false` | No constraints. | Configure sampler to be parent_threshold, delegating to the configured sampler when there is no parent.<br> |
| `probability` | [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | `false` | No constraints. | Configure sampler to be probability. |

<details>
Expand All @@ -3729,7 +3666,7 @@ Usages:
|---|---|---|---|---|
| `always_off` | unknown | unknown | unknown | unknown |
| `always_on` | unknown | unknown | unknown | unknown |
| `parent_based` | unknown | unknown | unknown | unknown |
| `parent_threshold` | unknown | unknown | unknown | unknown |
| `probability` | unknown | unknown | unknown | unknown |
</details>

Expand All @@ -3742,11 +3679,7 @@ Constraints:
Usages:

* [`Sampler.composite/development`](#sampler)
* [`ExperimentalComposableParentBasedSampler.root`](#experimentalcomposableparentbasedsampler)
* [`ExperimentalComposableParentBasedSampler.remote_parent_sampled`](#experimentalcomposableparentbasedsampler)
* [`ExperimentalComposableParentBasedSampler.remote_parent_not_sampled`](#experimentalcomposableparentbasedsampler)
* [`ExperimentalComposableParentBasedSampler.local_parent_sampled`](#experimentalcomposableparentbasedsampler)
* [`ExperimentalComposableParentBasedSampler.local_parent_not_sampled`](#experimentalcomposableparentbasedsampler)
* [`ExperimentalComposableSampler.parent_threshold`](#experimentalcomposablesampler)

<details>
<summary>JSON Schema</summary>
Expand All @@ -3769,8 +3702,8 @@ Usages:
"always_on": {
"$ref": "#/$defs/ExperimentalComposableAlwaysOnSampler"
},
"parent_based": {
"$ref": "#/$defs/ExperimentalComposableParentBasedSampler"
"parent_threshold": {
"$ref": "#/$defs/ExperimentalComposableSampler"
},
"probability": {
"$ref": "#/$defs/ExperimentalComposableProbabilitySampler"
Expand Down Expand Up @@ -5415,9 +5348,8 @@ Latest supported file format: `1.0.0-rc.2`
| [`ZipkinSpanExporter`](#zipkinspanexporter) | supported | | * `endpoint`: supported<br>* `timeout`: supported<br> |
| [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | unknown | | |
| [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | unknown | | |
| [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | unknown | | * `local_parent_not_sampled`: unknown<br>* `local_parent_sampled`: unknown<br>* `remote_parent_not_sampled`: unknown<br>* `remote_parent_sampled`: unknown<br>* `root`: unknown<br> |
| [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | unknown | | * `ratio`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_based`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_threshold`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | not_implemented | | |
| [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | not_applicable | | * `http`: not_applicable<br>* `peer`: not_applicable<br> |
| [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | not_implemented | | |
Expand Down Expand Up @@ -5523,9 +5455,8 @@ Latest supported file format: `0.3.0`
| [`ZipkinSpanExporter`](#zipkinspanexporter) | unknown | | * `endpoint`: unknown<br>* `timeout`: unknown<br> |
| [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | unknown | | |
| [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | unknown | | |
| [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | unknown | | * `local_parent_not_sampled`: unknown<br>* `local_parent_sampled`: unknown<br>* `remote_parent_not_sampled`: unknown<br>* `remote_parent_sampled`: unknown<br>* `root`: unknown<br> |
| [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | unknown | | * `ratio`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_based`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_threshold`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | unknown | | |
| [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | unknown | | * `http`: unknown<br>* `peer`: unknown<br> |
| [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | unknown | | |
Expand Down Expand Up @@ -5631,9 +5562,8 @@ Latest supported file format: `1.0.0-rc.1`
| [`ZipkinSpanExporter`](#zipkinspanexporter) | supported | | * `endpoint`: supported<br>* `timeout`: supported<br> |
| [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | unknown | | |
| [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | unknown | | |
| [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | unknown | | * `local_parent_not_sampled`: unknown<br>* `local_parent_sampled`: unknown<br>* `remote_parent_not_sampled`: unknown<br>* `remote_parent_sampled`: unknown<br>* `root`: unknown<br> |
| [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | unknown | | * `ratio`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_based`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_threshold`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | supported | | |
| [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | supported | | * `http`: supported<br>* `peer`: supported<br> |
| [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | supported | | |
Expand Down Expand Up @@ -5739,9 +5669,8 @@ Latest supported file format: `1.0.0-rc.2`
| [`ZipkinSpanExporter`](#zipkinspanexporter) | unknown | | * `endpoint`: unknown<br>* `timeout`: unknown<br> |
| [`ExperimentalComposableAlwaysOffSampler`](#experimentalcomposablealwaysoffsampler) | unknown | | |
| [`ExperimentalComposableAlwaysOnSampler`](#experimentalcomposablealwaysonsampler) | unknown | | |
| [`ExperimentalComposableParentBasedSampler`](#experimentalcomposableparentbasedsampler) | unknown | | * `local_parent_not_sampled`: unknown<br>* `local_parent_sampled`: unknown<br>* `remote_parent_not_sampled`: unknown<br>* `remote_parent_sampled`: unknown<br>* `root`: unknown<br> |
| [`ExperimentalComposableProbabilitySampler`](#experimentalcomposableprobabilitysampler) | unknown | | * `ratio`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_based`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalComposableSampler`](#experimentalcomposablesampler) | unknown | | * `always_off`: unknown<br>* `always_on`: unknown<br>* `parent_threshold`: unknown<br>* `probability`: unknown<br> |
| [`ExperimentalContainerResourceDetector`](#experimentalcontainerresourcedetector) | unknown | | |
| [`ExperimentalGeneralInstrumentation`](#experimentalgeneralinstrumentation) | unknown | | * `http`: unknown<br>* `peer`: unknown<br> |
| [`ExperimentalHostResourceDetector`](#experimentalhostresourcedetector) | unknown | | |
Expand Down
3 changes: 0 additions & 3 deletions schema/meta_schema_language_cpp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,6 @@ typeSupportStatuses:
- type: ExperimentalComposableAlwaysOnSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableParentBasedSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableProbabilitySampler
status: unknown
propertyOverrides: []
Expand Down
3 changes: 0 additions & 3 deletions schema/meta_schema_language_go.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,6 @@ typeSupportStatuses:
- type: ExperimentalComposableAlwaysOnSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableParentBasedSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableProbabilitySampler
status: unknown
propertyOverrides: []
Expand Down
3 changes: 0 additions & 3 deletions schema/meta_schema_language_java.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,6 @@ typeSupportStatuses:
- type: ExperimentalComposableAlwaysOnSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableParentBasedSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableProbabilitySampler
status: unknown
propertyOverrides: []
Expand Down
3 changes: 0 additions & 3 deletions schema/meta_schema_language_js.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,6 @@ typeSupportStatuses:
- type: ExperimentalComposableAlwaysOnSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableParentBasedSampler
status: unknown
propertyOverrides: []
- type: ExperimentalComposableProbabilitySampler
status: unknown
propertyOverrides: []
Expand Down
28 changes: 4 additions & 24 deletions schema/tracer_provider.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -197,27 +197,6 @@ $defs:
- object
- "null"
additionalProperties: false
ExperimentalComposableParentBasedSampler:
type:
- object
- "null"
additionalProperties: false
properties:
root:
$ref: "#/$defs/ExperimentalComposableSampler"
description: Configures the sampler for spans with no parent.
remote_parent_sampled:
$ref: "#/$defs/ExperimentalComposableSampler"
description: Configures the sampler for spans with a remote parent that is sampled.
remote_parent_not_sampled:
$ref: "#/$defs/ExperimentalComposableSampler"
description: Configures the sampler for spans with a remote parent that is not sampled.
local_parent_sampled:
$ref: "#/$defs/ExperimentalComposableSampler"
description: Configures the sampler for spans with a local parent that is sampled.
local_parent_not_sampled:
$ref: "#/$defs/ExperimentalComposableSampler"
description: Configures the sampler for spans with a local parent that is not sampled.
ExperimentalComposableProbabilitySampler:
type:
- object
Expand Down Expand Up @@ -248,9 +227,10 @@ $defs:
always_on:
$ref: "#/$defs/ExperimentalComposableAlwaysOnSampler"
description: Configure sampler to be always_on.
parent_based:
$ref: "#/$defs/ExperimentalComposableParentBasedSampler"
description: Configure sampler to be parent_based.
parent_threshold:
$ref: "#/$defs/ExperimentalComposableSampler"
description: |
Configure sampler to be parent_threshold, delegating to the configured sampler when there is no parent.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand, ComposableParentThreshold accepts a parameter root, but since it accepts only one parameter, you're shortcutting it and just saying that whatever object is set is the root.

So in the following example, always_on is the root.

tracer_provider:
  sampler:
    composite/development:
      parent_threshold:
        always_on:

If so, I think this breaks consistency and we should opt for a more verbose, yet consistent alternative:

tracer_provider:
  sampler:
    composite/development:
      parent_threshold:
        root:
          always_on:

It does looks silly. But its possible that ComposableParentThreshold adds additional parameters in the future. Also, a user familiar with the schema might go looking for the ComposableParentThreshold type in the schema and the root parameter, and be surprised not to find it since they find types for every other named sampler.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this is the same as the schema compression I did for composite/development so we'd probably need to update it too to match if going with it.

https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema/tracer_provider.yaml#L84

tracer_provider:
  sampler:
    composite/development:
      sampler:
        parent_threshold:
          root:
            always_on:

Though maybe that looks a bit too weird to even consider. If we can make a decision to simplify the types for composite/development, it may give some precedence to doing it for parent_threshold as well.

I've been erring on making the configs simpler than not since it seems easier to use that way. Generally I've had a user reading docs or looking at example yaml files in mind with the schema being an implementation detail of the yaml - a user actually looking for types in the schema didn't come to mind, but I suspect it's not really a common case.

Future additional arguments is definitely a good reason, but at the same time given how stable the Sampler APIs have been so far, I expect it to be similar for the new ones, basically no changes, even additive, after being marked stable. I lean towards keeping the yaml simpler vs speculating on that.

But I understand the arguments for including root as well and just don't lean towards it - @jack-berg if you still feel it's better though then I'll make the change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we've got to go with having a root property. In addition to the arguments discussed, language implementations are going to tooling that expects SDK extension plugin types to be handled in a particular way. Changing the pattern will throw a wrench in that tooling in the few places we end up with deviations.

We have prior are inSimple{LogRecord|Span}Processors have a single property named exporter:

tracer_provider:
  processors:
    - simple:
         exporter:
           console:
logger_provider:
  processors:
    - simple:
         exporter:
           console:

I guess this is the same as the schema compression I did for composite/development so we'd probably need to update it too to match if going with it.

Maybe. The distinction between ComposableSampler and CompositeSampler at the spec level is strange. Do we need both in declarative config? Can we get away with just ComposableSampler? Mabye we can:

  • Introduce .tracer_provider.composable_sampler/development property, of type ExperimentalComposableSampler
  • State that either .tracer_provider.composable_sampler/development OR .tracer_provider.sampler can be specified, but specifying both is an error.
  • Keep ExperimentalCompositeSampler around just to be able to reference ComposableSamplers inside of traditional samplers. Or just delete it and say we don't support this for now - if you want to use new samples, set .tracer_provider.composable_sampler/development instead.

(Aside: #397 would really help with evaluation of these types of things because we could ask PRs to include a snippet so we're all on the same page about the UX.)

probability:
$ref: "#/$defs/ExperimentalComposableProbabilitySampler"
description: Configure sampler to be probability.
Expand Down
Loading