-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2233 from splunk/urbiz-OD6435-haproxy-rx
[6435]: HAProxy receiver
- Loading branch information
Showing
5 changed files
with
94 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
.. _haproxy-receiver: | ||
|
||
*********************** | ||
HAProxy receiver | ||
*********************** | ||
|
||
.. meta:: | ||
:description: The HAProxy receiver generates metrics by polling periodically the HAProxy process through a dedicated socket or HTTP URL | ||
|
||
The HAProxy receiver generates metrics by polling periodically the HAProxy process through a dedicated socket or HTTP URL. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information. | ||
|
||
.. note:: Out-of-the-box dashboards and navigators aren't supported for the HAProxy 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 configurations | ||
--------------------------- | ||
|
||
To activate the HAProxy receiver, add ``haproxy`` to the ``receivers`` section of your configuration file, as shown in the following example: | ||
|
||
.. code:: yaml | ||
receivers: | ||
haproxy: | ||
endpoint: file:///var/run/haproxy.ipc | ||
collection_interval: 1m | ||
metrics: | ||
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: [haproxy] | ||
Configuration options | ||
-------------------------------------------- | ||
|
||
You can configure the following settings: | ||
|
||
* ``endpoint``. :strong:`Required`. Path to the endpoint exposed by HAProxy for communications. It can be a local file socket or a HTTP URL. | ||
|
||
* ``collection_interval``. Optional, ``1m`` by default. The scraping collection interval. | ||
|
||
* ``initial_delay``. Optional, ``1s`` by default. Defines how long this receiver waits before starting. | ||
|
||
Settings | ||
====================== | ||
|
||
The following table shows the configuration options for the HAProxy receiver: | ||
|
||
.. raw:: html | ||
|
||
<div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/haproxy.yaml"></div> | ||
|
||
.. _haproxy-receiver-metrics: | ||
|
||
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/haproxyreceiver.yaml"></div> | ||
|
||
.. include:: /_includes/activate-deactivate-native-metrics.rst | ||
|
||
Troubleshooting | ||
====================== | ||
|
||
.. include:: /_includes/troubleshooting-components.rst |