Change installer flag to use --with[out]-instrumentation-sdk (#3841)

* Change installer flag to use --with[out]-instrumentation-sdk * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Paulo Janotti <pjanotti@splunk.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Paulo Janotti <pjanotti@splunk.com> * remove extraneous then * Add exit 1 to exit with an error code after printing usage * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> * Update internal/buildscripts/packaging/installer/install.sh Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com> --------- Co-authored-by: Paulo Janotti <pjanotti@splunk.com> Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com>
signalfx · Oct 30, 2023 · d6c47db · d6c47db
1 parent 500d0ce
commit d6c47db
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,13 +40,13 @@
     the `libsplunk.so` shared object library (default: `--without-systemd-instrumentation`)
   - Initial support for [Splunk OpenTelemetry Auto Instrumentation for Node.js](https://github.com/signalfx/splunk-otel-js):
     - Activated by default if the `--with-instrumentation` or `--with-systemd-instrumentation` option is specified.
-    - Use the `--without-node-instrumentation` option to explicitly skip Node.js.
+    - Use the `--without-instrumentation-sdk node` option to explicitly skip Node.js.
     - `npm` is required to install the Node.js Auto Instrumentation package. If the `npm` is not installed, Node.js will
       be skipped automatically.
     - By default, the Node.js Auto Instrumentation package is installed with the `npm install --global` command. Use the
       `--npm-command "<command>"` option to specify a custom command.
   - Auto Instrumentation for Java is also activated by default if the `--with-instrumentation` or
-    `--with-systemd-instrumentation` option is specified. Use the `--without-java-instrumentation` option to skip Java.
+    `--with-systemd-instrumentation` option is specified. Use the `--without-instrumentation-sdk java` option to skip Java.
   - `--otlp-endpoint host:port`: Set the OTLP gRPC endpoint for captured traces (default: `http://LISTEN_INTERFACE:4317`
     where `LISTEN_INTERFACE` is the value from the `--listen-interface` option if specified, or `127.0.0.1` otherwise)
   - See [Linux Installer Script](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/getting-started/linux-installer.md)

diff --git a/docs/getting-started/linux-installer.md b/docs/getting-started/linux-installer.md
@@ -332,11 +332,11 @@ of the following options:
 
 By default, both the Java and Node.js Auto Instrumentation agents will be
 installed and activated. Run the installer script with either the
-`--without-java-instrumentation` or `--without-node-instrumentation` option to
+`--without-instrumentation-sdk java` or `--without-instrumentation-sdk node` option to
 skip installation and activation of the respective agent. For example:
 ```sh
 curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
-sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --without-node-instrumentation --realm SPLUNK_REALM -- SPLUNK_ACCESS_TOKEN
+sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --without-instrumentation-sdk node --realm SPLUNK_REALM -- SPLUNK_ACCESS_TOKEN
 ```
 
 Additional options include:
@@ -363,7 +363,7 @@ following are required:
   `npm` is not installed or not found in the user's default `PATH`, the
   installer script will automatically skip installation and configuration of
   the Node.js agent. Run the installer script with the
-  `--without-node-instrumentation` option to explicitly skip Node.js.
+  `--without-instrumentation-sdk node` option to explicitly skip Node.js.
 - By default, the Node.js Auto Instrumentation package will be installed with
   the `npm install --global` command. Run the installer script with the
   `--npm-command "<command>"` option to specify a custom command (wrapped in

diff --git a/internal/buildscripts/packaging/installer/install.sh b/internal/buildscripts/packaging/installer/install.sh
@@ -871,12 +871,13 @@ Auto Instrumentation:
                                         applications running as systemd services.
                                         Cannot be combined with the '--with-instrumentation' option.
                                         (default: --without-systemd-instrumentation)
-  --with[out]-java-instrumentation      Whether to enable Auto Instrumentation for Java.
-                                        (default: --with-java-instrumentation if --with-instrumentation or
+  --with[out]-instrumentation-sdk "<s>" Whether to enable Auto Instrumentation for a specific language. This option
+                                        takes a comma separated set of values representing supported
+                                        auto-instrumentation SDKs. Currently supported: java,node.
+                                        Use --with-instrumentation-sdk to enable only the specified language(s),
+                                        for example "--with-instrumentation-sdk java".
+                                        (default: --with-instrumentation-sdk "java,node" if --with-instrumentation or
                                         --with-systemd-instrumentation is also specified)
-  --with[out]-node-instrumentation      Whether to enable Auto Instrumentation for Node.js.
-                                        (default: --with-node-instrumentation if --with-instrumentation or
-                                        --with-systemd-instrumentation' is also specified)
   --npm-command "<command>"             If Auto Instrumentation for Node.js is enabled, npm is required to install the
                                         included Splunk OpenTelemetry Auto Instrumentation for Node.js package with the
                                         following command:
@@ -1197,17 +1198,35 @@ parse_args_and_install() {
       --without-systemd-instrumentation)
         with_systemd_instrumentation="false"
         ;;
-      --with-java-instrumentation)
-        with_java_instrumentation="true"
-        ;;
-      --without-java-instrumentation)
+      --with-instrumentation-sdk)
         with_java_instrumentation="false"
-        ;;
-      --with-node-instrumentation)
-        with_node_instrumentation="true"
-        ;;
-      --without-node-instrumentation)
         with_node_instrumentation="false"
+        for lang in $(echo "$2" | tr ',' ' '); do
+            if [ "$lang" = "java" ]; then
+                with_java_instrumentation="true"
+            elif [ "$lang" = "node" ]; then
+                with_node_instrumentation="true"
+            else
+                usage
+                echo "[ERROR] Unknown instrumentation SDK: $lang" >&2
+                exit 1
+            fi
+        done
+        shift 1
+        ;;
+      --without-instrumentation-sdk)
+        for lang in $(echo "$2" | tr ',' ' '); do
+            if [ "$lang" = "java" ]; then
+                with_java_instrumentation="false"
+            elif [ "$lang" = "node" ]; then
+                with_node_instrumentation="false"
+            else
+                usage
+                echo "[ERROR] Unknown instrumentation SDK: $lang" >&2
+                exit 1
+            fi
+        done
+        shift 1
         ;;
       --npm-command)
         npm_command="$2"
@@ -1297,13 +1316,13 @@ parse_args_and_install() {
 
   if [ "$with_instrumentation" = "true" ]; then
     if [ "$with_java_instrumentation" = "false" ] && [ "$with_node_instrumentation" = "false" ]; then
-      echo "[ERROR] The --with-instrumentation option was specified, but both --without-java-instrumentation and --without-node-instrumentation options were also specified." >&2
+      echo "[ERROR] The --with-instrumentation option was specified, but --without-instrumentation-sdk java,node was also specified." >&2
       echo "[ERROR] At least one language must be enabled for auto instrumentation" >&2
       exit 1
     fi
   elif [ "$with_systemd_instrumentation" = "true" ]; then
     if [ "$with_java_instrumentation" = "false" ] && [ "$with_node_instrumentation" = "false" ]; then
-      echo "[ERROR] The --with-systemd-instrumentation option was specified, but both --without-java-instrumentation and --without-node-instrumentation options were also specified." >&2
+      echo "[ERROR] The --with-systemd-instrumentation option was specified, but --without-instrumentation-sdk java,node was also specified." >&2
       echo "[ERROR] At least one language must be enabled for auto instrumentation" >&2
       exit 1
     fi