From 500d0ceaba38625c2f3b147b24a155e7aa26b3c3 Mon Sep 17 00:00:00 2001 From: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> Date: Mon, 30 Oct 2023 17:05:59 -0400 Subject: [PATCH] Mark old instrumentation options as deprecated in installer script usage (#3851) * Mark old instrumentation options as deprecated in installer script usage * Update CHANGELOG.md for deprecated options --- CHANGELOG.md | 9 +++++++++ internal/buildscripts/packaging/installer/install.sh | 12 +++++++----- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e053c4d8e0..dfba02bc3d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,15 @@ - Puppet: `auto_instrumentation_version` - Salt: `auto_instrumentation_version` +### 🚩 Deprecations 🚩 + +- (Splunk) The following Auto Instrumentation options for the Linux installer script are deprecated and will only apply if the `--instrumentation-version ` + option is specified for version `0.86.0` or older: + - `--[no-]generate-service-name`: `libsplunk.so` no longer generates service names for instrumented applications. The default behavior is for the activated Java + and/or Node.js Auto Instrumentation agents to automatically generate service names. Use the `--service-name ` option to override the auto-generated service + names for all instrumented applications. + - `--[enable|disable]-telemetry`: `libsplunk.so` no longer generates the `splunk.linux-autoinstr.executions` telemetry metric. + ### 💡 Enhancements 💡 - (Splunk) Update golang to 1.20.10 ([#3770](https://github.com/signalfx/splunk-otel-collector/pull/3770)) diff --git a/internal/buildscripts/packaging/installer/install.sh b/internal/buildscripts/packaging/installer/install.sh index 9c6a23eed1..d61d4231a7 100755 --- a/internal/buildscripts/packaging/installer/install.sh +++ b/internal/buildscripts/packaging/installer/install.sh @@ -901,13 +901,15 @@ Auto Instrumentation: Only applicable if the '--with-systemd-instrumentation' option is also specified. (default: http://LISTEN_INTERFACE:4317 where LISTEN_INTERFACE is the value from the --listen-interface option if specified, or "127.0.0.1" otherwise) - --[no-]generate-service-name Specify '--no-generate-service-name' to prevent the preloader from setting the - OTEL_SERVICE_NAME environment variable. - Only applicable if the '--with-instrumentation' option is also specified. + --[no-]generate-service-name DEPRECATED: Specify '--no-generate-service-name' to prevent the preloader from + setting the OTEL_SERVICE_NAME environment variable. + Only applicable if the '--with-instrumentation' option is also specified and the + '--instrumentation-version' value is 0.86.0 or older. (default: --generate-service-name) - --[enable|disable]-telemetry Enable or disable the instrumentation preloader from sending the + --[enable|disable]-telemetry DEPRECATED: Enable or disable the instrumentation preloader from sending the 'splunk.linux-autoinstr.executions' metric to the collector. - Only applicable if the '--with-instrumentation' option is also specified. + Only applicable if the '--with-instrumentation' option is also specified and the + '--instrumentation-version' value is 0.86.0 or older. (default: --enable-telemetry) --[enable|disable]-profiler Enable or disable AlwaysOn Profiling. Only applicable if the '--with-instrumentation' or