Skip to content

Commit 66bf61c

Browse files
netdatabotgithub-actions[bot]
authored andcommitted
Ingest new documentation
1 parent 80671fe commit 66bf61c

24 files changed

Lines changed: 78 additions & 46 deletions

docs/Collecting Metrics/Collectors/Hardware and Sensors/Hardware information collected from kernel ring..mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,15 @@ The default configuration for this integration is not expected to impose a signi
5959

6060
### Prerequisites
6161

62-
No action required.
62+
#### Install the Netdata Driver (netdata_driver.sys)
63+
64+
CPU temperature monitoring on Windows requires the Netdata kernel driver (`netdata_driver.sys`) to be installed on the host. The driver is an optional component and is not installed by default.
65+
66+
When you install Netdata with the Windows MSI installer, select the **Netdata Driver: Hardware Metrics Collection** option on the feature selection screen. If Netdata is already installed without the driver, the installer's Change/Modify option does not expose this checkbox again; uninstall Netdata first, then reinstall it and select the option during setup.
67+
68+
Editing `netdata.conf` alone is not enough. Without the driver, the `GetHardwareInfo` module cannot read the CPU `msr` register, so the `cpu.temperature` chart is never created and CPU temperature will not appear on the dashboard. The collector records an error in the Netdata log, but no temperature chart is produced.
69+
70+
6371

6472
### Configuration
6573

docs/Collecting Metrics/Collectors/Networking/tc QoS classes.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,3 +180,24 @@ Metrics:
180180
| tc.qos_dropped | Class Dropped Packets | a dimension per class | packets/s |
181181
| tc.qos_tokens | Class Tokens | a dimension per class | tokens |
182182
| tc.qos_ctokens | Class cTokens | a dimension per class | ctokens |
183+
184+
185+
186+
## Troubleshooting
187+
188+
### Recurring Cannot find file warnings for tc-qos-helper.conf
189+
190+
When `tc-qos-helper.sh` starts, it looks for its configuration in two places, in this order: the stock configuration directory (typically at `/usr/lib/netdata/conf.d`) and the user [config directory](/docs/netdata-agent/configuration) (typically at `/etc/netdata`). Netdata does not ship a stock `tc-qos-helper.conf`, so on a default installation neither file exists and the script emits a `Cannot find file` warning for each missing path.
191+
192+
These warnings are harmless. When no configuration file is found the script keeps its built-in defaults (for example `tc_show="qdisc"`). They reappear every hour because the script exits and is restarted by Netdata every 3600 seconds (`qos_exit_every=3600`), which re-runs the same checks on each start.
193+
194+
Creating `tc-qos-helper.conf` in your user config directory with the desired setting silences the warning for the user configuration path. The warning for the stock path is expected to remain, because no stock `tc-qos-helper.conf` ships with Netdata, and it is benign.
195+
196+
197+
### FireQOS is not installed warning
198+
199+
When `tc-qos-helper.sh` starts and cannot find FireQOS (neither the `/var/run/fireqos` directory nor the `fireqos` executable), it logs that FireQOS is not installed on this system. This is normal on systems that do not perform QoS traffic shaping with FireQOS.
200+
201+
Like the configuration warnings, this message repeats every hour because the script exits and is restarted by Netdata every 3600 seconds (`qos_exit_every=3600`), re-running the FireQOS presence check on each start.
202+
203+
FireQOS is only required to apply QoS and expose human-readable class names to Netdata. Without it the plugin still collects `tc` qdisc/class metrics directly from the `tc` command. To expose FireQOS class names, [install FireQOS](https://firehol.org/tutorial/fireqos-new-user/). To map numeric class IDs to readable names without FireQOS, list them in `/etc/iproute2/tc_cls` and set `tc_show="class"` in `tc-qos-helper.conf` in your user config directory.

docs/Collecting Metrics/Collectors/Operating Systems/System statistics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Labels:
179179

180180
| Label | Description |
181181
|:-----------|:----------------|
182-
| cpu | Identifier of the CPU core (e.g., core0, core1, core2). |
182+
| cpu | Identifier of the CPU core (e.g., cpu0, cpu1, cpu2). |
183183

184184
Metrics:
185185

docs/Network Performance Monitoring/Network Flows/Enrichment Methods/AWS IP Ranges.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Schema of `ip-ranges.json`:
5353
For the cross-cutting concepts (how multiple network sources merge, the lookup
5454
priority vs static `networks` config, TLS verification rules, the jq engine and
5555
its expected output schema, fetch loop and retry/backoff), see
56-
[Network Identity](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
56+
[Network Identity](/docs/network-performance-monitoring/network-flows/enrichment).
5757

5858

5959
The plugin issues a periodic GET to `https://ip-ranges.amazonaws.com/ip-ranges.json`,
@@ -112,7 +112,7 @@ output (`tenant`, `region`, `role`, `name`, `site`, `city`, `country`, `state`,
112112

113113
The expected `transform` output is a stream of objects, each carrying a `prefix`
114114
(CIDR string) plus any subset of the optional attribute fields. See the
115-
cross-cutting [Network Identity](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment)
115+
cross-cutting [Network Identity](/docs/network-performance-monitoring/network-flows/enrichment)
116116
page for the full output schema.
117117

118118

docs/Network Performance Monitoring/Network Flows/Enrichment Methods/Azure IP Ranges.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ and the rest -- without maintaining the prefix list yourself.
4747

4848
For the full network-identity concept (merge order, jq output shape, TLS
4949
verification, failure modes), see
50-
[Network Identity](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
50+
[Network Identity](/docs/network-performance-monitoring/network-flows/enrichment).
5151

5252

5353
Periodic HTTPS GET against the Service Tags JSON, jq transform via the

docs/Network Performance Monitoring/Network Flows/Enrichment Methods/BMP BGP Monitoring Protocol.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ rollup.
4949

5050
For the cross-cutting Enrichment concept (provider chains, shared trie with
5151
BioRIS, withdrawal handling, restart convergence), see
52-
[Enrichment](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
52+
[Enrichment](/docs/network-performance-monitoring/network-flows/enrichment).
5353

5454

5555
The plugin runs a TCP listener on `0.0.0.0:10179`. This port is the Akvorado

docs/Network Performance Monitoring/Network Flows/Enrichment Methods/CAIDA Routeviews Prefix-to-AS.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ coordinates.
4040

4141
For the IP-intelligence mechanism (lookup order, MMDB composition, refresh,
4242
provider chains), see
43-
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
43+
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment).
4444

4545

4646
The netflow plugin reads MMDB files only. CAIDA publishes compressed text data,

docs/Network Performance Monitoring/Network Flows/Enrichment Methods/Classifiers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Module: classifiers
2727
## Overview
2828

2929
Annotate network flows with exporter and interface labels derived from reusable
30-
classification rules. Where [static metadata](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment)
30+
classification rules. Where [static metadata](/docs/network-performance-monitoring/network-flows/enrichment)
3131
forces you to enumerate every exporter and every ifIndex by hand, classifiers
3232
let you express the network design once -- "anything matching `^edge-` is the
3333
edge tier", "any interface with `BACKBONE-LUMEN` in its description is on
@@ -64,7 +64,7 @@ normalisation.
6464

6565
For the cross-cutting Enrichment concept (where classifiers sit in the merge
6666
order vs static metadata, GeoIP, IPAM, BGP routing), see
67-
[Enrichment](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
67+
[Enrichment](/docs/network-performance-monitoring/network-flows/enrichment).
6868

6969

7070
Each rule is a single boolean expression; an action with no condition (e.g.
@@ -135,7 +135,7 @@ Classifiers shine when there is a pattern to match -- exporter naming
135135
conventions (`edge-...`, `core-...`), management-IP subnets per site,
136136
SNMP interface descriptions that follow a template (`BACKBONE-<carrier>`,
137137
`TRANSIT-...`, `IX-...`), or 100Gbps-equals-core conventions. If your
138-
fleet has no such pattern, [static metadata](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment)
138+
fleet has no such pattern, [static metadata](/docs/network-performance-monitoring/network-flows/enrichment)
139139
is the better fit -- it lets you list each exporter and ifIndex by hand.
140140

141141

docs/Network Performance Monitoring/Network Flows/Enrichment Methods/Custom MMDB Database.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ State and country survive into all four tiers.
4848

4949
For the full IP-intelligence concept (composition rule, ASN provider chain,
5050
auto-detect path order, dual-stack handling, hot reload semantics), see
51-
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
51+
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment).
5252

5353

5454
You build (or download) the MMDB file with your own tooling, place it on the
@@ -228,7 +228,7 @@ The plugin reloads custom databases the same way it reloads stock ones
228228
plugin will pick it up; if it was edited byte-by-byte (rare with MMDB
229229
builders) verify size or mtime actually changed. The reload mechanism
230230
and its 30-second cadence are documented in
231-
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
231+
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment).
232232
Operational practice: have your build pipeline write the new MMDB to a
233233
temp file in the same directory and `rename(2)` it over the live path so
234234
the swap is atomic.

docs/Network Performance Monitoring/Network Flows/Enrichment Methods/DB-IP IP Intelligence.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Populates these flow record fields when a lookup succeeds:
5656
For the cross-provider mechanics (lookup pass ordering, the 30-second hot-reload poll,
5757
the auto-detect path order, multi-database composition, IPv4/IPv6 handling, the failure
5858
modes shared by every MMDB provider), see
59-
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
59+
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment).
6060

6161

6262
Files are read on plugin start and reloaded automatically when their mtime or size
@@ -103,7 +103,7 @@ the binary is available (packaged 32-bit installs do not include it) to populate
103103
sudo /usr/sbin/topology-ip-intel-downloader
104104
```
105105

106-
See the [Enrichment Intel Downloader](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment-intel-downloader)
106+
See the [Enrichment Intel Downloader](/docs/network-performance-monitoring/network-flows/enrichment-intel-downloader)
107107
page for downloader options and how to schedule periodic refreshes. DB-IP Lite
108108
data is published monthly, so a monthly cron of the downloader is the right
109109
cadence -- more frequent runs will not produce newer data.
@@ -196,7 +196,7 @@ private space. The DB-IP-built ASN database tags private ranges so `*_AS_NAME`
196196
renders as `AS0 Private IP Address Space`, while geographic fields stay empty and
197197
private addresses do not appear on maps. Declare your internal CIDRs under
198198
`enrichment.networks` when you want internal labels -- see
199-
[Static metadata](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
199+
[Private and non-routable IPs](/docs/network-performance-monitoring/network-flows/enrichment#private-and-non-routable-ips).
200200

201201

202202
### Stale databases

0 commit comments

Comments
 (0)