From c9d2bbb8a8e88a6f74ae04777077407f05c18847 Mon Sep 17 00:00:00 2001 From: Markus Frei Date: Tue, 2 Apr 2024 09:30:01 +0200 Subject: [PATCH] Update CONTRIBUTING.rst --- CONTRIBUTING.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9a9cca14..b987ffe2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -372,7 +372,6 @@ Sample: ``label`` doesn't need to be machine friendly, so ``Pages scanned=100;;;;;`` is as valuable as ``pages-scanned=100;;;;;``. - Suffixes: .. code-block:: text @@ -385,6 +384,10 @@ Suffixes: Wherever possible, prefer percentages over absolute values to assist users in comparing different systems with different absolute sizes. +Be aware of already-aggregated values returned by systems and applications. Apache for example returns a value "137.5 kB/request". Sounds good, but this is not a value at the current time of measurement. Instead, it is the average of all requests during the lifetime of the Apache worker process. If you use this in some sort of Grafana panel, you just get a boring line which converges towards a constant value very fast. Not useful at all. + +A monitoring plugin has to calculate such values always on its own. If this is not possible because of missing data, discard them. + PEP8 Style Guide for Python Code --------------------------------