Skip to content

Commit 8591fb8

Browse files
some updates
1 parent e733557 commit 8591fb8

File tree

3 files changed

+23
-8
lines changed

3 files changed

+23
-8
lines changed

gdi/get-data-in/application/nodejs/breaking-changes.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ Node.js 3.0 breaking changes
77
.. meta::
88
:description:
99

10+
Update to Splunk OpenTelemetry JS version 3.0
11+
==========================================================
12+
13+
To update your Splunk Distribution for OpenTelemetry JS agent to version 3.0, see :ref:`instrument-nodejs-application` and install the latest version of the Splunk OpenTelemetry JS agent.
14+
1015
Default port and protocol changes
1116
=================================
1217

@@ -21,11 +26,11 @@ If a custom configuration overrides the default endpoint setting, you must make
2126
* gRPC: 4317
2227
* http/protobuf: 4318
2328

24-
#. Verify that the custom endpoint configuration uses the correct port. For example: ``otel.exporter.otlp.endpoint=http://<host>:4318``.
29+
#. Verify that the custom endpoint configuration uses the correct port. For example: ``OTEL_EXPORTER_OTLP_ENDPOINT=http://<host>:4318``.
2530

26-
#. Verify that the custom protocol configuration uses the correct protocol. For example: ``otel.exporter.otlp.protocol=http/protobuf``.
31+
#. Verify that the custom protocol configuration uses the correct protocol. For example: ``OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf``.
2732

28-
#. In the OTel Collector configuration file, verify that the associated OTLP receiver protocols match those used by the Java agent. Here is an example OTLP receiver configuration in the OTel Collector file:
33+
#. 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:
2934

3035
.. code-block:: yaml
3136

gdi/get-data-in/application/nodejs/configuration/advanced-nodejs-otel-configuration.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,19 @@ The following settings control tracing limits and attributes:
107107
- ``serviceName``
108108
- Name of the service or application you're instrumenting. Takes precedence over the service name defined in the ``OTEL_RESOURCE_ATTRIBUTES`` variable.
109109
* - OTEL_RESOURCE_ATTRIBUTES
110-
- Not applicable
110+
- Use the ``resource`` method in the ``start()`` function to pass resource attributes. For example,
111+
112+
.. code-block:: js
113+
114+
import { start } from '@splunk/otel';
115+
import { Resource } from '@opentelemetry/resources';
116+
117+
start({
118+
serviceName: 'example',
119+
resource: (detectedResource) => {
120+
return detectedResource.merge(new Resource({ 'service.version': '0.2.0' }));
121+
},
122+
});
111123
- Comma-separated list of resource attributes added to every reported span. For example, ``key1=val1,key2=val2``.
112124
* - OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT
113125
- Not applicable
@@ -248,10 +260,6 @@ Configuring an existing metrics client to send custom metrics
248260

249261
You can use an existing SignalFx client for sending custom metrics instead of creating and configuring a new one.
250262

251-
To configure an existing client, pass the following data to the ``start()`` function:
252-
253-
- ``signalfx``: A JavaScript object with optional ``client`` and ``dimensions`` fields. The ``dimensions`` object adds a predefined dimension for each data point. The format for ``dimensions`` is ``{key: value, ...}``.
254-
255263
The following is a list of dimensions added by default:
256264

257265
- ``service``: See ``serviceName`` in :ref:`trace-configuration-nodejs`.

gdi/get-data-in/application/nodejs/get-started.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Instrument Node.js applications for Splunk Observability Cloud
2323
Migrate from the SFx Tracing Library <troubleshooting/migrate-signalfx-nodejs-agent-to-otel>
2424
Version 2.X (deprecated) <version2x/get-started>
2525

26+
.. note:: The Splunk OpenTelemetry JS version 3.0 contains a set of breaking changes, including an update for semantic protocols. To view these changes and learn how to update to version 3.0, see :ref:`nodejs-3x-breaking-changes`. Previous versions of the agent, such as version 2.15, are incompatible with the protocol changes in version 3.0.
27+
2628
The Splunk Distribution of OpenTelemetry JS provides a Node.js SDK that automatically adds APM instrumentation to your Node.js application. The instrumentation captures traces, runtime metrics, and CPU and memory profiles and sends them to Splunk Observability Cloud.
2729

2830
To instrument your Node.js application, follow these steps:

0 commit comments

Comments
 (0)