Skip to content

Commit

Permalink
Merge pull request #1053 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 Nov 14, 2023
2 parents 9015922 + 8f3bdc7 commit 9dc8f3d
Show file tree
Hide file tree
Showing 51 changed files with 846 additions and 379 deletions.
5 changes: 0 additions & 5 deletions _includes/admin/roles_data_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@
- No
- No

* - :strong:`View Incident Managent`
- Yes
- No
- No
- No

* - :strong:`View APM MetricSets`
- Yes
Expand Down
5 changes: 0 additions & 5 deletions _includes/admin/roles_data_configuration1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,6 @@
- Yes


* - :strong:`View Incident Managent`
- Yes
- No


* - :strong:`View APM MetricSets`
- Yes
- Yes
Expand Down
25 changes: 25 additions & 0 deletions data-visualization/dashboards/dashboards-list.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. _dashboards-list-imm:

*******************************************************
Dashboards available
*******************************************************

.. meta::
:description: List of built-in dashboards available to you

Dashboards are groupings of charts and visualizations of metrics. Both Navigators and Dashboard groups contain multiple dashboards. To learn more about where dashboards fit in the Infrastructure Monitoring hierarchy, see :ref:`get-started-infrastructure`.


List of built-in dashboards
-----------------------------------
.. raw:: html

<div class="metrics-config" url="https://raw.githubusercontent.com/splunk/o11y-gdi-metadata/main/ootb/dashboards_builtin_content.yaml" data-main-column="dashboard_group" data-secondary-column="key" data-column-3="importQualifiers" data-header-1="Category" data-header-2="Dashboard" data-header-3="ImportQualifiers (Required data onboarding conditions)"></div>








7 changes: 4 additions & 3 deletions data-visualization/dashboards/dashboards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ Dashboards in Splunk Observability Cloud
Best practices for creating dashboards<dashboards-best-practices>
dashboards-import-export
Share, clone, and mirror dashboards<dashboard-share-clone-mirror>

Dashboards available<dashboards-list>


Dashboards are groupings of charts and visualizations of metrics. Well-designed dashboards can provide useful and actionable insight into your system at a glance. Dashboards can be complex or contain just a few charts that drill down only into the data you want to see.
Dashboards are groupings of charts and visualizations of metrics. Well-designed dashboards provide useful and actionable insight into your system at a glance. Dashboards can be complex or contain just a few charts that drill down only into the data you want to see.

Continue with the following sections to learn how to use, create, and modify dashboards to suit your requirements.
Continue with the following topics to learn how to use, create, and modify dashboards to suit your requirements.

- :ref:`dashboard-basics`
- :ref:`built-in-dashboards`
Expand All @@ -39,5 +39,6 @@ Continue with the following sections to learn how to use, create, and modify das
- :ref:`dashboards-best-practices`
- :ref:`dashboards-import-export`
- :ref:`dashboard-share-clone-mirror`
- :ref:`dashboards-list-imm`


Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ The following example shows how to update a deployment to expose environment var
- name: OTEL_RESOURCE_ATTRIBUTES
value: "deployment.environment=<environmentName>"
.. note:: You can also deploy instrumentation using the Kubernetes Operator. See :ref:`auto-instrumentation-operator`.
.. note:: You can also deploy instrumentation using the Kubernetes Operator. See :ref:`auto-instrumentation-java-k8s`.

.. _java-agent-cloudfoundry:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: /_includes/gdi/zero-config-preview-header.rst


.. _auto-instrumentation-dotnet:

Expand Down
267 changes: 129 additions & 138 deletions gdi/opentelemetry/auto-instrumentation/auto-instrumentation-java-k8s.rst

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: /_includes/gdi/zero-config-preview-header.rst



.. _auto-instrumentation-java-linux:
Expand Down Expand Up @@ -30,37 +30,79 @@ You can install the ``splunk-otel-auto-instrumentation`` package in the followin

.. tab:: Installer script

To install the package, run the Collector installer script with the ``--with-instrumentation`` option. The installer script will install the Collector and the Java agent from the Splunk Distribution of OpenTelemetry Java. The Java agent is then loaded automatically when a Java application starts on the local machine.
Using the installer script, you can install the auto instrumentation package for Java and activate auto instrumentation for Java for either all supported Java applications on the host via the system-wide method or for only Java applications running as ``systemd`` services.

.. note:: By default, auto instrumentation is activated for both Java and Node.js when using the installer script. To deactivate auto instrumentation for Node.js, add the ``--without-instrumentation-sdk node`` or ``--with-instrumentation-sdk java`` option in the installer script command.

.. tabs::

.. tab:: System-wide

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.

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.
.. code-block:: bash
.. 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 --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \
sudo sh /tmp/splunk-otel-collector.sh --with-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>
.. 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.

.. 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.
The system-wide auto instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/java.conf``.

To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment <env>`` option. Replace ``<env>`` with the desired attribute value, for example, ``prod``, as shown in the following example:
To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment <env>`` option. Replace ``<env>`` with the desired attribute value, for example, ``prod``, as shown in the following example:

.. code-block:: bash
:emphasize-lines: 2
.. code-block:: bash
:emphasize-lines: 2
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>
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>
You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example:
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
.. 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-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-instrumentation --deployment-environment prod \
--realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN> \
--enable-profiler --enable-profiler-memory --enable-metrics
Next, ensure the service is running and restart your application. See :ref:`verify-install` and :ref:`start-restart-java-apps`.

Next, ensure the service is running and restart your application. See :ref:`verify-install` and :ref:`start-restart-java-apps`.
.. 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.

.. 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-systemd-instrumentation --realm <SPLUNK_REALM> -- <SPLUNK_ACCESS_TOKEN>
The ``systemd`` instrumentation 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.

To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment <env>`` option. Replace ``<env>`` with the desired attribute value, for example, ``prod``, as shown in the following example:

.. code-block:: bash
:emphasize-lines: 2
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>
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 service is running and restart your application. See :ref:`verify-install` and :ref:`start-restart-java-apps`.

.. tab:: Linux packages (deb, rpm)

Expand All @@ -75,11 +117,11 @@ You can install the ``splunk-otel-auto-instrumentation`` package in the followin
.. tabs::

.. code-tab:: bash Debian

sudo dpkg -i <path to splunk-otel-auto-instrumentation deb>

.. code-tab:: bash RPM

sudo rpm -ivh <path to splunk-otel-auto-instrumentation rpm>

3. Edit the ``/etc/otel/collector/splunk-otel-collector.conf`` file to set the ``SPLUNK_ACCESS_TOKEN`` and ``SPLUNK_REALM`` variables to the values you got earlier. If the file does not exist, use the provided sample at ``/etc/otel/collector/splunk-otel-collector.conf.example`` as a starting point.
Expand All @@ -93,7 +135,7 @@ You can install the ``splunk-otel-auto-instrumentation`` package in the followin

.. code-block:: bash
sudo systemctl start splunk-otel-collector
sudo systemctl start splunk-otel-collector
5. :ref:`verify-install`.
6. :ref:`start-restart-java-apps`.
Expand Down Expand Up @@ -155,7 +197,7 @@ The default settings for zero config autoinstrumentation are sufficient for most

The installation package contains the following artifacts:

- The configuration file at ``/usr/lib/splunk-instrumentation/instrumentation.conf``
- The configuration file at ``/etc/splunk/zeroconfig/java.conf``. This is only applicable for the system-wide method.
- The :new-page:`Java Instrumentation Agent <https://github.com/signalfx/splunk-otel-java>` at ``/usr/lib/splunk-instrumentation/splunk-otel-javaagent.jar``
- The shared instrumentation library at ``/usr/lib/splunk-instrumentation/libsplunk.so```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Arnau creates the ``spring-petclinic`` namespace and deploys the related Java ap
2. Deploy and configure the Collector
======================================================================

Arnau follows the steps described in :ref:`auto-instrumentation-operator` to set up Auto Intrumentation for their clinic apps.
Arnau follows the steps described in :ref:`auto-instrumentation-java-k8s` to set up Auto Intrumentation for their clinic apps.

After completing the deployment, Arnau is able to see the results using :ref:`APM <get-started-apm>`.

Expand All @@ -48,9 +48,4 @@ After completing the deployment, Arnau is able to see the results using :ref:`AP
Summary
======================================================================

Arnau uses the Collector and the upstream Kubernetes Operator to auto-instrument their Java applications and see the results in APM dashboards.

Learn more
======================================================================

To install the Operator for Auto Instrumentation, see :ref:`Install the Collector with the Kubernetes Operator <auto-instrumentation-operator>`.
Arnau uses the Collector and the upstream Kubernetes Operator to auto-instrument their Java applications and see the results in APM dashboards.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: /_includes/gdi/zero-config-preview-header.rst


.. _auto-instrumentation-java:

Expand Down
Loading

0 comments on commit 9dc8f3d

Please sign in to comment.