Merge pull request #1512 from splunk/repo-sync

Pulling refs/heads/main into main

Author: aurbiztondo-splunk

_includes/gdi/collector-settings-collectioninterval.rst

@@ -0,0 +1,5 @@
+* ``collection_interval``. ``10s`` by default. Sets the interval this receiver collects metrics on. 
+  
+  * This value must be a string readable by Golang's ``time.ParseDuration``. Learn more at Go's official documentation :new-page:`ParseDuration function <https://pkg.go.dev/time#ParseDuration>`.
+  
+  * Valid time units are ``ns``, ``us`` (or ``µs``), ``ms``, ``s``, ``m``, ``h``.

_includes/gdi/collector-settings-initialdelay.rst

@@ -0,0 +1 @@
+* ``initial_delay``. ``1s`` by default. Determines how long this receiver waits before collecting metrics for the first time.

_includes/gdi/otel-receivers-table.rst

@@ -23,6 +23,7 @@
 * :ref:`mongodb-atlas-receiver`
 * :ref:`mssql-server-receiver` 
 * :ref:`mysql-receiver`
+* :ref:`nginx-receiver`
 * :ref:`oracledb-receiver`
 * :ref:`otlp-receiver`                
 * :ref:`postgresql-receiver`

alerts-detectors-notifications/create-detectors-for-alerts.rst

@@ -214,10 +214,12 @@ After you have created an alert message, continue to the next tab to specify whe
 Display custom properties
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If you are creating a detector using the Splunk Observability Cloud API, you can convert custom properties of the detector to dimensions using the ``promote()`` method.
+If you are creating a detector using the Splunk Observability Cloud API, you can convert custom properties to dimensions using the ``promote()`` method.
 
 By converting a custom property to a dimension, you can display it in an alert message. To learn more, see the :new-page:`Developer documentation for the promote method <https://dev.splunk.com/observability/docs/signalflow/methods/promote_stream_method/>`.
 
+For more information about the detector API endpoints, see :new-page:`Detectors <https://dev.splunk.com/observability/reference/api/detectors/latest>` Splunk Observability Cloud API reference.
+
 .. _alert-recipients:
 
 

gdi/monitors-hosts/nginx.rst

@@ -11,6 +11,8 @@ The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent rece
 
 This integration is available on Linux and Windows.
 
+.. note:: To monitor NGINX instances with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`nginx-receiver`.
+
 Benefits
 --------
 

gdi/opentelemetry/components.rst

@@ -124,6 +124,9 @@ The Splunk Distribution of the OpenTelemetry Collector includes and supports the
    * - :ref:`mysql-receiver` (``mysql``)
      - Queries and retrieves metrics about MySQL's global status and InnoDB tables.
      - Metrics      
+   * - :ref:`nginx-receiver` (``nginx``)
+     - Fetches stats from a NGINX instance using the ``ngx_http_stub_status_module`` module's status endpoint.
+     - Metrics    
    * - :ref:`oracledb` (``oracledb``) |br|
      - Connects to an Oracle Database instance and obtains metrics such as physical reads, CPU, time, and others.
      - Metrics

gdi/opentelemetry/components/a-components-receivers.rst

@@ -37,6 +37,7 @@ Collector components: Receivers
     mongodb-atlas-receiver
     mssql-server-receiver
     mysql-receiver
+    nginx-receiver
     oracledb-receiver
     otlp-receiver                
     postgresql-receiver

gdi/opentelemetry/components/apache-receiver.rst

@@ -62,13 +62,9 @@ The following settings are required:
 
 The following settings are optional:
 
-* ``collection_interval``. ``10s`` by default. Sets the interval this receiver collects metrics on. 
-  
-  * This value must be a string readable by Golang's ``time.ParseDuration``. Learn more at Go's official documentation :new-page:`ParseDuration function <https://pkg.go.dev/time#ParseDuration>`.
-  
-  * Valid time units are ``ns``, ``us`` (or ``µs``), ``ms``, ``s``, ``m``, ``h``.
+.. include:: /_includes/gdi/collector-settings-collectioninterval.rst
 
-* ``initial_delay``. ``1s`` by default. Determines how long this receiver waits before collecting metrics for the first time.
+.. include:: /_includes/gdi/collector-settings-initialdelay.rst
 
 Settings
 ======================

gdi/opentelemetry/components/mysql-receiver.rst

@@ -91,13 +91,9 @@ The following settings are optional:
 
 * ``database``. The database name. If unspecified, metrics are collected for all databases.
 
-* ``collection_interval``. ``10s`` by default. This receiver collects metrics on this interval. 
+.. include:: /_includes/gdi/collector-settings-collectioninterval.rst
 
-  * This value must be a string readable by Golang's ParseDuration function. Learn more at Golang's official documentation at :new-page:`ParseDuration <https://pkg.go.dev/time#ParseDuration>`. 
-  
-  * Valid time units are ``ns``, ``us`` (or ``µs``), ``ms``, ``s``, ``m``, or ``h``.
-
-* ``initial_delay``. ``1s`` by default. Defines how long this receiver waits before starting.
+.. include:: /_includes/gdi/collector-settings-initialdelay.rst
 
 * ``transport``. ``tcp`` by default. Defines the network to use to connect to the server.
 

gdi/opentelemetry/components/nginx-receiver.rst

@@ -0,0 +1,85 @@
+.. _nginx-receiver:
+
+***********************
+NGINX receiver
+***********************
+
+.. meta::
+      :description: The NGINX receiver fetches stats from a NGINX instance using the ``ngx_http_stub_status_module`` module's status endpoint.
+
+The NGINX receiver fetches stats from a NGINX instance using the ``ngx_http_stub_status_module`` module's ``status`` endpoint. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information. 
+
+You need to configure NGINX to expose status information. To learn how, see the :new-page:`HTTP status module config guide <https://nginx.org/en/docs/http/ngx_http_stub_status_module.html>` in the NGINX documentation.
+
+.. note:: Out-of-the-box dashboards and navigators aren't supported for the NGINX Server receiver yet, but are planned for a future release.
+
+Get started
+======================
+
+Follow these steps to configure and activate the component:
+
+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 receiver as described in the next section.
+3. Restart the Collector.
+
+Sample configuration
+---------------------------
+
+To activate the NGINX receiver, add ``nginx`` to the ``receivers`` section of your configuration file, as shown in the following example:
+
+.. code:: yaml
+
+  receivers:
+    nginx:
+      endpoint: "http://localhost:80/status"
+      collection_interval: 10s
+
+To complete the configuration, include the receiver in the ``metrics`` pipeline of the ``service`` section of your configuration file. For example:
+
+.. code:: yaml
+
+   service:
+     pipelines:
+       metrics:
+         receivers: [nginx]
+
+Configuration options
+-------------------------------------------------
+
+The following settings are available:
+
+* ``endpoint``. :strong:`Required`. ``http://localhost:80/status`` by default. The URL of the NGINX status endpoint.
+
+.. include:: /_includes/gdi/collector-settings-collectioninterval.rst
+
+.. include:: /_includes/gdi/collector-settings-initialdelay.rst
+
+Settings
+======================
+
+The following table shows the configuration options for the NGINX receiver:
+
+.. raw:: html
+
+   <div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/nginx.yaml"></div>
+
+Metrics
+=====================
+
+The following metrics, resource attributes, and attributes are available.
+
+.. raw:: html
+
+   <div class="metrics-component" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/nginxreceiver.yaml"></div>
+
+.. include:: /_includes/activate-deactivate-native-metrics.rst
+
+Troubleshooting
+======================
+
+.. include:: /_includes/troubleshooting-components.rst