Create a terminology dictionary for Netdata (#19071)
Fotis Voutsas committed
Nov 25, 2024 at 10:33 UTC
0b575e473b6cc1234644c33cf3d8fe055328f7b7
1 file changed
+34
docs/DICTIONARY.md
new
+34
@@ -0,0 +1,34 @@
1
+# Terminology Dictionary
2
+
3
+This guide standardizes terminology for Netdata's documentation and communications. When referring to Netdata mechanisms or concepts, use these terms and definitions to ensure clarity and consistency.
4
+
5
+When the context is clear, we can omit the "Netdata" prefix for brevity.
6
+
7
+## Core Components
8
+
9
+| Term | Definition |
10
+|------------------------|--------------------------------------------------------------------------|
11
+| **Agent** (**Agents**) | The core monitoring software that collects, processes and stores metrics |
12
+| **Cloud** | The centralized platform for managing and visualizing Netdata metrics |
13
+
14
+## Database
15
+
16
+| Term | Definition |
17
+|----------------------|----------------------------------------------------|
18
+| **Tier** (**Tiers**) | Database storage layers with different granularity |
19
+
20
+## Streaming
21
+
22
+| Term | Definition |
23
+|--------------------------|-------------------------------------------------------------|
24
+| **Parent** (**Parents**) | An Agent that receives metrics from other Agents (Children) |
25
+| **Child** (**Children**) | An Agent that streams metrics to another Agent (Parent) |
26
+
27
+## Machine Learning
28
+
29
+| Term | Abbreviation | Definition |
30
+|-------------------------|:------------:|-------------------------------------------------------------------------------------------------|
31
+| **Machine Learning** | ML | An umbrella term for Netdata's ML-powered features |
32
+| **Anomaly Detection** | | The capability to identify unusual patterns in metrics |
33
+| **Metric Correlations** | | Filters dashboard to show metrics with the most significant changes in the selected time window |
34
+| **Anomaly Advisor** | | The interface and tooling for analyzing detected anomalies |
\ No newline at end of file