|
1 | 1 | .. _purefa-receiver: |
2 | 2 |
|
3 | 3 | ******************************************************** |
4 | | -Pure Storage FlashArray Receiver receiver |
| 4 | +Pure Storage FlashArray receiver |
5 | 5 | ******************************************************** |
6 | 6 |
|
7 | 7 | .. meta:: |
8 | 8 | :description: Receives metrics from the Pure Storage FlashArray. |
9 | 9 |
|
10 | | -The Splunk Distribution of the OpenTelemetry Collector supports the Pure Storage FlashArray Receiver (Purefa) receiver. Documentation is planned for a future release. |
| 10 | +The Pure Storage FlashArray (Purefa) receiver fetches metrics from the Pure Storage FlashArray. |
| 11 | + |
| 12 | +Get started |
| 13 | +====================== |
| 14 | + |
| 15 | +Follow these steps to configure and activate the component: |
| 16 | + |
| 17 | +1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform: |
| 18 | + |
| 19 | + - :ref:`otel-install-linux` |
| 20 | + - :ref:`otel-install-windows` |
| 21 | + - :ref:`otel-install-k8s` |
| 22 | + |
| 23 | +2. Configure the receiver as described in the next section. |
| 24 | +3. Restart the Collector. |
| 25 | + |
| 26 | +Sample configuration |
| 27 | +---------------------------------------------------------------------- |
| 28 | + |
| 29 | +To activate the Purefa receiver in the Collector, add ``purefa`` to the ``receivers`` section of your configuration file, as shown in the following example: |
| 30 | + |
| 31 | +.. code:: yaml |
| 32 | +
|
| 33 | + receivers: |
| 34 | + purefa: |
| 35 | +
|
| 36 | +To complete the configuration, include the receiver in the ``metrics`` pipeline of the ``service`` section of your configuration file. For example: |
| 37 | + |
| 38 | +.. code:: yaml |
| 39 | +
|
| 40 | + service: |
| 41 | + pipelines: |
| 42 | + metrics: |
| 43 | + receivers: [purefa] |
| 44 | +
|
| 45 | +Configuration example |
| 46 | +---------------------------------------------------------------------- |
| 47 | + |
| 48 | +See the following config example: |
| 49 | + |
| 50 | +.. code:: yaml |
| 51 | +
|
| 52 | +
|
| 53 | +
|
| 54 | +Configuration settings |
| 55 | +------------------------------------------------- |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +Settings |
| 60 | +====================== |
| 61 | + |
| 62 | +The following table shows the configuration options for the Purefa receiver: |
| 63 | + |
| 64 | +.. raw:: html |
| 65 | + |
| 66 | + <div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/purefa.yaml"></div> |
| 67 | + |
| 68 | +.. _purefa-receiver-metrics: |
| 69 | + |
| 70 | +Metrics |
| 71 | +===================== |
| 72 | + |
| 73 | +The following metrics, resource attributes, and attributes are available. |
| 74 | + |
| 75 | +.. raw:: html |
| 76 | + |
| 77 | + <div class="metrics-component" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/purefareceiver.yaml"></div> |
| 78 | + |
| 79 | +Troubleshooting |
| 80 | +====================== |
| 81 | + |
| 82 | +.. raw:: html |
| 83 | + |
| 84 | + <div class="include-start" id="troubleshooting-components.rst"></div> |
| 85 | + |
| 86 | +.. include:: /_includes/troubleshooting-components.rst |
| 87 | + |
| 88 | +.. raw:: html |
| 89 | + |
| 90 | + <div class="include-stop" id="troubleshooting-components.rst"></div> |
| 91 | + |
| 92 | + |
| 93 | + |
11 | 94 |
|
12 | | -To find information about this component in the meantime, see :new-page:`Pure Storage FlashArray Receiver receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/purefareceiver>` on GitHub. |
13 | 95 |
|
0 commit comments