Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sdk-common: rename otel.experimental.resource.disabled.keys to otel.resource.disabled.keys #889

Merged
merged 1 commit into from
Jan 11, 2025
Merged

sdk-common: rename otel.experimental.resource.disabled.keys to otel.resource.disabled.keys #889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions docs/sdk/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions ...rc/main/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigure.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
* }}}
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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. |
* }}}
Expand Down
2 changes: 1 addition & 1 deletion ...st/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigureSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down