Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,15 @@ The default configuration for this integration is not expected to impose a signi

### Prerequisites

No action required.
#### Install the Netdata Driver (netdata_driver.sys)

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.

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.

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.



### Configuration

Expand Down
21 changes: 21 additions & 0 deletions docs/Collecting Metrics/Collectors/Networking/tc QoS classes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -180,3 +180,24 @@ Metrics:
| tc.qos_dropped | Class Dropped Packets | a dimension per class | packets/s |
| tc.qos_tokens | Class Tokens | a dimension per class | tokens |
| tc.qos_ctokens | Class cTokens | a dimension per class | ctokens |



## Troubleshooting

### Recurring Cannot find file warnings for tc-qos-helper.conf

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.

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.

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.


### FireQOS is not installed warning

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.

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.

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.
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Labels:

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

Metrics:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Schema of `ip-ranges.json`:
For the cross-cutting concepts (how multiple network sources merge, the lookup
priority vs static `networks` config, TLS verification rules, the jq engine and
its expected output schema, fetch loop and retry/backoff), see
[Network Identity](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
[Network Identity](/docs/network-performance-monitoring/network-flows/enrichment).


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

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


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ and the rest -- without maintaining the prefix list yourself.

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


Periodic HTTPS GET against the Service Tags JSON, jq transform via the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ rollup.

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


The plugin runs a TCP listener on `0.0.0.0:10179`. This port is the Akvorado
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ coordinates.

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


The netflow plugin reads MMDB files only. CAIDA publishes compressed text data,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Module: classifiers
## Overview

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

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


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


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ State and country survive into all four tiers.

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


You build (or download) the MMDB file with your own tooling, place it on the
Expand Down Expand Up @@ -228,7 +228,7 @@ The plugin reloads custom databases the same way it reloads stock ones
plugin will pick it up; if it was edited byte-by-byte (rare with MMDB
builders) verify size or mtime actually changed. The reload mechanism
and its 30-second cadence are documented in
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment).
Operational practice: have your build pipeline write the new MMDB to a
temp file in the same directory and `rename(2)` it over the live path so
the swap is atomic.
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Populates these flow record fields when a lookup succeeds:
For the cross-provider mechanics (lookup pass ordering, the 30-second hot-reload poll,
the auto-detect path order, multi-database composition, IPv4/IPv6 handling, the failure
modes shared by every MMDB provider), see
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment).


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

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


### Stale databases
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ surfaces the inner IPv4 or IPv6 packet pointed to by next-header 4 or 41.
For the cross-cutting concept (how decap composes with the rest of the enrichment
pipeline, the non-tunnel "drop, do not fall back" semantics, and per-source
dependence on the L2-section path), see
[Decapsulation](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
[Decapsulation](/docs/network-performance-monitoring/network-flows/enrichment).


Set `protocols.decapsulation_mode` in `netflow.yaml` to `srv6` or `vxlan`. The
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Two upstream files exist and they are NOT interchangeable:
For the cross-cutting network-identity behavior (merge order with GeoIP and
static config, jq output contract, TLS rules, single-page fetch, failure /
backoff handling), see
[Network Identity](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
[Network Identity](/docs/network-performance-monitoring/network-flows/enrichment).


Periodic HTTPS GET against the chosen `gstatic.com` URL. The body is parsed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ that specific provider.

For the full network-identity concept (merge order vs GeoIP and static, what
fields you can populate, why TLS verification cannot be disabled), see
[Network Identity](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
[Network Identity](/docs/network-performance-monitoring/network-flows/enrichment).


The plugin issues a periodic HTTP request (GET by default, POST optionally) to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ MaxMind ASN data when you also need AS fields.

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


The netflow plugin reads MMDB files only. Use Netdata's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ coverage is required.

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


The netflow plugin reads MMDB files only. Use Netdata's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ custom MMDB when IPv6 country coverage is required.

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


The netflow plugin reads MMDB files only. Use Netdata's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ or coordinates.

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


The Netdata plugin reads MMDB only. IPtoASN ships gzipped TSV
Expand Down Expand Up @@ -75,7 +75,7 @@ This integration runs as a single instance per Netdata Agent.

Not auto-detected as the default ASN source -- the plugin auto-detects
DB-IP MMDBs in the cache directory at startup
(see [IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment)).
(see [IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment)).
To use IPtoASN, run `topology-ip-intel-downloader` when available to produce IPtoASN-derived
MMDBs (the downloader writes to the same cache paths the plugin scans,
so once present they are picked up automatically on the 30-second
Expand Down Expand Up @@ -231,7 +231,7 @@ no organisation. This is data-source-level, not a plugin issue. If richer AS-nam
coverage matters, layer a MaxMind GeoLite2-ASN MMDB after IPtoASN in
`asn_database` -- per-field "last database with a non-empty value
wins" composition (see
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment))
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment))
means MaxMind names override IPtoASN's empty entries.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ bounded-cardinality geography columns.

For the cross-cutting concept (resolver poll loop, multi-database composition,
ASN provider chain, failure-modes table), see
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment).
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment).


You can use MaxMind in two ways:
Expand Down Expand Up @@ -173,7 +173,7 @@ format.)
Override the default DB-IP auto-detection by pointing `asn_database` and
`geo_database` at your MaxMind MMDB files. Both keys take a list -- you can
chain MaxMind alongside other MMDB sources; see the
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment)
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment)
page for the per-field "last non-empty wins" composition rule.


Expand Down Expand Up @@ -243,7 +243,7 @@ enrichment:

###### MaxMind ASN + DB-IP geo (mixed)

Use MaxMind for ASN richness and keep the bundled DB-IP geo file. Both lookups run; the multi-DB composition rule is documented on the [IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment) page.
Use MaxMind for ASN richness and keep the bundled DB-IP geo file. Both lookups run; the multi-DB composition rule is documented on the [IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment) page.

<details open>
<summary>Config</summary>
Expand Down Expand Up @@ -292,6 +292,6 @@ AS data.

The plugin loads every configured MMDB. If you list both, the per-field
"last non-empty wins" rule applies (see the
[IP Intelligence](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment)
[IP Intelligence](/docs/network-performance-monitoring/network-flows/enrichment)
concept page). Order matters: list the source whose values you want to win
**last**.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ transforms the response with jq, and labels matching flow prefixes with whatever
fields you map. NetBox is the authoritative source -- when the same prefix is
tagged in NetBox and in the static `networks:` block, the static block wins
(operator override is intentional, see the
[Network Identity](https://learn.netdata.cloud/docs/network-performance-monitoring/network-flows/enrichment)
[Network Identity](/docs/network-performance-monitoring/network-flows/enrichment)
concept page).

Use cases: applying your organisation's data-centre rack labels, tenant names,
Expand Down
Loading