Draft

Author: aurbiztondo-splunk

gdi/opentelemetry/components/purefa-receiver.rst

@@ -42,19 +42,104 @@ To complete the configuration, include the receiver in the ``metrics`` pipeline
       metrics:
         receivers: [purefa]
 
+
+
+Configuration settings
+-------------------------------------------------
+
+The following settings are required:
+
+* ``endpoint``. ``http://127.0.0.0:9490/metrics/array`` by default. The URL of the scraper selected endpoint.
+
+* ``fa_array_name``. The array's pretty name to be used as a metrics label.
+
+* ``namespace``. ``purefa`` by default. The selected Pure Storage OpenMetrics Namespace to query.
+
 Configuration example
 ----------------------------------------------------------------------
 
-See the following config example:
+In this example ``array01`` uses the :new-page:`Pure Storage FlashArray OpenMetrics exporter <https://github.com/PureStorage-OpenConnect/pure-fa-openmetrics-exporter>`, while ``array02`` uses the native on-box metrics provided in Purity//FA v6.6.11 or higher.
 
 .. code:: yaml
 
+  extensions:
+    bearertokenauth/array01:
+      token: "..."
+    bearertokenauth/array02:
+      token: "..."
 
+  receivers:
+    purefa/array01:
+      fa_array_name: foobar01
+      endpoint: http://127.0.0.1:9490/metrics
+      array:
+        - address: array01
+          auth:
+            authenticator: bearertokenauth/array01
+      hosts:
+        - address: array01
+          auth:
+            authenticator: bearertokenauth/array01
+      directories:
+        - address: array01
+          auth:
+            authenticator: bearertokenauth/array01
+      pods:
+        - address: array01
+          auth:
+            authenticator: bearertokenauth/array01
+      volumes:
+        - address: array01
+          auth:
+            authenticator: bearertokenauth/array01
+      env: dev
+      settings:
+        reload_intervals:
+          array: 20s
+          hosts: 60s
+          directories: 60s
+          pods: 60s
+          volumes: 60s
+
+    purefa/array02:
+      fa_array_name: foobar02
+      endpoint: https://127.0.0.1/metrics
+      tls:
+        insecure_skip_verify: true
+      array:
+        - address: array02
+          auth:
+            authenticator: bearertokenauth/array02
+      hosts:
+        - address: array02
+          auth:
+            authenticator: bearertokenauth/array02
+      directories:
+        - address: array02
+          auth:
+            authenticator: bearertokenauth/array02
+      pods:
+        - address: array02
+          auth:
+            authenticator: bearertokenauth/array02
+      volumes:
+        - address: array02
+          auth:
+            authenticator: bearertokenauth/array02
+      env: production
+      settings:
+        reload_intervals:
+          array: 20s
+          hosts: 60s
+          directories: 60s
+          pods: 60s
+          volumes: 60s
 
-Configuration settings
--------------------------------------------------
-
-
+  service:
+    extensions: [bearertokenauth/array01,bearertokenauth/array02]
+    pipelines:
+      metrics:
+        receivers: [purefa/array01,purefa/array02]
 
 Settings
 ======================