|
| 1 | +.. _apache-spark-receiver: |
| 2 | + |
| 3 | +******************************* |
| 4 | +Apache Spark receiver |
| 5 | +******************************* |
| 6 | + |
| 7 | +.. meta:: |
| 8 | + :description: The Apache Spark receiver fetches metrics for an Apache Spark cluster through the Apache Spark REST API. |
| 9 | + |
| 10 | +The Apache Spark receiver metrics for an Apache Spark cluster through the Apache Spark REST API. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information. |
| 11 | + |
| 12 | +.. note:: Out-of-the-box dashboards and navigators aren't supported for the Apache Web Server receiver yet, but are planned for a future release. |
| 13 | + |
| 14 | +Prerequisites |
| 15 | +====================== |
| 16 | + |
| 17 | +This receiver supports Apache Web Server version 2.4 or higher. |
| 18 | + |
| 19 | +In order to receive server statistics, you must configure the server's ``httpd.conf`` file to enable status support. Learn more at Apache's official documentation :new-page:`Module mod_status <https://httpd.apache.org/docs/2.4/mod/mod_status.html>`. |
| 20 | + |
| 21 | +Get started |
| 22 | +====================== |
| 23 | + |
| 24 | +Follow these steps to configure and activate the component: |
| 25 | + |
| 26 | +1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform: |
| 27 | + |
| 28 | + - :ref:`otel-install-linux` |
| 29 | + - :ref:`otel-install-windows` |
| 30 | + - :ref:`otel-install-k8s` |
| 31 | + |
| 32 | +2. Configure the receiver as described in the next section. |
| 33 | +3. Restart the Collector. |
| 34 | + |
| 35 | +Sample configuration |
| 36 | +-------------------------------- |
| 37 | + |
| 38 | +To activate the Apache Web Server receiver, add ``apache`` to the ``receivers`` section of your configuration file: |
| 39 | + |
| 40 | +.. code-block:: yaml |
| 41 | +
|
| 42 | + receivers: |
| 43 | + apache: |
| 44 | + endpoint: "http://localhost:8080/server-status?auto" |
| 45 | + collection_interval: 10s |
| 46 | +
|
| 47 | +To complete the configuration, include the receiver in the ``metrics`` pipeline of the ``service`` section of your configuration file: |
| 48 | + |
| 49 | +.. code:: yaml |
| 50 | +
|
| 51 | + service: |
| 52 | + pipelines: |
| 53 | + metrics: |
| 54 | + receivers: [apache] |
| 55 | +
|
| 56 | +Configuration options |
| 57 | +----------------------- |
| 58 | + |
| 59 | +The following settings are required: |
| 60 | + |
| 61 | +* ``endpoint``. ``"http://localhost:8080/server-status?auto"`` by default. The URL of the httpd status endpoint. |
| 62 | + |
| 63 | +The following settings are optional: |
| 64 | + |
| 65 | +.. include:: /_includes/gdi/collector-settings-collectioninterval.rst |
| 66 | + |
| 67 | +.. include:: /_includes/gdi/collector-settings-initialdelay.rst |
| 68 | + |
| 69 | +Settings |
| 70 | +====================== |
| 71 | + |
| 72 | +The following table shows the configuration options for the Apache Web Server receiver: |
| 73 | + |
| 74 | +.. raw:: html |
| 75 | + |
| 76 | + <div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/apache.yaml"></div> |
| 77 | + |
| 78 | +Metrics |
| 79 | +====================== |
| 80 | + |
| 81 | +The following metrics, resource attributes, and attributes are available. |
| 82 | + |
| 83 | +.. note:: The SignalFx exporter excludes some available metrics by default. Learn more about default metric filters in :ref:`list-excluded-metrics`. |
| 84 | + |
| 85 | +.. raw:: html |
| 86 | + |
| 87 | + <div class="metrics-component" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/apachereceiver.yaml"></div> |
| 88 | + |
| 89 | +.. include:: /_includes/activate-deactivate-native-metrics.rst |
| 90 | + |
| 91 | +Troubleshooting |
| 92 | +====================== |
| 93 | + |
| 94 | +.. include:: /_includes/troubleshooting-components.rst |
0 commit comments