Skip to content

Commit

Permalink
Mark old instrumentation options as deprecated in installer script us…
Browse files Browse the repository at this point in the history
…age (#3851)

* Mark old instrumentation options as deprecated in installer script usage

* Update CHANGELOG.md for deprecated options
  • Loading branch information
jeffreyc-splunk authored Oct 30, 2023
1 parent d10a7a0 commit 500d0ce
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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 <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))
Expand Down
12 changes: 7 additions & 5 deletions internal/buildscripts/packaging/installer/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 500d0ce

Please sign in to comment.