fluent-plugin-node-exporter-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5783b3b581c87d3e305da625e7cb9dabf63aee126bc2f23ca889a553906c131
+  data.tar.gz: da252aa8bf053fd1fdbe0fb5111804d6865a9f16dbd78527d8fa13ccb2ffbb10
+SHA512:
+  metadata.gz: 782fb7e500cb04da57373ba18fa2da26a54c25f4fb9951dacad0ee073c74af1c5010de907ea532ad46c6b2f98564524d589a5bc213cd80545d883ad2d86e99c0
+  data.tar.gz: d930fe4fd9b378535af2c3a977441a61fa9a703ddb2d101217494fad91b9cf2a0b1cb0d3584721e2def4bee69e5d09e0ca7dcdafdc652527e68fd7f7a98e2598

data/.github/workflows/linux-test.yaml

@@ -0,0 +1,42 @@
+name: Testing on Ubuntu
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.0', '2.7', '2.6']
+        os: [ubuntu-latest]
+        experimental: [false]
+        include:
+          - ruby-version: head
+            os: ubuntu-latest
+            experimental: true
+# FIXME: on GitHub action, when cpufreq is not available by default
+#        capability: [true, false]
+        capability: [false]
+
+    name: Ruby ${{ matrix.ruby-version }} capability ${{ matrix.capability }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt -V install libcap-ng-dev
+          gem install bundler -v 2.2.27
+          bundle _2.2.27_ install
+      - name: setup linux capability (cap_dac_read_search=+eip)
+        run: sudo setcap cap_dac_read_search=+eip $(command -v ruby)
+        if: ${{ matrix.capability }}
+      - name: show linux capability
+        run: sudo getcap $(command -v ruby)
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,2 @@
+*.lock
+vendor

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 0.1.0
+
+## Release v0.1.0 - 2021/09/21
+
+* Initial release.
+* It ships node_exporter_metrics input/parser plugins.

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,167 @@
+# fluent-plugin-node-exporter-metrics
+
+[![CI on GitHub Actions](https://github.com/fluent-plugins-nursery/fluent-plugin-node-exporter-metrics/actions/workflows/linux-test.yaml/badge.svg)](https://github.com/fluent-plugins-nursery/fluent-plugin-node-exporter-metrics/actions/workflows/linux-test.yaml)
+
+[Fluentd](https://fluentd.org/) input plugin to collect metrics which is similar to Fluent-bit's [node_exporter_metrics](https://docs.fluentbit.io/manual/pipeline/inputs/node-exporter-metrics).
+
+
+fluent-plugin-node-exporter-metrics provides 2 types of input/parser plugins.
+
+* node_exporter_metrics (Input plugin)
+* node_exporter_metrics (Parser plugin, for debugging purpose)
+
+## Installation
+
+### Prerequisite
+
+As fluent-plugin-node-exporter-metrics depends external libraries,
+you must install dependency libraries in beforehand.
+
+Note that CMake 3.13 or later must be installed.
+
+### CentOS 7/RHEL 7
+
+```
+$ sudo yum install libcap-ng-devel gcc cmake3
+```
+
+### CentOS 8/RHEL 8
+
+```
+$ sudo dnf install libcap-ng-devel gcc cmake
+```
+
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-node-exporter-metrics
+```
+
+Or (If you already using td-agent)
+
+```
+$ sudo td-agent-gem install fluent-plugin-node-exporter-metrics
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-node-exporter-metrics"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Documentation
+
+### node_exporter_metrics (Input plugin)
+
+11 collectors are available.
+All collector is enabled by default.
+
+See each collector documentation in details.
+
+* [cpu](docs/cpu.md)
+* [cpufreq](docs/cpufreq.md) (requires specific permission to use)
+* [diskstats](docs/diskstats.md)
+* [filefd](docs/filefd.md)
+* [loadavg](docs/loadavg.md)
+* [meminfo](docs/meminfo.md)
+* [netdev](docs/netdev.md)
+* [stat](docs/stat.md)
+* [time](docs/time.md)
+* [uname](docs/uname.md)
+* [vmstat](docs/vmstat.md)
+
+#### Configuration
+
+| parameter       | type              | description                                                    | default |
+|-----------------|-------------------|----------------------------------------------------------------|---------|
+| scrape_interval | time (optional)   | Interval to scrape metrics from node                           | `5`     |
+| procfs_path     | string (optional) | Path to mount point to collect process information and metrics | `/proc` |
+| sysfs_path      | string (optional) | Path to file-system to collect system metrics                  | `/sys`  |
+| tag             | string (optional) | Tag string                                                     |         |
+| cpu             | bool (optional)   | Enable cpu collector                                           | `true`  |
+| cpufreq         | bool (optional)   | Enable cpufreq collector                                       | `true`  |
+| diskstats       | bool (optional)   | Enable diskstats collector                                     | `true`  |
+| filefd          | bool (optional)   | Enable filefd collector                                        | `true`  |
+| loadavg         | bool (optional)   | Enable loadavg collector                                       | `true`  |
+| meminfo         | bool (optional)   | Enable meminfo collector                                       | `true`  |
+| netdev          | bool (optional)   | Enable netdev collector                                        | `true`  |
+| stat            | bool (optional)   | Enable stat collector                                          | `true`  |
+| time            | bool (optional)   | Enable time collector                                          | `true`  |
+| uname           | bool (optional)   | Enable uname collector                                         | `true`  |
+| vmstat          | bool (optional)   | Enable vmstat collector                                        | `true`  |
+
+Here is the sample configuration.
+
+```
+<source>
+  @type node_exporter_metrics
+  tag node_metrics
+</source>
+```
+
+Event is emitted as `{"cmetrics": <MESSAGEPACK_BINARY_BLOBS>}`.
+
+```
+2021-09-21 10:47:54.255725938 +0900 node_metrics: {"cmetrics":"...."}
+```
+
+### node_exporter_metrics (Parser plugin, for debugging purpose only)
+
+This parser plugin is designed for debugging purpose to check metrics binary blobs.
+
+#### Configuration
+
+No configuration parameters.
+
+Here is the sample configuration to use `@type node_exporter_metrics` in filter section.
+
+```
+<source>
+  @type node_exporter_metrics
+  tag node_metrics
+  cpu false
+  cpufreq false
+  diskstats false
+  filefd false
+  loadavg false
+  meminfo false
+  netdev false
+  stat false
+  time true
+  uname false
+  vmstat false
+</source>
+
+<filter node_metrics>
+  @type parser
+  key_name cmetrics
+  <parse>
+    @type node_exporter_metrics
+  </parse>
+</filter>
+
+<match node_metrics>
+  @type stdout
+</match>
+```
+
+Here is the result.
+
+```
+2021-09-21 10:57:48.015023773 +0900 node_metrics: [{"name":"node_time_seconds","value":1.632189468,"desc":"System time in seconds since epoch (1970).","ts":1632189468014812147}]
+```
+
+## Copyright
+
+* Copyright(c) 2021- Kentaro Hayashi
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/docs/cpu.md

@@ -0,0 +1,26 @@
+# CPU Collector
+
+## Metric and label naming
+
+* node_cpu_core_throttles_count
+* node_cpu_core_throttles_total {"core"=>..., "package"=>...}
+* node_cpu_guest_seconds_total {"cpu"=>..., "mode"=>...}
+* node_cpu_package_throttles_total {"package"=>...}
+* node_cpu_seconds_total {"cpu"=>..., "mode"=>...}
+
+## Metric and its data sources
+
+Cpu collector access the following data sources.
+
+### node_cpu_core_throttles_total, node_cpu_package_throttles_total
+
+* /sys/devices/system/cpu/cpuN/thermal_throttle/package_throttle_count
+* /sys/devices/system/cpu/cpuN/thermal_throttle/core_throttle_count
+* /sys/devices/system/cpu/cpuN/topology/core_id
+* /sys/devices/system/cpu/cpuN/topology/physical_package_id
+
+NOTE: This metric is not available on all platforms.
+
+### node_cpu_seconds_total, node_cpu_guest_seconds_total
+
+* /proc/stat

data/docs/cpufreq.md

@@ -0,0 +1,43 @@
+# Cpufreq Collector
+
+## Prerequisite
+
+If ruby binary is executed with non-root user, linux capability
+must be enabled for cpufreq collector.
+
+```sh
+$ sudo setcap cap_dac_read_search=+eip PATH_TO_RUBY
+```
+
+If you already installed td-agent, you can use `fluent-cap-ctl`.
+
+```sh
+$ sudo /opt/td-agent/bin/fluent-cap-ctl --add dac_read_search -f /opt/td-agent/bin/ruby 
+Updating dac_read_search done.
+Adding dac_read_search done.
+```
+
+## Metric and label naming
+
+* node_cpu_frequency_hertz {"cpu"=>...}
+* node_cpu_frequency_max_hertz {"cpu"=>...}
+* node_cpu_frequency_min_hertz {"cpu"=>...}
+* node_cpu_scaling_frequency_hertz {"cpu"=>...}
+* node_cpu_scaling_frequency_max_hertz {"cpu"=>...}
+* node_cpu_scaling_frequency_min_hertz {"cpu"=>...}
+
+NOTE: node_cpu_frequency_hertz is not available on all platforms.
+
+## Metric and its data sources
+
+Cpufreq collector access the following data sources.
+
+* /sys/devices/system/cpu/cpuN/cpufreq/cpuinfo_cur_freq
+* /sys/devices/system/cpu/cpuN/cpufreq/cpuinfo_max_freq
+* /sys/devices/system/cpu/cpuN/cpufreq/cpuinfo_min_freq
+* /sys/devices/system/cpu/cpuN/cpufreq/scaling_cur_freq
+* /sys/devices/system/cpu/cpuN/cpufreq/scaling_max_freq
+* /sys/devices/system/cpu/cpuN/cpufreq/scaling_min_freq
+
+NOTE: cpuinfo_cur_freq is not available on all platforms, so 
+there is case that node_cpu_frequency_hertz is not available.

data/docs/diskstats.md

@@ -0,0 +1,27 @@
+# Diskstats Collector
+
+## Metric and label naming
+
+* node_disk_discard_time_seconds_total {"device"=>...}
+* node_disk_discards_completed_total {"device"=>...}
+* node_disk_discards_merged_total {"device"=>...}
+* node_disk_discards_sectors_total {"device"=>...}
+* node_disk_flush_requests_time_seconds_total {"device"=>...}
+* node_disk_flush_requests_total {"device"=>...}
+* node_disk_io_now {"device"=>...}
+* node_disk_io_time_seconds_total {"device"=>...}
+* node_disk_io_time_weighted_seconds_total {"device"=>...}
+* node_disk_read_bytes_total {"device"=>...}
+* node_disk_reads_completed_total {"device"=>...}
+* node_disk_reads_merged_total {"device"=>...}
+* node_disk_reads_time_seconds_total {"device"=>...}
+* node_disk_write_time_seconds_total {"device"=>...}
+* node_disk_writes_completed_total {"device"=>...}
+* node_disk_writes_merged_total {"device"=>...}
+* node_disk_written_bytes_total {"device"=>...}
+
+## Metric and its data sources
+
+Diskstats collector access the following data sources.
+
+* /proc/diskstats

data/docs/filefd.md

@@ -0,0 +1,12 @@
+# Filefd Collector
+
+## Metric and label naming
+
+* node_filefd_allocated
+* node_filefd_maximum
+
+## Metric and its data sources
+
+filefd collector access the following data sources.
+
+* /proc/sys/fs/file-nr

data/docs/loadavg.md

@@ -0,0 +1,13 @@
+# Loadavg Collector
+
+## Metric and label naming
+
+* node_load1
+* node_load15
+* node_load5
+
+## Metric and its data sources
+
+Loadavg collector access the following data sources.
+
+* /proc/loadavg

data/docs/meminfo.md

@@ -0,0 +1,61 @@
+# Meminfo Collector
+
+## Metric and label naming
+
+* node_memory_Active_anon_bytes
+* node_memory_Active_bytes
+* node_memory_Active_file_bytes
+* node_memory_AnonHugePages_bytes
+* node_memory_AnonPages_bytes
+* node_memory_Bounce_bytes
+* node_memory_Buffers_bytes
+* node_memory_Cached_bytes
+* node_memory_CommitLimit_bytes
+* node_memory_Committed_AS_bytes
+* node_memory_DirectMap1G_bytes
+* node_memory_DirectMap2M_bytes
+* node_memory_DirectMap4k_bytes
+* node_memory_Dirty_bytes
+* node_memory_FileHugePages_bytes
+* node_memory_FilePmdMapped_bytes
+* node_memory_HardwareCorrupted_bytes
+* node_memory_HugePages_Free
+* node_memory_HugePages_Rsvd
+* node_memory_HugePages_Surp
+* node_memory_HugePages_Total
+* node_memory_Hugepagesize_bytes
+* node_memory_Hugetlb_bytes
+* node_memory_Inactive_anon_bytes
+* node_memory_Inactive_bytes
+* node_memory_Inactive_file_bytes
+* node_memory_KReclaimable_bytes
+* node_memory_KernelStack_bytes
+* node_memory_Mapped_bytes
+* node_memory_MemAvailable_bytes
+* node_memory_MemFree_bytes
+* node_memory_MemTotal_bytes
+* node_memory_Mlocked_bytes
+* node_memory_NFS_Unstable_bytes
+* node_memory_PageTables_bytes
+* node_memory_Percpu_bytes
+* node_memory_SReclaimable_bytes
+* node_memory_SUnreclaim_bytes
+* node_memory_ShmemHugePages_bytes
+* node_memory_ShmemPmdMapped_bytes
+* node_memory_Shmem_bytes
+* node_memory_Slab_bytes
+* node_memory_SwapCached_bytes
+* node_memory_SwapFree_bytes
+* node_memory_SwapTotal_bytes
+* node_memory_Unevictable_bytes
+* node_memory_VmallocChunk_bytes
+* node_memory_VmallocTotal_bytes
+* node_memory_VmallocUsed_bytes
+* node_memory_WritebackTmp_bytes
+* node_memory_Writeback_bytes
+
+## Metric and its data sources
+
+Meminfo collector access the following data sources.
+
+* /proc/meminfo

data/docs/netdev.md

@@ -0,0 +1,26 @@
+# Netdev Collector
+
+## Metric and label naming
+
+* node_network_receive_bytes_total {"device"=>...}
+* node_network_receive_compressed_total {"device"=>...}
+* node_network_receive_drop_total {"device"=>...}
+* node_network_receive_errs_total {"device"=>...}
+* node_network_receive_fifo_total {"device"=>...}
+* node_network_receive_frame_total {"device"=>...}
+* node_network_receive_multicast_total {"device"=>...}
+* node_network_receive_packets_total {"device"=>...}
+* node_network_transmit_bytes_total {"device"=>...}
+* node_network_transmit_carrier_total {"device"=>...}
+* node_network_transmit_colls_total {"device"=>...}
+* node_network_transmit_compressed_total {"device"=>...}
+* node_network_transmit_drop_total {"device"=>...}
+* node_network_transmit_errs_total {"device"=>...}
+* node_network_transmit_fifo_total {"device"=>...}
+* node_network_transmit_packets_total {"device"=>...}
+
+## Metric and its data sources
+
+Netdev collector access the following data sources.
+
+* /proc/net/dev