Merge branch 'main' into gschatz-syn-kpis

Author: gschatz-splunk

admin/authentication/authentication-tokens/org-tokens.rst

@@ -237,7 +237,7 @@ To rotate an access token with the API, use the ``POST /token/{name}/rotate`` en
 
 .. code-block:: bash
 
-   curl -X  POST "https://api.{realm}.signalfx.com/v2/token/{name}/rotate?graceful={gracePeriod}" \
+   curl -X  POST "https://api.{realm}.signalfx.com/v2/token/{name}/rotate?graceful={gracePeriod}&secondsUntilExpiry={secondsUntilExpiry}" \
       -H "Content-type: application/json" \
       -H "X-SF-TOKEN: <your-user-session-api-token-value>"
 
@@ -247,6 +247,7 @@ Follow these steps:
 #. Enter your API session token in the ``your-user-session-api-token-value`` field. To find or create an API session token, see :ref:`admin-api-access-tokens`.
 #. Provide the name of the token you want to rotate in the ``name`` field.
 #. Optionally, provide a grace period, in seconds, in the ``gracePeriod`` field.
+#. Optionally, provide the seconds until your token expires in the ``secondsUntilExpiry`` field. This can be any value between 0 second and 5,676,000,000 seconds (18 years), inclusive. If left unspecified, the token remains valid for 30 days. 
 #. Call the API endpoint to rotate the token.
 
 For example, the following API call rotates ``myToken`` and sets a grace period of 604800 seconds (7 days) before the previous token secret expires.

apm/apm-spans-traces/span-formats.rst

@@ -98,19 +98,4 @@ For more information on the ingest API endpoints, see :new-page:`Send APM traces
 
 .. note:: You can also send trace data in OTLP format directly to Splunk Observability Cloud using the gRPC endpoint, either directly or from an OpenTelemetry Collector. See :ref:`grpc-data-ingest`.
 
-.. _apm-formats-smart-agent:
 
-Span formats compatible with the Smart Agent (deprecated)
-============================================================
-
-The Smart Agent can receive the following span formats with the ``signalfx-forwarder`` monitor:
-
-- Jaeger: gRPC and Thrift
-- Zipkin v1, v2 JSON
-
-The Smart Agent can export the following span formats using the ``writer`` exporter:
-
-- Zipkin v1, v2 JSON
-- SAPM
-
-To configure the Smart Agent for Splunk APM, see :ref:`smart-agent`.

gdi/monitors-databases/postgresql.rst

@@ -73,8 +73,7 @@ The following table shows the configuration options for the
       - no
       - ``list of strings``
       - List of databases to send database-specific metrics about. If
-         omitted, metrics about all databases will be sent. This is an
-         :ref:`overridable set <filtering-smart-agent>`
+         omitted, metrics about all databases will be sent. 
          (**default:** ``[*]``)
    - 
 

gdi/monitors-hosts/filesystems.rst

@@ -105,8 +105,7 @@ The following table shows the configuration options for this monitor.
       - ``fsTypes``
       - no
       - ``list of strings``
-      - The filesystem types to include. This is an
-         :ref:`overridable set <filtering-smart-agent>` If this is
+      - The filesystem types to include. If this is
          not set, the default value is the set of all
          **non-logical/virtual filesystems** on the system. On Linux
          this list is determined by reading the ``/proc/filesystems``
@@ -117,8 +116,7 @@ The following table shows the configuration options for this monitor.
       - ``mountPoints``
       - no
       - ``list of strings``
-      - The mount paths to include/exclude. This is an
-         :ref:`overridable set <filtering-smart-agent>` **Note**:
+      - The mount paths to include/exclude. **Note**:
          If you are using the hostFSPath option, do not include the
          ``/hostfs/`` mount in the filter. If both this and ``fsTypes``
          are specified, the two filters combine in an AND relationship.

gdi/monitors-network/net-io.rst

@@ -68,8 +68,7 @@ integration:
       - ``interfaces``
       - no
       - ``list of strings``
-      - The network interfaces to send metrics about. This is an
-         :ref:`overridable set <filtering-smart-agent>`
+      - The network interfaces to send metrics about. 
          (**default:**
          ``[* !/^lo\d*$/ !/^docker.*/ !/^t(un|ap)\d*$/ !/^veth.*$/ !/^Loopback*/]``)
 

gdi/opentelemetry/collector-addon/collector-addon-configure-instance.rst

@@ -0,0 +1,62 @@
+.. _collector-addon-configure-instance:
+.. _collector-addon-mode:
+
+*********************************************************************************************
+Configure the deployment mode of your Splunk Add-on Collector instance
+*********************************************************************************************
+
+.. meta::
+   :description: Configure the deployment mode of the Technical Add-on OpenTelemetry Collector instance
+
+.. toctree::
+   :maxdepth: 5
+   :hidden:
+
+The OpenTelemetry Collector has different :ref:`deployment modes <otel-deployment-mode>`:
+
+* Host monitoring (agent): This is the default value and the simplest configuration. The Splunk Add-on for the OpenTelemetry Collector, when configured as an agent, sends data to Splunk Observability Cloud.
+
+* Data forwarding (gateway): When configured as a gateway, your Splunk Add-on for the OpenTelemetry Collector collects data from one or more agents before forwarding it to Splunk Observability Cloud.
+
+* As an agent that sends data to a gateway: To use a gateway instance, you create one or more instances of Splunk add-on for the OpenTelemetry Collector as agents that send data to that gateway instance.
+
+.. _collector-addon-mode-agent:
+
+Deploy the Splunk Add-on for the OpenTelemetry Collector as an agent
+============================================================================================================================================
+
+As an agent, the OpenTelemetry Collector sends data directly to Splunk Observability Cloud. This is the default configuration. Learn more at :ref:`collector-agent-mode`.
+
+If your instance is not configured as an agent and you want to configure it as an agent, edit your inputs.conf file and update the variable ``Splunk_config`` to reflect your agent configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name is ``ta-agent-config.yaml``. If you are using a custom configuration file, provide that file name.
+
+.. _collector-addon-mode-gateway:
+
+Deploy the Splunk Add-on for the OpenTelemetry Collector as a gateway
+============================================================================================================================================
+
+If deployed as a gateway, the Collector instance can collect data from one or more Collector instances deployed as agents. The gateway instance then sends that data to Splunk Observability Cloud. Learn more at :ref:`collector-gateway-mode`.
+
+To configure your Splunk Add-on for OpenTelemetry Collector as a gateway:
+
+#. Edit your inputs.conf file to update the variable ``Splunk_config`` with your gateway configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name for the gateway file is ``ta-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
+
+#. Set the ``splunk_listen_interface`` value to ``0.0.0.0`` or to the specific IP address that sends data to this gateway in ``local/inputs.conf``.
+
+.. caution:: You must also configure one or more Collector instances as agents that send data to your new gateway. 
+
+.. _collector-addon-mode-send:
+
+Configure Splunk Add-on for OpenTelemetry Collector as an agent that sends data to a gateway
+============================================================================================================================================
+
+You can set up one or more Collector instances as agents that send data to another instance that is set up as a gateway. See more at :ref:`collector-agent-to-gateway`.
+
+To do this configure an instance that works as a gateway, and then one or more instances that operate as agents:
+
+#. Create your gateway, if you have not already done so. See :ref:`collector-addon-mode-gateway` for more information.
+
+#. Edit your inputs.conf file to update the variable ``Splunk_config`` to reflect your gateway configuration file name. You can find the default configuration file in your directory at ``/otelcol/config/``. The default file name for this configuration file is ``ta-agent-to-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
+
+#. In the README directory, open ``inputs.conf.spec`` and copy the attribute for the ``splunk_gateway_url``.
+
+#. Paste this value into ``ta-agent-to-gateway-config.yaml`` and then update the value for this setting with the gateway IP address.

gdi/opentelemetry/collector-addon/collector-addon-install.rst

@@ -11,7 +11,7 @@ Install the Technical Add-on for the Splunk OpenTelemetry Collector
    :maxdepth: 5
    :hidden:
 
-You can install the Splunk Add-on for the OpenTelemetry Collector to a :ref:`single <collector-addon-install-uf>` or to :ref:`multiple <collector-addon-install-server>` universal forwarder instances.
+You can download the Splunk Add-on for the OpenTelemetry Collector from :new-page:`Splunkbase <https://splunkbase.splunk.com/app/7125>` and install it to a :ref:`single <collector-addon-install-uf>` or to :ref:`multiple <collector-addon-install-server>` universal forwarder instances.
 
 The following applies:
 
@@ -94,56 +94,3 @@ Follow these steps to install the Splunk Add-on for the OpenTelemetry Collector
 
 #. In :guilabel:`Splunk Infrastructure Monitoring`, navigate to the host where you deployed the Splunk Add-on for the OpenTelemetry Collector and select it to explore its metrics and status. For more information, see :ref:`use-navigators-imm`.
 
-.. _collector-addon-mode:
-
-Configure the deployment mode of your Splunk Add-on Collector instance
-============================================================================================================================================
-
-The OpenTelemetry Collector has different :ref:`deployment modes <otel-deployment-mode>`:
-
-* Host monitoring (agent): This is the default value and the simplest configuration. The Splunk Add-on for the OpenTelemetry Collector, when configured as an agent, sends data to Splunk Observability Cloud.
-
-* Data forwarding (gateway): When configured as a gateway, your Splunk Add-on for the OpenTelemetry Collector collects data from one or more agents before forwarding it to Splunk Observability Cloud.
-
-* As an agent that sends data to a gateway: To use a gateway instance, you create one or more instances of Splunk add-on for the OpenTelemetry Collector as agents that send data to that gateway instance.
-
-.. _collector-addon-mode-agent:
-
-Deploy the Splunk Add-on for the OpenTelemetry Collector as an agent
-------------------------------------------------------------------------------------------------------------------------
-
-As an agent, the OpenTelemetry Collector sends data directly to Splunk Observability Cloud. This is the default configuration. Learn more at :ref:`collector-agent-mode`.
-
-If your instance is not configured as an agent and you want to configure it as an agent, edit your inputs.conf file and update the variable ``Splunk_config`` to reflect your agent configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name is ``ta-agent-config.yaml``. If you are using a custom configuration file, provide that file name.
-
-.. _collector-addon-mode-gateway:
-
-Deploy the Splunk Add-on for the OpenTelemetry Collector as a gateway
-------------------------------------------------------------------------------------------------------------------------
-
-If deployed as a gateway, the Collector instance can collect data from one or more Collector instances deployed as agents. The gateway instance then sends that data to Splunk Observability Cloud. Learn more at :ref:`collector-gateway-mode`.
-
-To configure your Splunk Add-on for OpenTelemetry Collector as a gateway:
-
-#. Edit your inputs.conf file to update the variable ``Splunk_config`` with your gateway configuration file name. You can find this file in your directory at ``/otelcol/config/``. The default file name for the gateway file is ``ta-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
-
-#. Set the ``splunk_listen_interface`` value to ``0.0.0.0`` or to the specific IP address that sends data to this gateway in ``local/inputs.conf``.
-
-.. caution:: You must also configure one or more Collector instances as agents that send data to your new gateway. 
-
-.. _collector-addon-mode-send:
-
-Configure Splunk Add-on for OpenTelemetry Collector as an agent that sends data to a gateway
-------------------------------------------------------------------------------------------------------------------------
-
-You can set up one or more Collector instances as agents that send data to another instance that is set up as a gateway. See more at :ref:`collector-agent-to-gateway`.
-
-To do this configure an instance that works as a gateway, and then one or more instances that operate as agents:
-
-#. Create your gateway, if you have not already done so. See :ref:`collector-addon-mode-gateway` for more information.
-
-#. Edit your inputs.conf file to update the variable ``Splunk_config`` to reflect your gateway configuration file name. You can find the default configuration file in your directory at ``/otelcol/config/``. The default file name for this configuration file is ``ta-agent-to-gateway-config.yaml``. If you are using a custom configuration file, provide that file name.
-
-#. In the README directory, open ``inputs.conf.spec`` and copy the attribute for the ``splunk_gateway_url``.
-
-#. Paste this value into ``ta-agent-to-gateway-config.yaml`` and then update the value for this setting with the gateway IP address.

gdi/opentelemetry/collector-addon/collector-addon-intro.rst

@@ -12,10 +12,12 @@ Splunk Add-On for the OpenTelemetry Collector
    :hidden:
 
    Install the Technical Add-on <collector-addon-install.rst>
+   Deployment modes <collector-addon-configure-instance.rst>
    Configure the Technical Add-on <collector-addon-configure.rst>
+   Upgrade the Technical Add-on <collector-addon-upgrade.rst>
    Troubleshooting <collector-addon-troubleshooting.rst>
 
-Use the Splunk Add-on for the OpenTelemetry Collector to collect traces and metrics for Splunk Observability Cloud.
+Use the Splunk Add-on for the OpenTelemetry Collector to collect traces and metrics with Splunk Observability Cloud.
 
 You have two ways to install and configure the Splunk Add-on for the OpenTelemetry Collector:
 

gdi/opentelemetry/collector-addon/collector-addon-upgrade.rst

@@ -0,0 +1,21 @@
+.. _collector-addon-upgrade:
+
+*********************************************************************************************
+Upgrade the Technical Add-on for the Splunk OpenTelemetry Collector
+*********************************************************************************************
+
+.. meta::
+   :description: Upgrade the Technical Add-on for the Splunk Distribution of the OpenTelemetry Collector.
+
+.. toctree::
+   :maxdepth: 5
+   :hidden:
+
+To upgrade the Technical Add-on for the Splunk Distribution of the OpenTelemetry Collector using a deployment server follow these steps:
+
+#. Download the upgraded version of the Splunk Add-on for the OpenTelemetry Collector from Splunkbase. See :new-page:`Splunkbase's Splunk Add-on for the OpenTelemetry Collector <https://splunkbase.splunk.com/app/7125>`.
+#. Expand your downloaded file.
+#. Copy the expanded Splunk_TA_otel/ folder to the :guilabel:`SPLUNK_HOME > etc > deployment apps` directory.
+#. Restart the deployment server.
+
+

gdi/opentelemetry/collector-kubernetes/kubernetes-config-advanced.rst

@@ -503,3 +503,32 @@ Cluster Receiver support
 The Cluster receiver is a 1-replica deployment of the OpenTelemetry Collector. Because the Kubernetes control plane can select any available node to run the cluster receiver pod (unless ``clusterReceiver.nodeSelector`` is explicitly set to pin the pod to a specific node), ``hostPath`` or ``local`` volume mounts don't work for such environments.
 
 Data persistence is currently not applicable to the Kubernetes cluster metrics and Kubernetes events.
+
+Monitor OpenShift infrastructure nodes
+============================================
+
+By default, the Splunk Distribution of OpenTelemetry Collector for Kubernetes doesn't collect data from OpenShift infrastructure nodes. 
+
+You can customize the Collector Helm Chart file to activate data collection from OpenShift infrastructure nodes. To do so, complete the following steps:
+
+#. Open your values.yaml file for the Helm Chart.
+#. Copy and paste the following YAML snippet into the values.yaml file:
+
+    .. code-block:: yaml
+
+      tolerations:
+        - key: node-role.kubernetes.io/master
+          effect: NoSchedule
+        - key: node-role.kubernetes.io/control-plane
+          effect: NoSchedule
+        - key: node-role.kubernetes.io/infra
+          effect: NoSchedule
+          operator: Exists
+
+#. Install the Collector using the Helm Chart:
+
+    .. code-block:: bash
+
+      helm install my-splunk-otel-collector --values values.yaml splunk-otel-collector-chart/splunk-otel-collector
+
+.. note:: Monitoring OpenShift infrastructure nodes might pose a security risk depending on which method you used to create the Kubernetes environment.