Skip to content

Commit

Permalink
Merge pull request #2195 from splunk/urbiz-OD6394-rx-edits
Browse files Browse the repository at this point in the history
[6394]: Minor edits
  • Loading branch information
aurbiztondo-splunk authored Jul 29, 2024
2 parents c41f7be + 9fe7148 commit 95df1a3
Show file tree
Hide file tree
Showing 12 changed files with 27 additions and 21 deletions.
4 changes: 2 additions & 2 deletions gdi/monitors-prometheus/prometheus-generic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Configure applications with Prometheus metrics
.. meta::
:description: Use the Prometheus receiver to retrieve metrics in Prometheus format from any compatible service.

The Prometheus receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from any source exposing telemetry in Prometheus format. See more at :ref:`prometheus-receiver`.
The Prometheus receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from any source exposing telemetry in Prometheus format. See more at :ref:`prometheus-receiver`.

Benefits
========================

By default, the Splunk Distribution of OpenTelemetry Collector includes the Prometheus receiver in the ``metrics/internal`` pipeline when deployed in host monitoring (agent) mode. See :ref:`otel-deployment-mode` for more information.
By default, the Splunk Distribution of the OpenTelemetry Collector includes the Prometheus receiver in the ``metrics/internal`` pipeline when deployed in host monitoring (agent) mode. See :ref:`otel-deployment-mode` for more information.

This receiver and pipeline enable the collection of the Collector's internal metrics, such as data loss, ingress, egress, that power the built-in Collector dashboard.

Expand Down
2 changes: 1 addition & 1 deletion gdi/opentelemetry/components/mysql-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ MySQL receiver
****************************

.. meta::
:description: The MySQL receiver allows the Splunk Distribution of OpenTelemetry Collector to query and retrieve metrics about MySQL's global status and InnoDB tables.
:description: The MySQL receiver allows the Splunk Distribution of the OpenTelemetry Collector to query and retrieve metrics about MySQL's global status and InnoDB tables.

The MySQL receiver queries and retrieves metrics about MySQL's global status and InnoDB tables. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.

Expand Down
4 changes: 2 additions & 2 deletions gdi/opentelemetry/components/oracledb-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Oracle Database receiver
.. meta::
:description: The Oracle Database receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from Oracle Database by connecting to it.

The Oracle Database receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from Oracle Database. The receiver connects to an Oracle Database instance and obtains metrics such as the number of physical reads, cumulative CPU time, and others. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.
The Oracle Database receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from Oracle Database. The receiver connects to an Oracle Database instance and obtains metrics such as the number of physical reads, cumulative CPU time, and others. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.

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`
Expand Down
2 changes: 1 addition & 1 deletion gdi/opentelemetry/components/otlp-exporter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,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`
Expand Down
4 changes: 2 additions & 2 deletions gdi/opentelemetry/components/postgresql-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ PostgreSQL receiver
.. meta::
:description: The PostgreSQL receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from PostgreSQL through its statistics collector.

The PostgreSQL receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from PostgreSQL through its statistics collector. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.
The PostgreSQL receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from PostgreSQL through its statistics collector. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.

.. note:: Use the PostgreSQL receiver in place of the SignalFx Smart Agent ``postgresql`` monitor type.

Expand All @@ -23,7 +23,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`
Expand Down
8 changes: 4 additions & 4 deletions gdi/opentelemetry/components/prometheus-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Prometheus receiver
.. meta::
:description: The Prometheus receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from any scraping source compatible with the Prometheus format.

The Prometheus receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from any source exposing telemetry in Prometheus format. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.
The Prometheus receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from any source exposing telemetry in Prometheus format. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.

.. note:: To use a simplified version of the Prometheus receiver that supports single endpoints, see :ref:`simple-prometheus-receiver`.

Expand All @@ -31,7 +31,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`
Expand All @@ -43,7 +43,7 @@ Follow these steps to configure and activate the component:
Sample configuration
--------------------------------

By default, the Splunk Distribution of OpenTelemetry Collector includes the Prometheus receiver in the ``metrics/internal`` pipeline.
By default, the Splunk Distribution of the OpenTelemetry Collector includes the Prometheus receiver in the ``metrics/internal`` pipeline.

To activate additional Prometheus receivers, add a new ``prometheus`` entry in the ``receivers`` section of the Collector configuration file, as in the following example:

Expand All @@ -68,7 +68,7 @@ To complete the configuration, include the receiver in the ``metrics`` pipeline
receivers:
- prometheus
.. caution:: Don't remove the ``prometheus/internal`` receiver from the configuration. Internal metrics feed the Splunk Distribution of OpenTelemetry Collector default dashboard.
.. caution:: Don't remove the ``prometheus/internal`` receiver from the configuration. Internal metrics feed the Splunk Distribution of the OpenTelemetry Collector default dashboard.

Scraper configuration
----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion gdi/opentelemetry/components/receiver-creator-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Receiver creator receiver
.. meta::
:description: Use the receiver creator to create receivers at runtime in the OpenTelemetry Collector based on rules. Read on to learn how to configure the component.

The receiver creator receiver allows the Splunk Distribution of OpenTelemetry Collector to create new receivers at runtime based on configured rules and observer extensions. The supported pipeline types are ``metrics``, ``traces``, and ``logs``. See :ref:`otel-data-processing` for more information.
The receiver creator receiver allows the Splunk Distribution of the OpenTelemetry Collector to create new receivers at runtime based on configured rules and observer extensions. The supported pipeline types are ``metrics``, ``traces``, and ``logs``. See :ref:`otel-data-processing` for more information.

You can use any of the following observer extensions as listeners for the receiver creator:

Expand Down
4 changes: 2 additions & 2 deletions gdi/opentelemetry/components/simple-prometheus-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Simple Prometheus receiver
.. meta::
:description: The Simple Prometheus receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from a single source compatible with the Prometheus format.

The Simple Prometheus is a wrapper around the Prometheus receiver that allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from a single source of telemetry in Prometheus format. The supported pipeline type is ``metrics``.
The Simple Prometheus is a wrapper around the Prometheus receiver that allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from a single source of telemetry in Prometheus format. The supported pipeline type is ``metrics``.

To scrape Prometheus metrics from multiple targets that require extensive configuration, use the Prometheus receiver. See :ref:`prometheus-receiver` for more information.

Expand All @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion gdi/opentelemetry/components/smartagent-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Smart Agent receiver
.. meta::
:description: The Smart Agent receiver lets you use Smart Agent monitors in the Splunk Distribution of OpenTelemetry Collector.

The Smart Agent receiver is a native OTel component that lets you use Smart Agent monitors through the Splunk Distribution of OpenTelemetry Collector. Supported pipeline types are ``traces``, ``metrics``, and ``logs``. See :ref:`otel-data-processing` for more information.
The Smart Agent receiver is a native OTel component that lets you use Smart Agent monitors through the Splunk Distribution of the OpenTelemetry Collector. Supported pipeline types are ``traces``, ``metrics``, and ``logs``. See :ref:`otel-data-processing` for more information.

The Smart Agent receiver is fully supported only on AMD64 Linux and Windows platforms. Support for ARM64 is experimental starting from the Splunk Distribution of OpenTelemetry Collector version 0.73 and higher.

Expand Down
4 changes: 2 additions & 2 deletions gdi/opentelemetry/components/splunk-hec-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Splunk HEC receiver
.. meta::
:description: The Splunk HEC receiver allows the Splunk Distribution of OpenTelemetry Collector to collect logs and metrics in Splunk HTTP Event Collector format.

The Splunk HTTP Event Collector (HEC) receiver allows the Splunk Distribution of OpenTelemetry Collector to collect events and logs in Splunk HEC format. The supported pipeline types are ``metrics`` and ``logs``. See :ref:`otel-data-processing` for more information.
The Splunk HTTP Event Collector (HEC) receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect events and logs in Splunk HEC format. The supported pipeline types are ``metrics`` and ``logs``. See :ref:`otel-data-processing` for more information.

The receiver accepts data formatted as JSON HEC events under any path or as end-of-line separated log raw data if sent to the ``raw_path``. See :new-page:`Format events for HTTP Event Collector <https://docs.splunk.com/Documentation/Splunk/latest/Data/FormateventsforHTTPEventCollector>` for more information.

Expand All @@ -18,7 +18,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`
Expand Down
2 changes: 1 addition & 1 deletion gdi/opentelemetry/components/syslog-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
10 changes: 8 additions & 2 deletions gdi/opentelemetry/components/udp-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ UDP log receiver
.. meta::
:description: The UDP log receiver collects logs over UDP connections.

The UDP log receiver allows the Splunk Distribution of OpenTelemetry Collector to collect logs over UDP connections. The supported pipeline is ``logs``. See :ref:`otel-data-processing` for more information.
The UDP log receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect logs over UDP connections. The supported pipeline is ``logs``. See :ref:`otel-data-processing` for more information.

.. _get-started-udp-receiver:

Expand All @@ -16,8 +16,14 @@ 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. See :ref:`otel-install-platform`.
1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:

- :ref:`otel-install-linux`
- :ref:`otel-install-windows`
- :ref:`otel-install-k8s`

2. Configure the UDP log receiver as described in the next section.

3. Restart the Collector.

.. _udp-receiver-sample-configs:
Expand Down

0 comments on commit 95df1a3

Please sign in to comment.