Merge pull request #889 from iRevive/sdk-common/resource-disabled-keys

sdk-common: rename `otel.experimental.resource.disabled.keys` to `otel.resource.disabled.keys`
typelevel · Jan 11, 2025 · 4548972 · 4548972
2 parents ac5a6fb + 2b5a8cf
commit 4548972
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/docs/sdk/configuration.md b/docs/sdk/configuration.md
@@ -45,13 +45,13 @@ and `jobs-dispatcher` could be an application that processes background jobs.
 
 If not specified, SDK defaults the service name to `unknown_service:scala`.
 
-| System property                          | Environment variable                             | Description                                                                                                 |
-|------------------------------------------|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
-| otel.resource.attributes                 | OTEL\\_RESOURCE\\_ATTRIBUTES                     | Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`.                       |
-| otel.service.name                        | OTEL\\_SERVICE\\_NAME                            | Specify logical service name. Takes precedence over `service.name` defined with `otel.resource.attributes`. |
-| otel.experimental.resource.disabled-keys | OTEL\\_EXPERIMENTAL\\_RESOURCE\\_DISABLED\\_KEYS | Specify resource attribute keys that are filtered.                                                          |
-| otel.otel4s.resource.detectors.enabled   | OTEL\\_OTEL4S\\_RESOURCE\\_DETECTORS\\_ENABLED   | Specify resource detectors to use. Defaults to `host,os,process,process_runtime`.                           | 
-| otel.otel4s.resource.detectors.disabled  | OTEL\\_OTEL4S\\_RESOURCE\\_DETECTORS\\_DISABLED  | Specify resource detectors to disable.                                                                      | 
+| System property                         | Environment variable                            | Description                                                                                                 |
+|-----------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
+| otel.resource.attributes                | OTEL\\_RESOURCE\\_ATTRIBUTES                    | Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`.                       |
+| otel.resource.disabled.keys             | OTEL\\_RESOURCE\\_DISABLED\\_KEYS               | Specify resource attribute keys that are filtered.                                                          |
+| otel.service.name                       | OTEL\\_SERVICE\\_NAME                           | Specify logical service name. Takes precedence over `service.name` defined with `otel.resource.attributes`. |
+| otel.otel4s.resource.detectors.enabled  | OTEL\\_OTEL4S\\_RESOURCE\\_DETECTORS\\_ENABLED  | Specify resource detectors to use. Defaults to `host,os,process,process_runtime`.                           | 
+| otel.otel4s.resource.detectors.disabled | OTEL\\_OTEL4S\\_RESOURCE\\_DETECTORS\\_DISABLED | Specify resource detectors to disable.                                                                      | 
 
 ### Telemetry resource detectors
 

diff --git a/...rc/main/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigure.scala b/...rc/main/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigure.scala
@@ -40,7 +40,7 @@ import java.nio.charset.StandardCharsets
   * |------------------------------------------|------------------------------------------|------------------------------------------------------------------------------------------------------------|
   * | otel.resource.attributes                 | OTEL_RESOURCE_ATTRIBUTES                 | Specify resource attributes in the following format: key1=val1,key2=val2,key3=val3                         |
   * | otel.service.name                        | OTEL_SERVICE_NAME                        | Specify logical service name. Takes precedence over `service.name` defined with `otel.resource.attributes` |
-  * | otel.experimental.resource.disabled-keys | OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS | Specify resource attribute keys that are filtered.                                                         |
+  * | otel.resource.disabled.keys              | OTEL_RESOURCE_DISABLED_KEYS              | Specify resource attribute keys that are filtered.                                                         |
   * | otel.otel4s.resource.detectors.enabled   | OTEL_OTEL4S_RESOURCE_DETECTORS_ENABLED   | Specify resource detectors to use. Defaults to `host,os,process,process_runtime`.                          |
   * | otel.otel4s.resource.detectors.disabled  | OTEL_OTEL4S_RESOURCE_DETECTORS_DISABLED  | Specify resource detectors to disable.                                                                     |
   * }}}
@@ -194,7 +194,7 @@ private[sdk] object TelemetryResourceAutoConfigure {
 
   private object ConfigKeys {
     val DisabledKeys: Config.Key[Set[String]] =
-      Config.Key("otel.experimental.resource.disabled.keys")
+      Config.Key("otel.resource.disabled.keys")
 
     val Attributes: Config.Key[Map[String, String]] =
       Config.Key("otel.resource.attributes")
@@ -238,7 +238,7 @@ private[sdk] object TelemetryResourceAutoConfigure {
     * |------------------------------------------|------------------------------------------|------------------------------------------------------------------------------------------------------------|
     * | otel.resource.attributes                 | OTEL_RESOURCE_ATTRIBUTES                 | Specify resource attributes in the following format: key1=val1,key2=val2,key3=val3                         |
     * | otel.service.name                        | OTEL_SERVICE_NAME                        | Specify logical service name. Takes precedence over `service.name` defined with `otel.resource.attributes` |
-    * | otel.experimental.resource.disabled-keys | OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS | Specify resource attribute keys that are filtered.                                                         |
+    * | otel.resource.disabled.keys              | OTEL_RESOURCE_DISABLED_KEYS              | Specify resource attribute keys that are filtered.                                                         |
     * | otel.otel4s.resource.detectors.enabled   | OTEL_OTEL4S_RESOURCE_DETECTORS_ENABLED   | Specify resource detectors to use. Defaults to `host,os,process,process_runtime`.                          |
     * | otel.otel4s.resource.detectors.disabled  | OTEL_OTEL4S_RESOURCE_DETECTORS_DISABLED  | Specify resource detectors to disable.                                                                     |
     * }}}

diff --git a/...st/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigureSuite.scala b/...st/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigureSuite.scala
@@ -40,7 +40,7 @@ class TelemetryResourceAutoConfigureSuite extends CatsEffectSuite {
     val props = Map(
       "otel.service.name" -> "some-service",
       "otel.resource.attributes" -> "key1=val1,key2=val2,key3=val3",
-      "otel.experimental.resource.disabled-keys" -> "key1,val3,test,key3",
+      "otel.resource.disabled.keys" -> "key1,val3,test,key3",
       "otel.otel4s.resource.detectors.enabled" -> "none"
     )