Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --collector.netdev.device-whitelist flag #1279

Merged
merged 2 commits into from
May 31, 2019

Conversation

tsnoam
Copy link
Contributor

@tsnoam tsnoam commented Mar 9, 2019

Sometimes it is desired to monitor only one netdev. The golang regexp
does not support a negated regex, so the ignored-devices flag is too
cumbersome for this task.
This change introduces a new flag: accept-devices, which is mutually
exclusive to ignored-devices. This flag allows specifying ONLY the
netdev you'd like.

Signed-off-by: Noam Meltzer noam@cynerio.co

collector/netdev_common.go Outdated Show resolved Hide resolved
@tsnoam
Copy link
Contributor Author

tsnoam commented Apr 2, 2019 via email

@SuperQ
Copy link
Member

SuperQ commented Apr 2, 2019

Yea, I understand. I'm willing to accept breaking changes now, as we're before 1.0. I want to try and get to a 1.0 state this year, so I think breaking now is better. What do you think?

@tsnoam
Copy link
Contributor Author

tsnoam commented Apr 3, 2019

Besides using 'whitelist' & 'blacklist' is not PC I have no objection.
I will add a patch for that.

Is there also a transition guide which should be updated?

@tsnoam tsnoam force-pushed the netdev.accept-devices branch from fdfc328 to cddfad2 Compare April 3, 2019 04:57
@SuperQ
Copy link
Member

SuperQ commented Apr 3, 2019

A mention of the new flags should be added to the Breaking changes at the top of the CHANGELOG.md.

Please also add a [CHANGE] entry to the changelog.

@tsnoam
Copy link
Contributor Author

tsnoam commented Apr 3, 2019

@SuperQ already done, please check.

Copy link
Member

@SuperQ SuperQ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@SuperQ SuperQ requested a review from discordianfish April 3, 2019 10:19
@discordianfish
Copy link
Member

I'm not sure, this might come up for all regex we have. While I know it's ugly, maybe we should rather support negative look ahead in the regex by using a different regex library?

You can also already use a hack like --collector.netdev.ignored-devices=^[^e][^t][^h][^0] which would only match everything except eth0..

Either way, open to merge this but we should probably do the same for all other regex flags too.

@brian-brazil
Copy link
Contributor

brian-brazil commented Apr 6, 2019 via email

docs/V1_0_UPGRADE_GUIDE.md Outdated Show resolved Hide resolved
@SuperQ
Copy link
Member

SuperQ commented May 7, 2019

FYI, this needs to be rebased.

@tsnoam tsnoam force-pushed the netdev.accept-devices branch from cddfad2 to 347dc98 Compare May 24, 2019 14:20
@tsnoam
Copy link
Contributor Author

tsnoam commented May 24, 2019

@SuperQ I've updated the PR with:

  1. Removed the file docs/V1_0_UPGRADE_GUIDE.md as requested.
  2. Rebased on top of latest master.

tsnoam added 2 commits May 24, 2019 17:32
Sometimes it is desired to monitor only one netdev. The golang regexp
does not support a negated regex, so the ignored-devices flag is too
cumbersome for this task.
This change introduces a new flag: accept-devices, which is mutually
exclusive to ignored-devices. This flag allows specifying ONLY the
netdev you'd like.

Signed-off-by: Noam Meltzer <noam@cynerio.co>
As requested per CR

Signed-off-by: Noam Meltzer <noam@cynerio.co>
@tsnoam tsnoam force-pushed the netdev.accept-devices branch from 347dc98 to 143343a Compare May 24, 2019 14:33
Copy link
Member

@SuperQ SuperQ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@SuperQ SuperQ changed the title Add --collector.netdev.accept-devices flag Add --collector.netdev.device-whitelist flag May 31, 2019
@SuperQ SuperQ merged commit 501ccf9 into prometheus:master May 31, 2019
SuperQ added a commit that referenced this pull request May 25, 2020
* The netdev collector CLI argument `--collector.netdev.ignored-devices` was renamed to `--collector.netdev.device-blacklist` in order to conform with the systemd collector. #1279
* The label named `state` on `node_systemd_service_restart_total` metrics was changed to `name` to better describe the metric. #1393
* Refactoring of the mdadm collector changes several metrics
    - `node_md_disks_active` is removed
    - `node_md_disks` now has a `state` label for "fail", "spare", "active" disks.
    - `node_md_is_active` is replaced by `node_md_state` with a state set of "active", "inactive", "recovering", "resync".
* Additional label `mountaddr` added to NFS device metrics to distinguish mounts from the same URL, but different IP addresses. #1417
* Metrics node_cpu_scaling_frequency_min_hrts and node_cpu_scaling_frequency_max_hrts of the cpufreq collector were renamed to node_cpu_scaling_frequency_min_hertz and node_cpu_scaling_frequency_max_hertz. #1510
* Collectors that are enabled, but are unable to find data to collect, now return 0 for `node_scrape_collector_success`.

* [CHANGE] Add `--collector.netdev.device-whitelist`. #1279
* [CHANGE] Ignore iso9600 filesystem on Linux #1355
* [CHANGE] Refactor mdadm collector #1403
* [CHANGE] Add `mountaddr` label to NFS metrics. #1417
* [CHANGE] Don't count empty collectors as success. #1613
* [FEATURE] New flag to disable default collectors #1276
* [FEATURE] Add experimental TLS support #1277, #1687, #1695
* [FEATURE] Add collector for Power Supply Class #1280
* [FEATURE] Add new schedstat collector #1389
* [FEATURE] Add FreeBSD zfs support #1394
* [FEATURE] Add uname support for Darwin and OpenBSD #1433
* [FEATURE] Add new metric node_cpu_info #1489
* [FEATURE] Add new thermal_zone collector #1425
* [FEATURE] Add new cooling_device metrics to thermal zone collector #1445
* [FEATURE] Add swap usage on darwin #1508
* [FEATURE] Add Btrfs collector #1512
* [FEATURE] Add RAPL collector #1523
* [FEATURE] Add new softnet collector #1576
* [FEATURE] Add new udp_queues collector #1503
* [FEATURE] Add basic authentication #1673
* [ENHANCEMENT] Log pid when there is a problem reading the process stats #1341
* [ENHANCEMENT] Collect InfiniBand port state and physical state #1357
* [ENHANCEMENT] Include additional XFS runtime statistics. #1423
* [ENHANCEMENT] Report non-fatal collection errors in the exporter metric. #1439
* [ENHANCEMENT] Expose IPVS firewall mark as a label #1455
* [ENHANCEMENT] Add check for systemd version before attempting to query certain metrics. #1413
* [ENHANCEMENT] Add a flag to adjust mount timeout #1486
* [ENHANCEMENT] Add new counters for flush requests in Linux 5.5 #1548
* [ENHANCEMENT] Add metrics and tests for UDP receive and send buffer errors #1534
* [ENHANCEMENT] The sockstat collector now exposes IPv6 statistics in addition to the existing IPv4 support. #1552
* [ENHANCEMENT] Add infiniband info metric #1563
* [ENHANCEMENT] Add unix socket support for supervisord collector #1592
* [ENHANCEMENT] Implement loadavg on all BSDs without cgo #1584
* [ENHANCEMENT] Add model_name and stepping to node_cpu_info metric #1617
* [ENHANCEMENT] Add `--collector.perf.cpus` to allow setting the CPU list for perf stats. #1561
* [ENHANCEMENT] Add metrics for IO errors and retires on Darwin. #1636
* [ENHANCEMENT] Add perf tracepoint collection flag #1664
* [ENHANCEMENT] ZFS: read contents of objset file #1632
* [ENHANCEMENT] Linux CPU: Cache CPU metrics to make them monotonically increasing #1711
* [BUGFIX] Read /proc/net files with a single read syscall #1380
* [BUGFIX] Renamed label `state` to `name` on `node_systemd_service_restart_total`. #1393
* [BUGFIX] Fix netdev nil reference on Darwin #1414
* [BUGFIX] Strip path.rootfs from mountpoint labels #1421
* [BUGFIX] Fix seconds reported by schedstat #1426
* [BUGFIX] Fix empty string in path.rootfs #1464
* [BUGFIX] Fix typo in cpufreq metric names #1510
* [BUGFIX] Read /proc/stat in one syscall #1538
* [BUGFIX] Fix OpenBSD cache memory information #1542
* [BUGFIX] Refactor textfile collector to avoid looping defer #1549
* [BUGFIX] Fix network speed math #1580
* [BUGFIX] collector/systemd: use regexp to extract systemd version #1647
* [BUGFIX] Fix initialization in perf collector when using multiple CPUs #1665
* [BUGFIX] Fix accidentally empty lines in meminfo_linux #1671

Signed-off-by: Ben Kochie <superq@gmail.com>
@SuperQ SuperQ mentioned this pull request May 25, 2020
@analytically
Copy link

allowlist and denylist would have been better choices

@SuperQ
Copy link
Member

SuperQ commented Jun 8, 2020

@analytically Yup. I'm currently planning a cleanup to fix all instances of this.

oblitorum pushed a commit to shatteredsilicon/node_exporter that referenced this pull request Apr 9, 2024
* Add --collector.netdev.device-whitelist flag

Sometimes it is desired to monitor only one netdev. The golang regexp
does not support a negated regex, so the ignored-devices flag is too
cumbersome for this task.
This change introduces a new flag: accept-devices, which is mutually
exclusive to ignored-devices. This flag allows specifying ONLY the
netdev you'd like.

Signed-off-by: Noam Meltzer <noam@cynerio.co>
oblitorum pushed a commit to shatteredsilicon/node_exporter that referenced this pull request Apr 9, 2024
* The netdev collector CLI argument `--collector.netdev.ignored-devices` was renamed to `--collector.netdev.device-blacklist` in order to conform with the systemd collector. prometheus#1279
* The label named `state` on `node_systemd_service_restart_total` metrics was changed to `name` to better describe the metric. prometheus#1393
* Refactoring of the mdadm collector changes several metrics
    - `node_md_disks_active` is removed
    - `node_md_disks` now has a `state` label for "fail", "spare", "active" disks.
    - `node_md_is_active` is replaced by `node_md_state` with a state set of "active", "inactive", "recovering", "resync".
* Additional label `mountaddr` added to NFS device metrics to distinguish mounts from the same URL, but different IP addresses. prometheus#1417
* Metrics node_cpu_scaling_frequency_min_hrts and node_cpu_scaling_frequency_max_hrts of the cpufreq collector were renamed to node_cpu_scaling_frequency_min_hertz and node_cpu_scaling_frequency_max_hertz. prometheus#1510
* Collectors that are enabled, but are unable to find data to collect, now return 0 for `node_scrape_collector_success`.

* [CHANGE] Add `--collector.netdev.device-whitelist`. prometheus#1279
* [CHANGE] Ignore iso9600 filesystem on Linux prometheus#1355
* [CHANGE] Refactor mdadm collector prometheus#1403
* [CHANGE] Add `mountaddr` label to NFS metrics. prometheus#1417
* [CHANGE] Don't count empty collectors as success. prometheus#1613
* [FEATURE] New flag to disable default collectors prometheus#1276
* [FEATURE] Add experimental TLS support prometheus#1277, prometheus#1687, prometheus#1695
* [FEATURE] Add collector for Power Supply Class prometheus#1280
* [FEATURE] Add new schedstat collector prometheus#1389
* [FEATURE] Add FreeBSD zfs support prometheus#1394
* [FEATURE] Add uname support for Darwin and OpenBSD prometheus#1433
* [FEATURE] Add new metric node_cpu_info prometheus#1489
* [FEATURE] Add new thermal_zone collector prometheus#1425
* [FEATURE] Add new cooling_device metrics to thermal zone collector prometheus#1445
* [FEATURE] Add swap usage on darwin prometheus#1508
* [FEATURE] Add Btrfs collector prometheus#1512
* [FEATURE] Add RAPL collector prometheus#1523
* [FEATURE] Add new softnet collector prometheus#1576
* [FEATURE] Add new udp_queues collector prometheus#1503
* [FEATURE] Add basic authentication prometheus#1673
* [ENHANCEMENT] Log pid when there is a problem reading the process stats prometheus#1341
* [ENHANCEMENT] Collect InfiniBand port state and physical state prometheus#1357
* [ENHANCEMENT] Include additional XFS runtime statistics. prometheus#1423
* [ENHANCEMENT] Report non-fatal collection errors in the exporter metric. prometheus#1439
* [ENHANCEMENT] Expose IPVS firewall mark as a label prometheus#1455
* [ENHANCEMENT] Add check for systemd version before attempting to query certain metrics. prometheus#1413
* [ENHANCEMENT] Add a flag to adjust mount timeout prometheus#1486
* [ENHANCEMENT] Add new counters for flush requests in Linux 5.5 prometheus#1548
* [ENHANCEMENT] Add metrics and tests for UDP receive and send buffer errors prometheus#1534
* [ENHANCEMENT] The sockstat collector now exposes IPv6 statistics in addition to the existing IPv4 support. prometheus#1552
* [ENHANCEMENT] Add infiniband info metric prometheus#1563
* [ENHANCEMENT] Add unix socket support for supervisord collector prometheus#1592
* [ENHANCEMENT] Implement loadavg on all BSDs without cgo prometheus#1584
* [ENHANCEMENT] Add model_name and stepping to node_cpu_info metric prometheus#1617
* [ENHANCEMENT] Add `--collector.perf.cpus` to allow setting the CPU list for perf stats. prometheus#1561
* [ENHANCEMENT] Add metrics for IO errors and retires on Darwin. prometheus#1636
* [ENHANCEMENT] Add perf tracepoint collection flag prometheus#1664
* [ENHANCEMENT] ZFS: read contents of objset file prometheus#1632
* [ENHANCEMENT] Linux CPU: Cache CPU metrics to make them monotonically increasing prometheus#1711
* [BUGFIX] Read /proc/net files with a single read syscall prometheus#1380
* [BUGFIX] Renamed label `state` to `name` on `node_systemd_service_restart_total`. prometheus#1393
* [BUGFIX] Fix netdev nil reference on Darwin prometheus#1414
* [BUGFIX] Strip path.rootfs from mountpoint labels prometheus#1421
* [BUGFIX] Fix seconds reported by schedstat prometheus#1426
* [BUGFIX] Fix empty string in path.rootfs prometheus#1464
* [BUGFIX] Fix typo in cpufreq metric names prometheus#1510
* [BUGFIX] Read /proc/stat in one syscall prometheus#1538
* [BUGFIX] Fix OpenBSD cache memory information prometheus#1542
* [BUGFIX] Refactor textfile collector to avoid looping defer prometheus#1549
* [BUGFIX] Fix network speed math prometheus#1580
* [BUGFIX] collector/systemd: use regexp to extract systemd version prometheus#1647
* [BUGFIX] Fix initialization in perf collector when using multiple CPUs prometheus#1665
* [BUGFIX] Fix accidentally empty lines in meminfo_linux prometheus#1671

Signed-off-by: Ben Kochie <superq@gmail.com>
oblitorum pushed a commit to shatteredsilicon/node_exporter that referenced this pull request Apr 9, 2024
* Add --collector.netdev.device-whitelist flag

Sometimes it is desired to monitor only one netdev. The golang regexp
does not support a negated regex, so the ignored-devices flag is too
cumbersome for this task.
This change introduces a new flag: accept-devices, which is mutually
exclusive to ignored-devices. This flag allows specifying ONLY the
netdev you'd like.

Signed-off-by: Noam Meltzer <noam@cynerio.co>
oblitorum pushed a commit to shatteredsilicon/node_exporter that referenced this pull request Apr 9, 2024
* The netdev collector CLI argument `--collector.netdev.ignored-devices` was renamed to `--collector.netdev.device-blacklist` in order to conform with the systemd collector. prometheus#1279
* The label named `state` on `node_systemd_service_restart_total` metrics was changed to `name` to better describe the metric. prometheus#1393
* Refactoring of the mdadm collector changes several metrics
    - `node_md_disks_active` is removed
    - `node_md_disks` now has a `state` label for "fail", "spare", "active" disks.
    - `node_md_is_active` is replaced by `node_md_state` with a state set of "active", "inactive", "recovering", "resync".
* Additional label `mountaddr` added to NFS device metrics to distinguish mounts from the same URL, but different IP addresses. prometheus#1417
* Metrics node_cpu_scaling_frequency_min_hrts and node_cpu_scaling_frequency_max_hrts of the cpufreq collector were renamed to node_cpu_scaling_frequency_min_hertz and node_cpu_scaling_frequency_max_hertz. prometheus#1510
* Collectors that are enabled, but are unable to find data to collect, now return 0 for `node_scrape_collector_success`.

* [CHANGE] Add `--collector.netdev.device-whitelist`. prometheus#1279
* [CHANGE] Ignore iso9600 filesystem on Linux prometheus#1355
* [CHANGE] Refactor mdadm collector prometheus#1403
* [CHANGE] Add `mountaddr` label to NFS metrics. prometheus#1417
* [CHANGE] Don't count empty collectors as success. prometheus#1613
* [FEATURE] New flag to disable default collectors prometheus#1276
* [FEATURE] Add experimental TLS support prometheus#1277, prometheus#1687, prometheus#1695
* [FEATURE] Add collector for Power Supply Class prometheus#1280
* [FEATURE] Add new schedstat collector prometheus#1389
* [FEATURE] Add FreeBSD zfs support prometheus#1394
* [FEATURE] Add uname support for Darwin and OpenBSD prometheus#1433
* [FEATURE] Add new metric node_cpu_info prometheus#1489
* [FEATURE] Add new thermal_zone collector prometheus#1425
* [FEATURE] Add new cooling_device metrics to thermal zone collector prometheus#1445
* [FEATURE] Add swap usage on darwin prometheus#1508
* [FEATURE] Add Btrfs collector prometheus#1512
* [FEATURE] Add RAPL collector prometheus#1523
* [FEATURE] Add new softnet collector prometheus#1576
* [FEATURE] Add new udp_queues collector prometheus#1503
* [FEATURE] Add basic authentication prometheus#1673
* [ENHANCEMENT] Log pid when there is a problem reading the process stats prometheus#1341
* [ENHANCEMENT] Collect InfiniBand port state and physical state prometheus#1357
* [ENHANCEMENT] Include additional XFS runtime statistics. prometheus#1423
* [ENHANCEMENT] Report non-fatal collection errors in the exporter metric. prometheus#1439
* [ENHANCEMENT] Expose IPVS firewall mark as a label prometheus#1455
* [ENHANCEMENT] Add check for systemd version before attempting to query certain metrics. prometheus#1413
* [ENHANCEMENT] Add a flag to adjust mount timeout prometheus#1486
* [ENHANCEMENT] Add new counters for flush requests in Linux 5.5 prometheus#1548
* [ENHANCEMENT] Add metrics and tests for UDP receive and send buffer errors prometheus#1534
* [ENHANCEMENT] The sockstat collector now exposes IPv6 statistics in addition to the existing IPv4 support. prometheus#1552
* [ENHANCEMENT] Add infiniband info metric prometheus#1563
* [ENHANCEMENT] Add unix socket support for supervisord collector prometheus#1592
* [ENHANCEMENT] Implement loadavg on all BSDs without cgo prometheus#1584
* [ENHANCEMENT] Add model_name and stepping to node_cpu_info metric prometheus#1617
* [ENHANCEMENT] Add `--collector.perf.cpus` to allow setting the CPU list for perf stats. prometheus#1561
* [ENHANCEMENT] Add metrics for IO errors and retires on Darwin. prometheus#1636
* [ENHANCEMENT] Add perf tracepoint collection flag prometheus#1664
* [ENHANCEMENT] ZFS: read contents of objset file prometheus#1632
* [ENHANCEMENT] Linux CPU: Cache CPU metrics to make them monotonically increasing prometheus#1711
* [BUGFIX] Read /proc/net files with a single read syscall prometheus#1380
* [BUGFIX] Renamed label `state` to `name` on `node_systemd_service_restart_total`. prometheus#1393
* [BUGFIX] Fix netdev nil reference on Darwin prometheus#1414
* [BUGFIX] Strip path.rootfs from mountpoint labels prometheus#1421
* [BUGFIX] Fix seconds reported by schedstat prometheus#1426
* [BUGFIX] Fix empty string in path.rootfs prometheus#1464
* [BUGFIX] Fix typo in cpufreq metric names prometheus#1510
* [BUGFIX] Read /proc/stat in one syscall prometheus#1538
* [BUGFIX] Fix OpenBSD cache memory information prometheus#1542
* [BUGFIX] Refactor textfile collector to avoid looping defer prometheus#1549
* [BUGFIX] Fix network speed math prometheus#1580
* [BUGFIX] collector/systemd: use regexp to extract systemd version prometheus#1647
* [BUGFIX] Fix initialization in perf collector when using multiple CPUs prometheus#1665
* [BUGFIX] Fix accidentally empty lines in meminfo_linux prometheus#1671

Signed-off-by: Ben Kochie <superq@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants