From 39c5afb18d2697ccfc78a3d2071f4dc8f6c5bf56 Mon Sep 17 00:00:00 2001
From: Jonathan Rosser <jonathan.rosser@rd.bbc.co.uk>
Date: Tue, 5 Jun 2018 14:04:57 +0100
Subject: [PATCH] Add config override docs for gathering uwsgi stats

Change-Id: Icbe6345223cc0a2d7fa3620351f598ac24b54509
---
 elk_metrics_6x/readme.rst | 63 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)

diff --git a/elk_metrics_6x/readme.rst b/elk_metrics_6x/readme.rst
index 1be2400a..f2eacbfe 100644
--- a/elk_metrics_6x/readme.rst
+++ b/elk_metrics_6x/readme.rst
@@ -162,6 +162,69 @@ The individual playbooks found within this repository can be independently run
 at anytime.
 
 
+Optional | Enable uwsgi stats
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Config overrides can be used to make uwsgi stats available on unix
+domain sockets. Any /tmp/*uwsgi-stats.sock will be picked up by Metricsbeat.
+
+.. code-block:: yaml
+
+    nova_api_metadata_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/nova-api-metadata-uwsgi-stats.sock"
+
+    keystone_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/keystone-uwsgi-stats.sock"
+
+    cinder_api_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/cinder-api-uwsgi-stats.sock"
+
+    glance_api_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/glance-api-uwsgi-stats.sock"
+
+    heat_api_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/heat-api-uwsgi-stats.sock"
+
+    heat_api_cfn_init_overrides:
+      uwsgi:
+        stats: "/tmp/heat-api-cfn-uwsgi-stats.sock"
+
+    nova_api_metadata_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/nova-api-metadata-uwsgi-stats.sock"
+
+    nova_api_os_compute_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/nova-api-os-compute-uwsgi-stats.sock"
+
+    nova_placement_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/nova-placement-uwsgi-stats.sock"
+
+    octavia_api_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/octavia-api-uwsgi-stats.sock"
+
+    sahara_api_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/sahara-api-uwsgi-stats.sock"
+
+    ironic_api_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/ironic-api-uwsgi-stats.sock"
+
+    magnum_api_uwsgi_ini_overrides:
+      uwsgi:
+        stats: "/tmp/magnum-api-uwsgi-stats.sock"
+
+Rerun all of the **openstack-ansible** playbooks to enable these stats. Use the *-config
+tags on all of the `os_*` roles.
+
 Optional | add Grafana visualizations
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^