]> git.ipfire.org Git - thirdparty/collectd.git/commitdiff
src/daemon/metric.h: Add doc comment for the `unit` field.
authorFlorian Forster <octo@collectd.org>
Mon, 18 Dec 2023 14:01:38 +0000 (15:01 +0100)
committerFlorian Forster <octo@collectd.org>
Thu, 28 Dec 2023 19:50:08 +0000 (20:50 +0100)
src/daemon/metric.h

index 69d890a60be6062a95fe5ed944c6505b856c0ace..e789650ffad12db584adc1f5979072e4b9543f05 100644 (file)
@@ -166,6 +166,9 @@ typedef struct {
 struct metric_family_s {
   char *name;
   char *help;
+  /* unit is a case sensitive "Unified Code for Units of Measure" (UCUM)
+   * denoting the unit of the metric, e.g. "By" for bytes, and "1" for
+   * dimensionless metrics, such as "utilization". */
   char *unit;
   metric_type_t type;