Merge pull request #2369 from splunk/urbiz-OD6197-gdi-ui-preps

aurbiztondo-splunk · web-flow · commit c409a302069c · 2024-10-04T09:35:10.000+02:00
[6197]: GDI UI - Fixing spaces and format
diff --git a/gdi/monitors-cache/opcache.rst b/gdi/monitors-cache/opcache.rst
@@ -6,10 +6,7 @@ OPcache
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Collectd OPcache monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``collectd/opcache`` monitor type to retrieve metrics from OPcache using
-the ``opcache_get_status()`` function, which improves PHP performance by
-storing precompiled script bytecode in shared memory.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``collectd/opcache`` monitor type to retrieve metrics from OPcache using the ``opcache_get_status()`` function, which improves PHP performance by storing precompiled script bytecode in shared memory.
 
 This integration is available on Kubernetes and Linux.
 
diff --git a/gdi/monitors-databases/apache-spark.rst b/gdi/monitors-databases/apache-spark.rst
@@ -17,11 +17,7 @@ endpoints:
 -  Mesos
 -  Hadoop YARN
 
-This collectd plugin is not compatible with Kubernetes cluster mode. You need
-to select distinct monitor configurations and discovery rules
-for primary and worker processes. For the primary configuration, set
-``isMaster`` to ``true``. When you run Apache Spark on Hadoop YARN, this
-integration can only report application metrics from the primary node.
+This collectd plugin is not compatible with Kubernetes cluster mode. You need to select distinct monitor configurations and discovery rules for primary and worker processes. For the primary configuration, set ``isMaster`` to ``true``. When you run Apache Spark on Hadoop YARN, this integration can only report application metrics from the primary node.
 
 This integration is only available on Linux.
 
diff --git a/gdi/monitors-databases/etcd.rst b/gdi/monitors-databases/etcd.rst
@@ -6,11 +6,7 @@ etcd server
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the etcd monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-etcd monitor type to report etcd server metrics under the ``/metrics``
-path on its client port. Optionally, you can ediy location using
-``--listen-metrics-urls``. This integration only collects metrics from
-the Prometheus endpoint.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the etcd monitor type to report etcd server metrics under the ``/metrics`` path on its client port. Optionally, you can edit the location using ``--listen-metrics-urls``. This integration only collects metrics from the Prometheus endpoint.
 
 Benefits
 --------
diff --git a/gdi/monitors-databases/hadoop.rst b/gdi/monitors-databases/hadoop.rst
@@ -6,7 +6,7 @@ Hadoop
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the hadoop monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
 Hadoop monitor type to collect metrics from the following components of
 a Hadoop 2.0 or higher cluster:
 
@@ -17,8 +17,7 @@ a Hadoop 2.0 or higher cluster:
 -  MapReduce Jobs
 
 This integration uses the REST API. If a remote JMX port is exposed in
-the Hadoop cluster, then you can also configure the ``hadoopjmx``
-monitor to collect additional metrics about the Hadoop cluster.
+the Hadoop cluster, then you can also configure the ``hadoopjmx`` monitor to collect additional metrics about the Hadoop cluster.
 
 This integration is only available on Kubernetes and Linux.
 
diff --git a/gdi/monitors-databases/logparser.rst b/gdi/monitors-databases/logparser.rst
@@ -7,8 +7,7 @@ Logparser
    
    :description: Use this Splunk Observability Cloud integration for the telegraf/logparser plugin monitor. See benefits, install, configuration, and metrics.
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``telegraf/logparser`` monitor type to tail log files.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``telegraf/logparser`` monitor type to tail log files.
 
 This integration is based on the Telegraf logparser plugin, and all
 emitted metrics have the plugin dimension set to ``telegraf-logparser``.
diff --git a/gdi/monitors-databases/logstash.rst b/gdi/monitors-databases/logstash.rst
@@ -6,9 +6,7 @@ Logstash
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Logstash monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``logstash`` monitor type to monitor the health and performance of
-Logstash deployments through Logstash Monitoring APIs.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``logstash`` monitor type to monitor the health and performance of Logstash deployments through Logstash Monitoring APIs.
 
 Installation
 ------------
diff --git a/gdi/monitors-databases/postgresql.rst b/gdi/monitors-databases/postgresql.rst
@@ -12,9 +12,7 @@ PostgreSQL (deprecated)
 
    To monitor your PostgreSQL databases you can use the native OpenTelemetry PostgreSQL receiver instead. See more at :ref:`postgresql-receiver`.
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``postgresql`` monitor type to pull metrics from all PostgreSQL
-databases from a specific Postgres server instance using SQL queries.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``postgresql`` monitor type to pull metrics from all PostgreSQL databases from a specific Postgres server instance using SQL queries.
 
 Configuration settings
 ----------------------
diff --git a/gdi/monitors-databases/redis.rst b/gdi/monitors-databases/redis.rst
@@ -10,8 +10,7 @@ Redis (deprecated)
 
    To monitor your Redis databases, you can instead use the native OpenTelemetry Redis receiver. To learn more, see :ref:`redis-receiver`.
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``redis`` monitor type to capture the following metrics:
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``redis`` monitor type to capture the following metrics:
 
 -  Memory used
 -  Commands processed per second
diff --git a/gdi/monitors-gitlab/gitlab.rst b/gdi/monitors-gitlab/gitlab.rst
@@ -24,8 +24,7 @@ This integration allows you to monitor the following:
 -  GitLab Sidekiq: It scrapes the Gitlab Sidekiq Prometheus Exporter.
 -  GitLab Unicorn server: It comes with a Prometheus exporter. The IP
    address of the container or host needs to be allowed for the
-   collector to access the endpoint. See the ``IP allowlist``
-   documentation on GitLab Docs for more information.
+   collector to access the endpoint. See the ``IP allowlist`` documentation on GitLab Docs for more information.
 -  GitLab Webservice: It provides the GitLab Rails webserver with two Webservice workers per pod.     
 -  GitLab Workhorse: The GitLab service that handles slow HTTP requests.
    Workhorse includes a built-in Prometheus exporter that this monitor
diff --git a/gdi/monitors-hosts/collectd-plugin.rst b/gdi/monitors-hosts/collectd-plugin.rst
@@ -6,9 +6,7 @@ Collectd custom plugin
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Collectd custom plugin monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``collectd/custom`` monitor type to customize the collectd configuration
-of your managed collectd instances.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``collectd/custom`` monitor type to customize the configuration of your managed collectd instances.
 
 This integration is only available on Kubernetes and Linux.
 
@@ -128,7 +126,7 @@ integration:
 Metrics
 -------
 
-The Splunk Distribution of OpenTelemetry Collector does not do any
+The Splunk Distribution of the OpenTelemetry Collector does not do any
 built-in filtering of metrics coming out of this integration.
 
 Troubleshooting
diff --git a/gdi/monitors-hosts/collectd-uptime.rst b/gdi/monitors-hosts/collectd-uptime.rst
@@ -6,10 +6,7 @@ Collectd uptime
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Collectd Uptime monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``collectd/uptime`` monitor type to send a single metric of the total
-number of seconds the host has been up, using the collectd uptime
-plugin.
+The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the ``collectd/uptime`` monitor type to send a single metric of the total number of seconds the host has been up, using the collectd uptime plugin.
 
 This integration is only available on Kubernetes and Linux.
 
diff --git a/gdi/monitors-hosts/coredns.rst b/gdi/monitors-hosts/coredns.rst
@@ -6,11 +6,11 @@ CoreDNS
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the CoreDNS monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-CoreDNS monitor type to scrape Prometheus metrics exposed by CoreDNS.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the CoreDNS monitor type to scrape Prometheus metrics exposed by CoreDNS.
 
-The default port for these metrics are exposed on port 9153, at the
-``/metrics`` path.
+The default port for these metrics are exposed on port 9153, at the ``/metrics`` path.
+
+.. note:: If you're using the Splunk Distribution of the OpenTelemetry Collector and want to collect Prometheus metrics, see :ref:`prometheus-generic`.
 
 Benefits
 --------
diff --git a/gdi/monitors-hosts/docker.rst b/gdi/monitors-hosts/docker.rst
@@ -6,10 +6,7 @@ Docker Containers
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Docker monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``docker-container-stats`` monitor type to read container stats from a
-Docker API server. Note it doesn't currently support CPU share/quota
-metrics.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``docker-container-stats`` monitor type to read container stats from a Docker API server. Note it doesn't currently support CPU share/quota metrics.
 
 This integration is available for Kubernetes, Linux, and Windows.
 
diff --git a/gdi/monitors-hosts/elasticsearch.rst b/gdi/monitors-hosts/elasticsearch.rst
@@ -6,14 +6,9 @@ Elasticsearch stats
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Elasticsearch monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-Elasticsearch monitor type to collect node, cluster, and index level
-stats from Elasticsearch.
-
-By default, this integration only collects cluster-level and index-level
-stats from the current primary in an Elasticsearch cluster. You can
-override this using the ``clusterHealthStatsMasterOnly`` and
-``indexStatsMasterOnly`` configuration options respectively.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Elasticsearch monitor type to collect node, cluster, and index level stats from Elasticsearch.
+
+By default, this integration only collects cluster-level and index-level stats from the current primary in an Elasticsearch cluster. You can override this using the ``clusterHealthStatsMasterOnly`` and ``indexStatsMasterOnly`` configuration options respectively.
 
 Benefits
 --------
diff --git a/gdi/monitors-hosts/jenkins.rst b/gdi/monitors-hosts/jenkins.rst
@@ -6,13 +6,12 @@ Jenkins
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Jenkins monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
 ``jenkins`` monitor type to collect metrics from Jenkins instances by
 hitting the following endpoints:
 
--  Job metrics with the ``../api/json`` endpoint.
--  Codahale or Dropwizard JVM metrics with the
-   ``metrics/<MetricsKey>/..`` endpoint.
+- Job metrics with the ``../api/json`` endpoint.
+- Codahale or Dropwizard JVM metrics with the ``metrics/<MetricsKey>/..`` endpoint.
 
 This integration is only available on Kubernetes and Linux.
 
diff --git a/gdi/monitors-hosts/microsoft-windows-iis.rst b/gdi/monitors-hosts/microsoft-windows-iis.rst
@@ -6,8 +6,7 @@ Microsoft Windows IIS
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Windows IIS monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``windows-iis`` monitor type to report metrics for Windows Internet
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``windows-iis`` monitor type to report metrics for Windows Internet
 Information Services (IIS) and drive the Windows IIS dashboard content.
 
 Windows Performance Counters are the underlying source for these
diff --git a/gdi/monitors-hosts/nginx.rst b/gdi/monitors-hosts/nginx.rst
@@ -6,8 +6,7 @@ NGINX
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the NGINX monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
-``nginx`` monitor type to to retrieve metrics from NGINX instances.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``nginx`` monitor type to retrieve metrics from NGINX instances.
 
 This integration is available on Linux and Windows.
 
diff --git a/gdi/monitors-hosts/ntpq.rst b/gdi/monitors-hosts/ntpq.rst
@@ -6,10 +6,7 @@ NTPQ
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Telegraf NTPQ monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``net-io`` monitor type to retrieve metrics from NTPQ. This is an
-embedded form of the Telegraf NTPQ plugin and requires the ``ntpq``
-executable available on the path of the agent.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``net-io`` monitor type to retrieve metrics from NTPQ. This is an embedded form of the Telegraf NTPQ plugin and requires the ``ntpq`` executable available on the path of the agent.
 
 This monitor is available on Kubernetes, Linux, and Windows.
 
diff --git a/gdi/monitors-hosts/supervisor.rst b/gdi/monitors-hosts/supervisor.rst
@@ -6,9 +6,7 @@ Supervisor
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Supervisor monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``supervisor`` monitor type to retrieve the state of processes running
-by the Supervisor.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``supervisor`` monitor type to retrieve the state of processes running by Supervisor.
 
 This integration is available for Kubernetes, Windows, and Linux.
 
diff --git a/gdi/monitors-hosts/systemd.rst b/gdi/monitors-hosts/systemd.rst
@@ -6,9 +6,7 @@ systemd
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Collectd Systemd monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``collectd/systemd`` monitor type to collect metrics about the state of
-configured systemd services.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``collectd/systemd`` monitor type to collect metrics about the state of configured systemd services.
 
 This integration is available on Kubernetes and Linux.
 
diff --git a/gdi/monitors-hosts/varnish.rst b/gdi/monitors-hosts/varnish.rst
@@ -6,8 +6,7 @@ Varnish
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Telegraf Varnish monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``telegraf/varnish`` monitor type to collect Varnish metrics.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``telegraf/varnish`` monitor type to collect Varnish metrics.
 
 This integration is available on Kubernetes and Linux.
 
diff --git a/gdi/monitors-hosts/vsphere.rst b/gdi/monitors-hosts/vsphere.rst
@@ -6,9 +6,7 @@ VMware vSphere
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the vSphere monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``vsphere`` monitor type to collect metrics from vSphere through the
-vSphere API.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``vsphere`` monitor type to collect metrics from vSphere through the vSphere API.
 
 This integration is available on Kubernetes, Linux, and Windows. You can
 install it on the same server used by vSphere if it's running on Linux
diff --git a/gdi/monitors-messaging/rabbitmq.rst b/gdi/monitors-messaging/rabbitmq.rst
@@ -6,8 +6,7 @@ RabbitMQ
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the RabbitMQ monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
-``rabbitmq`` monitor type to keep track of an instance of RabbitMQ.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``rabbitmq`` monitor type to keep track of an instance of RabbitMQ.
 
 .. note:: To monitor RabbitMQ instances with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`rabbitmq-receiver`.
 
diff --git a/gdi/monitors-network/statsd.rst b/gdi/monitors-network/statsd.rst
@@ -6,9 +6,7 @@ Statsd
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Statsd monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``statsd`` monitor type to collect statsd metrics. It listens on a
-configured address and port to receive the statsd metrics.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``statsd`` monitor type to collect statsd metrics. It listens on a configured address and port to receive the statsd metrics.
 
 This integration supports the ``Counter``, ``Timer``, ``Gauge``, and
 ``Set`` types, which are dispatched as the Splunk Observability Cloud
diff --git a/gdi/monitors-network/traefik.rst b/gdi/monitors-network/traefik.rst
@@ -6,8 +6,7 @@ Traefik
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Traefik monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``traefik`` monitor type to collect metrics from Traefik.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``traefik`` monitor type to collect metrics from Traefik.
 
 This monitor is available on Kubernetes, Linux, and Windows.
 
diff --git a/gdi/monitors-prometheus/prometheus-exporter.rst b/gdi/monitors-prometheus/prometheus-exporter.rst
@@ -6,9 +6,7 @@ Prometheus Exporter
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Prometheus Exporter monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``prometheus-exporter`` monitor type to read all metric types from a
-Prometheus Exporter endpoint.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``prometheus-exporter`` monitor type to read all metric types from a Prometheus Exporter endpoint.
 
 A Prometheus Exporter is a piece of software that fetches statistics
 from another, non-Prometheus system, and turns them into Prometheus
diff --git a/gdi/monitors-prometheus/prometheus-velero.rst b/gdi/monitors-prometheus/prometheus-velero.rst
@@ -6,8 +6,7 @@ Prometheus Velero
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Prometehus Velero monitor. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``prometheus/velero`` monitor type to gets metrics from Velero.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``prometheus/velero`` monitor type to get metrics from Velero.
 
 This integration is available on Kubernetes, Linux, and Windows.
 
