Splunk OpenTelemetry JS 3.0 breaking changes

Learn about the latest changes for Splunk OpenTelemetry JS version 3.0.

Update to Splunk OpenTelemetry JS version 3.0

To update your Splunk Distribution for OpenTelemetry JS agent to version 3.0, see :ref:`instrument-nodejs-applications-3x` and install the latest version of the Splunk OpenTelemetry JS agent.

Default port and protocol changes

In the Node.js 3.x instrumentation, the default protocol changed from gRPC to http/protobuf.

If a custom configuration overrides the default endpoint setting, you must make sure of the following:

  1. Verify that the Node.js agent configuration is correct:
    1. Verify that you are using the correct port for the selected protocol:
      gRPC4317
      http/protobuf4318

    2. Verify that the custom endpoint uses the correct port for the selected protocol. For example, OTEL_EXPORTER_OTLP_ENDPOINT=http://<host>:4318

    3. Verify that the custom protocol configuration uses the correct protocol. For example, OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf

  2. In the OTel Collector configuration file, verify that the associated OTLP receiver protocols match those used by the Node.js agent. Here is an example OTLP receiver configuration in the OTel Collector file:
    otlp:
 protocols:
  grpc:
   endpoint: "${SPLUNK_LISTEN_INTERFACE}:4317"
  http:
   endpoint: "${SPLUNK_LISTEN_INTERFACE}:4318"

Troubleshooting

For information about troubleshooting issues with the Splunk OpenTelemetry JS agent, see Troubleshoot Node.js instrumentation for Splunk Observability Cloud.