Skip to content

Commit c35bede

Browse files
committed
Add reno + docs
1 parent 1d20fdc commit c35bede

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

doc/source/configuration/monitoring.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,3 +169,38 @@ If you notice ``HaproxyServerDown`` or ``HaproxyBackendDown`` prometheus
169169
alerts after deployment it's likely the os_exporter secrets have not been
170170
set correctly, double check you have entered the correct authentication
171171
information appropiate to your cloud and re-deploy.
172+
173+
Friendly Network Names
174+
=======================
175+
For operators that prefer to see descriptive or friendly interface names the
176+
following play can be run. This takes network names as defined in kayobe and
177+
relabels the devices/interfaces in Prometheus to make use of these names.
178+
179+
180+
.. code-block:: console
181+
182+
kayobe playbook run etc/kayobe/ansible/prometheus-network-names.yml
183+
kayobe overcloud service reconfigure --kt prometheus
184+
185+
This first generates a template based on the promtheus.yml.j2
186+
``etc/kayobe/ansible/`` and which is further templated for use with
187+
kolla-ansible.
188+
189+
190+
This helps Prometheus provide insights that can be more easily understood by
191+
those without an intimate understanding of a given site.Prometheus Node Exporter
192+
and cAdvisor both provide network statistics using the
193+
interface/device names. This play causes Prometheus to relabel these fields to
194+
human readable names based on the networks as defined in kayobe
195+
e.g. bond1.1838 may become storage_network.
196+
197+
The default labels are preserved with the prefix ``original_``.
198+
For node_exporter, ``device`` is then used for network names, while
199+
``original_device`` is used for the interface itself.
200+
For cAdvisor, ``interface`` is used for network names, and ``original_interface``
201+
is used to preserve the interface name.
202+
203+
**Known-Limitations/Untested**
204+
The current implementation does not cover known edge cases:
205+
* Reusing the same network devices under a different network name.
206+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
features:
3+
- |
4+
Add optional support for relabelling network devices in Prometheus.
5+
Use network names as defined in kayobe, instead of network device names.
6+
Reuse of device names within an environment is not supported.

0 commit comments

Comments
 (0)