rename to OptIn

dashpole · dashpole · commit c3548c2fcef2 · 2026-01-05T21:08:19.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,7 @@ release.
 
 - Stabilize part of `Enabled` SDK for synchronous instruments.
   ([#4787](https://github.com/open-telemetry/opentelemetry-specification/pull/4787))
-- Add the DefaultDisabled advisory parameter.
+- Add the OptIn advisory parameter.
   ([#4809](https://github.com/open-telemetry/opentelemetry-specification/pull/4809))
 
 ### Logs
diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md
@@ -130,7 +130,7 @@ formats is required. Implementing more than one format is optional.
 | Instrument descriptions conform to the specified syntax. |  | - | + |  | - | + | - |  |  | - | + |  |
 | Instrument supports the advisory ExplicitBucketBoundaries parameter. |  | + | + |  |  |  | + |  |  |  |  |  |
 | Instrument supports the advisory Attributes parameter. |  | - | + |  |  |  | - |  |  |  |  |  |
-| Instrument supports the advisory DefaultDisabled parameter. |  | - | - | - | - | - | - | - | - | - | - | - |
+| Instrument supports the advisory OptIn parameter. |  | - | - | - | - | - | - | - | - | - | - | - |
 | All methods of `MeterProvider` are safe to be called concurrently. |  | + | + | + | - |  | + |  |  | + | + |  |
 | All methods of `Meter` are safe to be called concurrently. |  | + | + | + | - |  | + |  |  | + | + |  |
 | All methods of any instrument are safe to be called concurrently. |  | + | + | + | - |  | + |  |  | + | + |  |
diff --git a/spec-compliance-matrix/cpp.yaml b/spec-compliance-matrix/cpp.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '+'
diff --git a/spec-compliance-matrix/dotnet.yaml b/spec-compliance-matrix/dotnet.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '+'
diff --git a/spec-compliance-matrix/erlang.yaml b/spec-compliance-matrix/erlang.yaml
@@ -223,7 +223,7 @@ sections:
         status: '+'
       - name: Instrument supports the advisory Attributes parameter.
         status: '-'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '+'
diff --git a/spec-compliance-matrix/go.yaml b/spec-compliance-matrix/go.yaml
@@ -223,7 +223,7 @@ sections:
         status: '+'
       - name: Instrument supports the advisory Attributes parameter.
         status: '-'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '+'
diff --git a/spec-compliance-matrix/java.yaml b/spec-compliance-matrix/java.yaml
@@ -223,7 +223,7 @@ sections:
         status: '+'
       - name: Instrument supports the advisory Attributes parameter.
         status: '+'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '+'
diff --git a/spec-compliance-matrix/js.yaml b/spec-compliance-matrix/js.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '+'
diff --git a/spec-compliance-matrix/php.yaml b/spec-compliance-matrix/php.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '?'
diff --git a/spec-compliance-matrix/python.yaml b/spec-compliance-matrix/python.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '-'
diff --git a/spec-compliance-matrix/ruby.yaml b/spec-compliance-matrix/ruby.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '?'
diff --git a/spec-compliance-matrix/rust.yaml b/spec-compliance-matrix/rust.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '?'
diff --git a/spec-compliance-matrix/swift.yaml b/spec-compliance-matrix/swift.yaml
@@ -223,7 +223,7 @@ sections:
         status: '?'
       - name: Instrument supports the advisory Attributes parameter.
         status: '?'
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
         status: '-'
       - name: All methods of `MeterProvider` are safe to be called concurrently.
         status: '?'
diff --git a/spec-compliance-matrix/template.yaml b/spec-compliance-matrix/template.yaml
@@ -155,7 +155,7 @@ sections:
       - name: Instrument descriptions conform to the specified syntax.
       - name: Instrument supports the advisory ExplicitBucketBoundaries parameter.
       - name: Instrument supports the advisory Attributes parameter.
-      - name: Instrument supports the advisory DefaultDisabled parameter.
+      - name: Instrument supports the advisory OptIn parameter.
       - name: All methods of `MeterProvider` are safe to be called concurrently.
       - name: All methods of `Meter` are safe to be called concurrently.
       - name: All methods of any instrument are safe to be called concurrently.
diff --git a/specification/metrics/api.md b/specification/metrics/api.md
@@ -26,7 +26,7 @@ weight: 1
     + [Instrument advisory parameters](#instrument-advisory-parameters)
       - [Instrument advisory parameter: `ExplicitBucketBoundaries`](#instrument-advisory-parameter-explicitbucketboundaries)
       - [Instrument advisory parameter: `Attributes`](#instrument-advisory-parameter-attributes)
-      - [Instrument advisory parameter: `DefaultDisabled`](#instrument-advisory-parameter-defaultdisabled)
+      - [Instrument advisory parameter: `OptIn`](#instrument-advisory-parameter-optin)
     + [Synchronous and Asynchronous instruments](#synchronous-and-asynchronous-instruments)
       - [Synchronous Instrument API](#synchronous-instrument-api)
       - [Asynchronous Instrument API](#asynchronous-instrument-api)
@@ -277,13 +277,13 @@ Applies to all instrument types.
 `Attributes` (a list of [attribute keys](../common/README.md#attribute)) is
 the recommended set of attribute keys to be used for the resulting metrics.
 
-##### Instrument advisory parameter: `DefaultDisabled`
+##### Instrument advisory parameter: `OptIn`
 
 **Status**: [Development](../document-status.md)
 
 Applies to all instrument types.
 
-`DefaultDisabled` (bool) if true, indicates that the instrument should not
+`OptIn` (bool) if true, indicates that the instrument should not
 produce metric data and that functions on the instrument should be no-ops
 unless the user has explicitly enabled the metric.
 
diff --git a/specification/metrics/sdk.md b/specification/metrics/sdk.md
@@ -52,7 +52,7 @@ weight: 3
   * [Instrument advisory parameters](#instrument-advisory-parameters)
     + [Instrument advisory parameter: `ExplicitBucketBoundaries`](#instrument-advisory-parameter-explicitbucketboundaries)
     + [Instrument advisory parameter: `Attributes`](#instrument-advisory-parameter-attributes)
-    + [Instrument advisory parameter: `DefaultDisabled`](#instrument-advisory-parameter-defaultdisabled)
+    + [Instrument advisory parameter: `OptIn`](#instrument-advisory-parameter-OptIn)
   * [Instrument enabled](#instrument-enabled)
 - [Attribute limits](#attribute-limits)
 - [Exemplar](#exemplar)
@@ -423,9 +423,9 @@ made with an Instrument:
 * Determine the `MeterProvider` which "owns" the Instrument.
 * If the `MeterProvider` has no `View` registered:
   * **Status**: [Development](../document-status.md) - If the instrument's
-    [DefaultDisabled advisory parameter](#instrument-advisory-parameter-defaultdisabled)
-    is set, use the [Drop Aggregation](#drop-aggregation).
-  * If DefaultDisabled is not set, take the Instrument and apply the default
+    [OptIn advisory parameter](#instrument-advisory-parameter-OptIn)
+    is set to true, use the [Drop Aggregation](#drop-aggregation).
+  * If OptIn is false, take the Instrument and apply the default
     Aggregation on the basis of instrument kind according to the
     [MetricReader](#metricreader) instance's `aggregation` property.
     [Instrument advisory parameters](#instrument-advisory-parameters), if any,
@@ -1004,13 +1004,13 @@ If no View is configured, or if a matching view does not specify attribute keys,
 the advisory parameter should be used. If neither is provided, all attributes
 must be retained.
 
-#### Instrument advisory parameter: `DefaultDisabled`
+#### Instrument advisory parameter: `OptIn`
 
 **Status**: [Development](../document-status.md)
 
 This advisory parameter applies to all aggregations.
 
-When an instrument is `DefaultDisabled`, the SDK MUST use the
+When an instrument is `OptIn`, the SDK MUST use the
 [Drop Aggregation](#drop-aggregation) by default. If the user has provided an
 Aggregation via View(s), that aggregation takes precedence.
 
