Merge pull request #2190 from splunk/urbiz-OD6394-rx-sweep-edits

[6394]: Minor Rx tweaks

gdi/monitors-databases/mongodb.rst

@@ -11,7 +11,7 @@ MongoDB (deprecated)
    To monitor your MongoDB databases, you can instead use the native OpenTelemetry MongoDB receiver. To learn more, see :ref:`mongodb-receiver`.
 
 The
-:ref:`Splunk Distribution of OpenTelemetry Collector <otel-intro>`
+:ref:`Splunk Distribution of the OpenTelemetry Collector <otel-intro>`
 uses the :ref:`Smart Agent receiver <smartagent-receiver>` with the
 MongoDB monitor type to capture the following metrics about MongoDB:
 
@@ -200,21 +200,6 @@ monitor:
 
 .. note:: When using TLS authentication, SCRAM-SHA-256 is not supported. Use SCRAM-SHA-1 authentication.
 
-Metrics
--------
-
-The following metrics are available for this integration:
-
-.. raw:: html
-
-      <div class="metrics-yaml" url="https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/collectd/mongodb/metadata.yaml"></div>
-
-
-Notes
-~~~~~
-
-.. include:: /_includes/metric-defs.rst
-
 Troubleshooting
 ---------------
 

gdi/monitors-monitoring/win_perf_counters.rst

@@ -6,13 +6,11 @@ Windows Performance Counters
 .. meta::
    :description: Use this Splunk Observability Cloud integration for the Telegraf win_perf_counters monitor for Windows. See benefits, install, configuration, and metrics
 
-The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
-``telegraf/win_perf_counters`` monitor type to receive metrics from
-Windows performance counters.
+.. note:: For information on the OpenTelemetry receiver based on the Windows Performance Counters input plugin, see :ref:`Windows Performance Counters receiver <windowsperfcounters-receiver>`.
 
-This monitor is available on Windows.
+The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``telegraf/win_perf_counters`` monitor type to receive metrics from Windows performance counters.
 
-.. note:: For information on the OpenTelemetry receiver based on the Windows Performance Counters input plugin, see :ref:`Windows Performance Counters receiver <windowsperfcounters-receiver>`.
+This monitor is available on Windows.
 
 Benefits
 --------
@@ -32,8 +30,7 @@ Configuration
 Example
 ~~~~~~~
 
-To activate this integration, add the following to your Collector
-configuration:
+To activate this integration, add the following to your Collector configuration:
 
 .. code:: yaml
 
@@ -189,8 +186,7 @@ The nested ``objects`` configuration object has the following fields:
 Metrics
 -------
 
-The Splunk Distribution of OpenTelemetry Collector doesn't filter
-metrics for this receiver.
+The Splunk Distribution of the OpenTelemetry Collector doesn't filter metrics for this receiver.
 
 Troubleshooting
 ---------------

gdi/opentelemetry/components/filelog-receiver.rst

@@ -14,7 +14,7 @@ Get started
 
 Follow these steps to configure and activate the component:
 
-1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
+1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
 
   - :ref:`otel-install-linux`
   - :ref:`otel-install-windows`
@@ -42,7 +42,7 @@ To complete the configuration, include the receiver in the ``logs`` pipeline of
       logs:
         receivers: [filelog]
 
-Configuration examples
+Configuration example
 --------------------------------
 
 This example shows how to tail a simple JSON file:

gdi/opentelemetry/components/fluentd-receiver.rst

@@ -7,7 +7,7 @@ Fluent Forward receiver
 .. meta::
       :description: The Fluent Forward receiver allows the Splunk Distribution of OpenTelemetry Collector to collect logs and events using the Fluent Forward protocol.
 
-The Fluent Forward receiver allows the Splunk Distribution of OpenTelemetry Collector to collect events using the bundled Fluentd application. The supported pipeline type is ``logs``. See :ref:`otel-data-processing` for more information.
+The Fluent Forward receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect events using the bundled Fluentd application. The supported pipeline type is ``logs``. See :ref:`otel-data-processing` for more information.
 
 The receiver accepts data formatted as Fluent Forward events through a TCP connection. All three Fluent event types, message, forward, and packed forward, are supported, including compressed packed forward.
 
@@ -24,7 +24,7 @@ Get started
 
 Follow these steps to configure and activate the component:
 
-1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
+1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
 
   - :ref:`otel-install-linux`
   - :ref:`otel-install-windows`
@@ -33,7 +33,7 @@ Follow these steps to configure and activate the component:
 2. Configure the receiver as described in the next document.
 3. Restart the Collector.
 
-By default, the Splunk Distribution of OpenTelemetry Collector includes the Fluent Forward receiver in the ``logs`` pipeline:
+By default, the Splunk Distribution of the OpenTelemetry Collector includes the Fluent Forward receiver in the ``logs`` pipeline:
 
 .. code-block:: yaml
 

gdi/opentelemetry/components/jmx-receiver.rst

@@ -21,7 +21,7 @@ Get started
 
 Follow these steps to configure and activate the component:
 
-1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
+1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
 
   - :ref:`otel-install-linux`
   - :ref:`otel-install-windows`

gdi/opentelemetry/components/mongodb-atlas-receiver.rst

@@ -7,19 +7,19 @@ MongoDB Atlas receiver
 .. meta::
       :description: The MongoDB Atlas receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from MongoDB Atlas through its monitoring API.
 
-The MongoDB Atlas receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics and logs from MongoDB Atlas through its monitoring API. The supported pipeline types are ``metrics`` and ``logs``. See :ref:`otel-data-processing` for more information.
+The MongoDB Atlas receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics and logs from MongoDB Atlas through its monitoring API. The supported pipeline types are ``metrics`` and ``logs``. See :ref:`otel-data-processing` for more information.
 
 Database metrics are dimensionalized by project and database attributes, for example, ``project_name`` and
 ``database_name``.
 
-.. note:: Use the MongoDB Atlas receiver in place of the SignalFx Smart Agent ``mongodb-atlas`` monitor type.
+.. note:: Use the MongoDB Atlas receiver in place of the deprecated SignalFx Smart Agent ``mongodb-atlas`` monitor type.
 
 Get started
 ======================
 
 Follow these steps to configure and activate the component:
 
-1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
+1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
 
    - :ref:`otel-install-linux`
    - :ref:`otel-install-windows`
@@ -77,7 +77,7 @@ To complete the configuration, include the receiver in the ``metrics`` or ``logs
 Settings
 ======================
 
-The following table shows the configuration options for the MongoDB Atlas:
+The following table shows the configuration options for the MongoDB Atlas receiver:
 
 .. raw:: html
 

gdi/opentelemetry/components/mongodb-receiver.rst

@@ -11,6 +11,8 @@ The MongoDB receiver fetches metrics from standalone MongoDB clusters, including
 
 The receiver collects stats with MongoDB's ``dbStats`` and ``serverStatus`` commands, and uses the golang mongo driver. See more at :new-page:`Mongo Go driver documentation <https://github.com/mongodb/mongo-go-driver>`.
 
+.. note:: Use the MongoDB receiver in place of the deprecated SignalFx Smart Agent ``mongodb`` monitor type.
+
 Prerequisites
 ======================
 

gdi/opentelemetry/components/windowsperfcounters-receiver.rst

@@ -5,13 +5,13 @@ Windows Performance Counters receiver
 **************************************
 
 .. meta::
-      :description: The Windows Performance Counters receiver allows the Splunk Distribution of OpenTelemetry Collector to collect system, application, or custom performance counter data from the Windows Registry.
+      :description: The Windows Performance Counters receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect system, application, or custom performance counter data from the Windows Registry.
 
-The Windows Performance Counters receiver allows the Splunk Distribution of OpenTelemetry Collector to collect configured system, application, or custom performance counter data from the Windows Registry. The supported pipeline types are ``metrics``. See :ref:`otel-data-processing` for more information.
+The Windows Performance Counters receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect configured system, application, or custom performance counter data from the Windows Registry. The supported pipeline types are ``metrics``. See :ref:`otel-data-processing` for more information.
 
 Configured metrics consist of a metric description, including unit and type, used by one or more performance counters scraped by the receiver. If a specific performance counter can't be accessed at startup, the receiver emits a warning and continues execution.
 
-The Windows Performance Counters receiver replaces the SmartAgent monitor type of the same name. See :ref:`telegraf-win-perf-counters` for information on the monitor type.
+The Windows Performance Counters receiver replaces the SmartAgent monitor type :ref:`telegraf-win-perf-counters`.
 
 .. note:: The Windows Performance Counters receiver only works on Windows hosts.
 
@@ -20,7 +20,7 @@ Get started
 
 Follow these steps to configure and activate the component:
 
-1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
+1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
 
    - :ref:`otel-install-linux`
    - :ref:`otel-install-windows`
@@ -71,7 +71,6 @@ To activate the Windows Performance Counters receiver add a ``windowsperfcounter
 
 .. code-block:: yaml
 
-
    receivers:
      windowsperfcounters:
        metrics:
@@ -87,7 +86,7 @@ To activate the Windows Performance Counters receiver add a ``windowsperfcounter
              metric: bytes.committed
 
 To complete the configuration, include the receiver in the ``metrics`` pipeline of the ``service`` section of your
-configuration file. For example:
+configuration file:
 
 .. code-block:: yaml
 
@@ -100,17 +99,17 @@ configuration file. For example:
 
 To collect metrics from Windows performance counters, you need to define metrics using the ``metrics`` field as in the example. You can then reference the metrics you defined from the ``counters.metric`` fields.
 
-Metric format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Format metrics
+======================
 
 To report metrics in a specific format, define the metric and reference it in the corresponding counter, along with any applicable attributes. By default, the metric name corresponds to the name of the counter.
 
 Metrics can be of type ``sum`` or ``gauge``. Sum metrics support the ``aggregation`` and ``monotonic`` fields.
 
-
 .. list-table::
    :header-rows: 1
    :width: 100%
+   :widths: 20 40 20 20   
 
    - 
 
@@ -149,31 +148,34 @@ Metrics can be of type ``sum`` or ``gauge``. Sum metrics support the ``aggregati
       - Gauge configuration
       - 
 
+Sum metrics
+----------------------
+
 The following settings apply to sum metrics:
 
 .. list-table::
    :header-rows: 1
+   :width: 100%
+   :widths: 25 50 25
 
    - 
 
       - Field
       - Description
       - Value
-      - Default
    - 
 
       - ``aggregation``
       - Type of aggregation temporality for the metric
       - ``cumulative`` or ``delta``
-      - 
    - 
 
       - ``monotonic``
       - Whether the metric value can decrease
       - ``false``
-      - 
 
-The following settings apply to gauge metrics:
+Gauge metrics
+----------------------
 
 The ``gauge`` configuration doesn't accept settings. The following example emits the ``Memory/Committed Bytes`` counter as the ``bytes.committed`` metric:
 
@@ -198,9 +200,11 @@ The ``gauge`` configuration doesn't accept settings. The following example emits
        metrics:
          receivers: [windowsperfcounters]
 
+Advanced configurations
+============================================
 
 Configure collection interval and counters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------------------------------------------------
 
 You can configure the collection interval and which performance counters you want to scrape. For example:
 
@@ -282,7 +286,7 @@ The following example shows how to scrape performance counters using different c
        metrics:
          receivers: [windowsperfcounters/memory, windowsperfcounters/processor]
 
-Instances configuration
+Configure instances
 ---------------------------------
 
 An instance is any entity that produces performance data. Instances can have 1 or more counter values.
@@ -309,7 +313,7 @@ The receiver supports the following values through the ``instances`` field:
 
 .. _total-instance-behavior:
 
-_Total instance behavior and the aggregation counter
+Total instance behavior and the aggregation counter
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To avoid dropping the ``_Total`` instance, you must configure the receiver to collect it individually on its own metric.

gdi/opentelemetry/components/zipkin-receiver.rst

@@ -20,7 +20,7 @@ Get started
 
 Follow these steps to configure and activate the component:
 
-1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
+1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
 
   - :ref:`otel-install-linux`
   - :ref:`otel-install-windows`