Skip to content

Commit

Permalink
Merge pull request #1129 from splunk/repo-sync
Browse files Browse the repository at this point in the history
Pulling refs/heads/main into main
  • Loading branch information
aurbiztondo-splunk authored Jan 15, 2024
2 parents 7cf2c86 + 71fdfda commit 2f50e45
Show file tree
Hide file tree
Showing 21 changed files with 132 additions and 156 deletions.
2 changes: 1 addition & 1 deletion admin/subscription-usage/parent-child-orgs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ To view the available usage reports:
:width: 70%
:alt: The usage report shows the parent org data separate from the child org usage data.

For more details about Service Bureau or parent-child orgs, contact your Account team or Splunk Support.
For more details about parent-child orgs, contact your Account team or Splunk Support.

.. note:: To see child org metrics, refer to :ref:`Organization metrics in child orgs <org-metrics-child>`.
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ You can install the ``splunk-otel-auto-instrumentation`` package in the followin
Next, ensure the service is running and restart your application. See :ref:`verify-install` and :ref:`start-restart-java-apps`.

.. tab:: ``systemd``
.. tab:: systemd

Run the installer script with the ``--with-systemd-instrumentation`` option, as shown in the following example. Replace ``<SPLUNK_REALM>`` and ``<SPLUNK_ACCESS_TOKEN>`` with your Splunk Observability Cloud realm and token, respectively.

Expand Down Expand Up @@ -146,7 +146,7 @@ You can install the ``splunk-otel-auto-instrumentation`` package in the followin

.. tab:: Chef

See :ref:`chef-zero-config-java`.
See :ref:`chef-zero-config`.

.. tab:: Puppet

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ The following examples demonstrate how to set the attribute using each method:

.. tab:: Environment option


Set the ``environment`` option in the ``values.yaml`` file. This adds the ``deployment.environment`` attribute to all telemetry data the Collector receives, including data from automatically-instrumented pods.

.. code-block:: yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,61 +43,74 @@ The installer script installs the Node.js package using the ``npm install`` comm
--npm-path /custom/path/to/npm
.. note:: By default, auto instrumentation is activated for both Java and Node.js when using the installer script. To deactivate auto instrumentation for Java, add the ``--without-instrumentation-sdk java`` or ``--with-instrumentation-sdk node`` option in the installer script command.
.. tabs::

.. tabs::
.. tab:: Installer script

.. tab:: System-wide
Using the installer script, you can install the auto instrumentation package for Node.js and activate auto instrumentation for Node.js for either all supported Node.js applications on the host via the system-wide method or for only Node.js applications running as ``systemd`` services.

To install the package, run the Collector installer script with the ``--with-instrumentation`` option. The installer script will install the Collector and the Node.js agent from the Splunk Distribution of OpenTelemetry JS. The Node.js agent automatically loads when a Node.js application starts on the local machine.
.. note:: By default, auto instrumentation is activated for both Java and Node.js when using the installer script. To deactivate auto instrumentation for Java, add the ``--without-instrumentation-sdk java`` or ``--with-instrumentation-sdk node`` option in the installer script command.

Run the installer script with the ``--with-instrumentation`` option, as shown in the following example. Replace ``<SPLUNK_REALM>`` and ``<SPLUNK_ACCESS_TOKEN>`` with your Splunk Observability Cloud realm and token, respectively.
.. tabs::

.. code-block:: bash
.. tab:: System-wide

curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>
To install the package, run the Collector installer script with the ``--with-instrumentation`` option. The installer script will install the Collector and the Node.js agent from the Splunk Distribution of OpenTelemetry JS. The Node.js agent automatically loads when a Node.js application starts on the local machine.

.. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.
Run the installer script with the ``--with-instrumentation`` option, as shown in the following example. Replace ``<SPLUNK_REALM>`` and ``<SPLUNK_ACCESS_TOKEN>`` with your Splunk Observability Cloud realm and token, respectively.

The system-wide auto instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``.
.. code-block:: bash
You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example:
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>
.. code-block:: bash
:emphasize-lines: 4
.. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --deployment-environment prod \
--realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN> \
--enable-profiler --enable-profiler-memory --enable-metrics
The system-wide auto instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``.

Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`.
You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example:

.. tab:: ``systemd``
.. code-block:: bash
:emphasize-lines: 4
Run the installer script with the ``--with-systemd-instrumentation`` option, as shown in the following example. Replace ``<SPLUNK_REALM>`` and ``<SPLUNK_ACCESS_TOKEN>`` with your Splunk Observability Cloud realm and token, respectively.

.. code-block:: bash
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --deployment-environment prod \
--realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN> \
--enable-profiler --enable-profiler-memory --enable-metrics
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-systemd-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>
The ``systemd`` auto instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``.
Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`.

.. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.
.. tab:: systemd

You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example:
Run the installer script with the ``--with-systemd-instrumentation`` option, as shown in the following example. Replace ``<SPLUNK_REALM>`` and ``<SPLUNK_ACCESS_TOKEN>`` with your Splunk Observability Cloud realm and token, respectively.

.. code-block:: bash
.. code-block:: bash
:emphasize-lines: 4
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-systemd-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>
The ``systemd`` auto instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``.

.. note:: If you have a Log Observer entitlement or wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option.

You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example:

.. code-block:: bash
:emphasize-lines: 4
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-systemd-instrumentation --deployment-environment prod \
--realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN> \
--enable-profiler --enable-profiler-memory --enable-metrics
Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`.


.. tab:: Chef

See :ref:`chef-zero-config`.

curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-systemd-instrumentation --deployment-environment prod \
--realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN> \
--enable-profiler --enable-profiler-memory --enable-metrics

Next, ensure the collector service is running and restart your Node.js application(s). See :ref:`verify-js-agent-install` and :ref:`start-restart-js-apps`.

.. _verify-js-agent-install:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ Splunk OpenTelemetry Zero Config Auto Instrumentation for Node.js
.. toctree::
:hidden:

Kubernetes <auto-instrumentation-nodejs-k8s>
Linux <auto-instrumentation-nodejs-linux>
Kubernetes <auto-instrumentation-nodejs-k8s>


Splunk OpenTelemetry (OTel) Zero Configuration Auto Instrumentation for Node.js automatically instruments supported Node.js libraries in running applications to capture distributed traces.
The Splunk OpenTelemetry Collector receives the distributed traces and forwards them to Splunk Application Performance Monitoring (APM) in Splunk Observability Cloud.
Expand Down
Loading

0 comments on commit 2f50e45

Please sign in to comment.