From bbaed80fbbf13aef9df39fa0c8eb98418d709b11 Mon Sep 17 00:00:00 2001 From: ktsaou Date: Thu, 21 Sep 2023 16:05:28 +0000 Subject: Generate Integrations Documentation --- .../apps.plugin/integrations/applications.md | 112 +++++++ collectors/apps.plugin/integrations/user_groups.md | 112 +++++++ collectors/apps.plugin/integrations/users.md | 112 +++++++ .../cgroups.plugin/integrations/containers.md | 160 +++++++++ .../integrations/kubernetes_containers.md | 178 ++++++++++ .../integrations/libvirt_containers.md | 160 +++++++++ .../cgroups.plugin/integrations/lxc_containers.md | 160 +++++++++ .../integrations/ovirt_containers.md | 160 +++++++++ .../integrations/proxmox_containers.md | 160 +++++++++ .../integrations/systemd_services.md | 111 +++++++ .../integrations/virtual_machines.md | 160 +++++++++ collectors/charts.d.plugin/ap/README.md | 105 +----- .../ap/integrations/access_points.md | 167 ++++++++++ collectors/charts.d.plugin/apcupsd/README.md | 27 +- .../apcupsd/integrations/apc_ups.md | 187 +++++++++++ collectors/charts.d.plugin/libreswan/README.md | 62 +--- .../libreswan/integrations/libreswan.md | 187 +++++++++++ collectors/charts.d.plugin/nut/README.md | 80 +---- .../nut/integrations/network_ups_tools_nut.md | 201 ++++++++++++ collectors/charts.d.plugin/opensips/README.md | 25 +- .../opensips/integrations/opensips.md | 185 +++++++++++ collectors/charts.d.plugin/sensors/README.md | 82 +---- .../sensors/integrations/linux_sensors_sysfs.md | 194 +++++++++++ collectors/cups.plugin/README.md | 69 +--- collectors/cups.plugin/integrations/cups.md | 134 ++++++++ .../debugfs.plugin/integrations/linux_zswap.md | 131 ++++++++ .../debugfs.plugin/integrations/power_capping.md | 125 +++++++ .../integrations/system_memory_fragmentation.md | 129 ++++++++ collectors/diskspace.plugin/README.md | 56 +--- .../diskspace.plugin/integrations/disk_space.md | 133 ++++++++ .../ebpf.plugin/integrations/ebpf_cachestat.md | 168 ++++++++++ collectors/ebpf.plugin/integrations/ebpf_dcstat.md | 166 ++++++++++ collectors/ebpf.plugin/integrations/ebpf_disk.md | 130 ++++++++ .../integrations/ebpf_filedescriptor.md | 166 ++++++++++ .../ebpf.plugin/integrations/ebpf_filesystem.md | 156 +++++++++ .../ebpf.plugin/integrations/ebpf_hardirq.md | 130 ++++++++ .../ebpf.plugin/integrations/ebpf_mdflush.md | 125 +++++++ collectors/ebpf.plugin/integrations/ebpf_mount.md | 133 ++++++++ .../ebpf.plugin/integrations/ebpf_oomkill.md | 149 +++++++++ .../ebpf.plugin/integrations/ebpf_process.md | 104 ++++++ .../ebpf.plugin/integrations/ebpf_processes.md | 176 ++++++++++ collectors/ebpf.plugin/integrations/ebpf_shm.md | 174 ++++++++++ collectors/ebpf.plugin/integrations/ebpf_socket.md | 191 +++++++++++ .../ebpf.plugin/integrations/ebpf_softirq.md | 130 ++++++++ collectors/ebpf.plugin/integrations/ebpf_swap.md | 159 +++++++++ collectors/ebpf.plugin/integrations/ebpf_sync.md | 150 +++++++++ collectors/ebpf.plugin/integrations/ebpf_vfs.md | 201 ++++++++++++ .../freebsd.plugin/integrations/dev.cpu.0.freq.md | 104 ++++++ .../integrations/dev.cpu.temperature.md | 113 +++++++ collectors/freebsd.plugin/integrations/devstat.md | 148 +++++++++ .../freebsd.plugin/integrations/getifaddrs.md | 160 +++++++++ .../freebsd.plugin/integrations/getmntinfo.md | 124 +++++++ .../freebsd.plugin/integrations/hw.intrcnt.md | 114 +++++++ collectors/freebsd.plugin/integrations/ipfw.md | 119 +++++++ .../freebsd.plugin/integrations/kern.cp_time.md | 132 ++++++++ .../freebsd.plugin/integrations/kern.ipc.msq.md | 115 +++++++ .../freebsd.plugin/integrations/kern.ipc.sem.md | 120 +++++++ .../freebsd.plugin/integrations/kern.ipc.shm.md | 114 +++++++ .../integrations/net.inet.icmp.stats.md | 117 +++++++ .../integrations/net.inet.ip.stats.md | 119 +++++++ .../integrations/net.inet.tcp.states.md | 118 +++++++ .../integrations/net.inet.tcp.stats.md | 135 ++++++++ .../integrations/net.inet.udp.stats.md | 121 +++++++ .../integrations/net.inet6.icmp6.stats.md | 125 +++++++ .../integrations/net.inet6.ip6.stats.md | 119 +++++++ collectors/freebsd.plugin/integrations/net.isr.md | 133 ++++++++ .../freebsd.plugin/integrations/system.ram.md | 122 +++++++ collectors/freebsd.plugin/integrations/uptime.md | 113 +++++++ .../freebsd.plugin/integrations/vm.loadavg.md | 121 +++++++ .../integrations/vm.stats.sys.v_intr.md | 113 +++++++ .../integrations/vm.stats.sys.v_soft.md | 113 +++++++ .../integrations/vm.stats.sys.v_swtch.md | 114 +++++++ .../integrations/vm.stats.vm.v_pgfaults.md | 113 +++++++ .../integrations/vm.stats.vm.v_swappgs.md | 118 +++++++ .../freebsd.plugin/integrations/vm.swap_info.md | 118 +++++++ .../freebsd.plugin/integrations/vm.vmtotal.md | 122 +++++++ collectors/freebsd.plugin/integrations/zfs.md | 145 +++++++++ collectors/freeipmi.plugin/README.md | 288 +---------------- ...telligent_platform_management_interface_ipmi.md | 268 +++++++++++++++ collectors/idlejitter.plugin/README.md | 37 +-- .../integrations/idle_os_jitter.md | 112 +++++++ collectors/ioping.plugin/README.md | 81 +---- collectors/ioping.plugin/integrations/ioping.md | 126 ++++++++ collectors/macos.plugin/README.md | 17 +- collectors/macos.plugin/integrations/macos.md | 279 ++++++++++++++++ collectors/nfacct.plugin/README.md | 64 +--- collectors/nfacct.plugin/integrations/netfilter.md | 125 +++++++ collectors/perf.plugin/README.md | 88 +---- .../perf.plugin/integrations/cpu_performance.md | 185 +++++++++++ collectors/proc.plugin/integrations/amd_gpu.md | 103 ++++++ collectors/proc.plugin/integrations/btrfs.md | 130 ++++++++ collectors/proc.plugin/integrations/conntrack.md | 98 ++++++ .../proc.plugin/integrations/disk_statistics.md | 142 ++++++++ collectors/proc.plugin/integrations/entropy.md | 126 ++++++++ collectors/proc.plugin/integrations/infiniband.md | 92 ++++++ .../integrations/inter_process_communication.md | 113 +++++++ collectors/proc.plugin/integrations/interrupts.md | 134 ++++++++ .../proc.plugin/integrations/ip_virtual_server.md | 90 ++++++ .../integrations/ipv6_socket_statistics.md | 92 ++++++ .../integrations/kernel_same-page_merging.md | 96 ++++++ collectors/proc.plugin/integrations/md_raid.md | 118 +++++++ .../integrations/memory_modules_dimms.md | 139 ++++++++ .../proc.plugin/integrations/memory_statistics.md | 131 ++++++++ .../proc.plugin/integrations/memory_usage.md | 128 ++++++++ .../proc.plugin/integrations/network_interfaces.md | 132 ++++++++ .../proc.plugin/integrations/network_statistics.md | 155 +++++++++ collectors/proc.plugin/integrations/nfs_client.md | 92 ++++++ collectors/proc.plugin/integrations/nfs_server.md | 97 ++++++ .../integrations/non-uniform_memory_access.md | 104 ++++++ collectors/proc.plugin/integrations/page_types.md | 106 ++++++ .../proc.plugin/integrations/power_supply.md | 100 ++++++ .../integrations/pressure_stall_information.md | 122 +++++++ .../proc.plugin/integrations/sctp_statistics.md | 92 ++++++ .../proc.plugin/integrations/socket_statistics.md | 102 ++++++ .../proc.plugin/integrations/softirq_statistics.md | 126 ++++++++ .../proc.plugin/integrations/softnet_statistics.md | 128 ++++++++ collectors/proc.plugin/integrations/synproxy.md | 90 ++++++ .../integrations/system_load_average.md | 121 +++++++ .../proc.plugin/integrations/system_statistics.md | 162 ++++++++++ .../proc.plugin/integrations/system_uptime.md | 101 ++++++ .../integrations/wireless_network_interfaces.md | 93 ++++++ .../integrations/zfs_adaptive_replacement_cache.md | 118 +++++++ collectors/proc.plugin/integrations/zfs_pools.md | 98 ++++++ collectors/proc.plugin/integrations/zram.md | 99 ++++++ collectors/python.d.plugin/adaptec_raid/README.md | 104 +----- .../adaptec_raid/integrations/adaptecraid.md | 197 +++++++++++ collectors/python.d.plugin/alarms/README.md | 90 +----- .../alarms/integrations/netdata_agent_alarms.md | 200 ++++++++++++ collectors/python.d.plugin/am2320/README.md | 77 +---- .../python.d.plugin/am2320/integrations/am2320.md | 174 ++++++++++ collectors/python.d.plugin/beanstalk/README.md | 157 +-------- .../beanstalk/integrations/beanstalk.md | 212 ++++++++++++ collectors/python.d.plugin/bind_rndc/README.md | 103 +----- .../bind_rndc/integrations/isc_bind_rndc.md | 208 ++++++++++++ collectors/python.d.plugin/boinc/README.md | 65 +--- .../python.d.plugin/boinc/integrations/boinc.md | 197 +++++++++++ collectors/python.d.plugin/ceph/README.md | 72 +---- .../python.d.plugin/ceph/integrations/ceph.md | 187 +++++++++++ collectors/python.d.plugin/changefinder/README.md | 242 +------------- .../integrations/python.d_changefinder.md | 217 +++++++++++++ collectors/python.d.plugin/dovecot/README.md | 129 +------- .../dovecot/integrations/dovecot.md | 190 +++++++++++ collectors/python.d.plugin/example/README.md | 39 +-- .../example/integrations/example_collector.md | 168 ++++++++++ collectors/python.d.plugin/exim/README.md | 65 +--- .../python.d.plugin/exim/integrations/exim.md | 174 ++++++++++ collectors/python.d.plugin/fail2ban/README.md | 106 +----- .../fail2ban/integrations/fail2ban.md | 202 ++++++++++++ collectors/python.d.plugin/gearman/README.md | 74 +---- .../gearman/integrations/gearman.md | 203 ++++++++++++ collectors/python.d.plugin/go_expvar/README.md | 343 +------------------- .../integrations/go_applications_expvar.md | 328 +++++++++++++++++++ collectors/python.d.plugin/hddtemp/README.md | 62 +--- .../hddtemp/integrations/hdd_temperature.md | 211 ++++++++++++ collectors/python.d.plugin/hpssa/README.md | 107 +----- .../hpssa/integrations/hp_smart_storage_arrays.md | 198 ++++++++++++ collectors/python.d.plugin/icecast/README.md | 68 +--- .../icecast/integrations/icecast.md | 159 +++++++++ collectors/python.d.plugin/ipfs/README.md | 75 +---- .../python.d.plugin/ipfs/integrations/ipfs.md | 196 +++++++++++ collectors/python.d.plugin/litespeed/README.md | 96 +----- .../litespeed/integrations/litespeed.md | 163 ++++++++++ collectors/python.d.plugin/megacli/README.md | 110 +------ .../megacli/integrations/megacli.md | 213 ++++++++++++ collectors/python.d.plugin/memcached/README.md | 123 +------ .../memcached/integrations/memcached.md | 208 ++++++++++++ collectors/python.d.plugin/monit/README.md | 79 +---- .../python.d.plugin/monit/integrations/monit.md | 208 ++++++++++++ collectors/python.d.plugin/nsd/README.md | 92 +----- .../nsd/integrations/name_server_daemon.md | 193 +++++++++++ collectors/python.d.plugin/openldap/README.md | 103 +----- .../openldap/integrations/openldap.md | 208 ++++++++++++ collectors/python.d.plugin/oracledb/README.md | 116 +------ .../oracledb/integrations/oracle_db.md | 219 +++++++++++++ collectors/python.d.plugin/pandas/README.md | 97 +----- .../python.d.plugin/pandas/integrations/pandas.md | 360 +++++++++++++++++++++ collectors/python.d.plugin/postfix/README.md | 60 +--- .../postfix/integrations/postfix.md | 144 +++++++++ collectors/python.d.plugin/puppet/README.md | 91 +----- .../python.d.plugin/puppet/integrations/puppet.md | 209 ++++++++++++ collectors/python.d.plugin/rethinkdbs/README.md | 78 +---- .../rethinkdbs/integrations/rethinkdb.md | 183 +++++++++++ collectors/python.d.plugin/retroshare/README.md | 71 +--- .../retroshare/integrations/retroshare.md | 184 +++++++++++ collectors/python.d.plugin/riakkv/README.md | 150 +-------- .../python.d.plugin/riakkv/integrations/riakkv.md | 213 ++++++++++++ collectors/python.d.plugin/samba/README.md | 145 +-------- .../python.d.plugin/samba/integrations/samba.md | 214 ++++++++++++ collectors/python.d.plugin/sensors/README.md | 56 +--- .../integrations/linux_sensors_lm-sensors.md | 180 +++++++++++ collectors/python.d.plugin/smartd_log/README.md | 149 +-------- .../smartd_log/integrations/s.m.a.r.t..md | 217 +++++++++++++ collectors/python.d.plugin/spigotmc/README.md | 62 +--- .../spigotmc/integrations/spigotmc.md | 210 ++++++++++++ collectors/python.d.plugin/squid/README.md | 82 +---- .../python.d.plugin/squid/integrations/squid.md | 193 +++++++++++ collectors/python.d.plugin/tomcat/README.md | 77 +---- .../python.d.plugin/tomcat/integrations/tomcat.md | 196 +++++++++++ collectors/python.d.plugin/tor/README.md | 90 +----- collectors/python.d.plugin/tor/integrations/tor.md | 190 +++++++++++ collectors/python.d.plugin/uwsgi/README.md | 76 +---- .../python.d.plugin/uwsgi/integrations/uwsgi.md | 212 ++++++++++++ collectors/python.d.plugin/varnish/README.md | 89 +---- .../varnish/integrations/varnish.md | 206 ++++++++++++ collectors/python.d.plugin/w1sensor/README.md | 51 +-- .../w1sensor/integrations/1-wire_sensors.md | 160 +++++++++ collectors/python.d.plugin/zscores/README.md | 159 +-------- .../zscores/integrations/python.d_zscores.md | 192 +++++++++++ collectors/slabinfo.plugin/README.md | 37 +-- .../linux_kernel_slab_allocator_statistics.md | 124 +++++++ collectors/tc.plugin/README.md | 210 +----------- .../tc.plugin/integrations/tc_qos_classes.md | 134 ++++++++ collectors/timex.plugin/README.md | 36 +-- collectors/timex.plugin/integrations/timex.md | 136 ++++++++ collectors/xenstat.plugin/README.md | 58 +--- .../xenstat.plugin/integrations/xen-xcp-ng.md | 169 ++++++++++ exporting/aws_kinesis/README.md | 62 +--- exporting/aws_kinesis/integrations/aws_kinesis.md | 166 ++++++++++ exporting/graphite/integrations/blueflood.md | 170 ++++++++++ exporting/graphite/integrations/graphite.md | 170 ++++++++++ exporting/graphite/integrations/influxdb.md | 170 ++++++++++ exporting/graphite/integrations/kairosdb.md | 170 ++++++++++ exporting/json/README.md | 39 +-- exporting/json/integrations/json.md | 145 +++++++++ exporting/mongodb/README.md | 42 +-- exporting/mongodb/integrations/mongodb.md | 143 ++++++++ exporting/opentsdb/README.md | 40 +-- exporting/opentsdb/integrations/opentsdb.md | 173 ++++++++++ exporting/prometheus/integrations/appoptics.md | 156 +++++++++ .../prometheus/integrations/azure_data_explorer.md | 156 +++++++++ .../prometheus/integrations/azure_event_hub.md | 156 +++++++++ exporting/prometheus/integrations/chronix.md | 156 +++++++++ exporting/prometheus/integrations/cortex.md | 156 +++++++++ exporting/prometheus/integrations/cratedb.md | 156 +++++++++ exporting/prometheus/integrations/elasticsearch.md | 156 +++++++++ exporting/prometheus/integrations/gnocchi.md | 156 +++++++++ .../prometheus/integrations/google_bigquery.md | 156 +++++++++ exporting/prometheus/integrations/irondb.md | 156 +++++++++ exporting/prometheus/integrations/kafka.md | 156 +++++++++ exporting/prometheus/integrations/m3db.md | 156 +++++++++ exporting/prometheus/integrations/metricfire.md | 156 +++++++++ exporting/prometheus/integrations/new_relic.md | 156 +++++++++ exporting/prometheus/integrations/postgresql.md | 156 +++++++++ .../integrations/prometheus_remote_write.md | 156 +++++++++ exporting/prometheus/integrations/quasardb.md | 156 +++++++++ .../prometheus/integrations/splunk_signalfx.md | 156 +++++++++ exporting/prometheus/integrations/thanos.md | 156 +++++++++ exporting/prometheus/integrations/tikv.md | 156 +++++++++ exporting/prometheus/integrations/timescaledb.md | 156 +++++++++ .../prometheus/integrations/victoriametrics.md | 156 +++++++++ exporting/prometheus/integrations/vmware_aria.md | 156 +++++++++ exporting/prometheus/integrations/wavefront.md | 156 +++++++++ exporting/pubsub/README.md | 41 +-- .../pubsub/integrations/google_cloud_pub_sub.md | 143 ++++++++ health/notifications/alerta/README.md | 126 +++++--- health/notifications/awssns/README.md | 229 +++++++------ health/notifications/custom/README.md | 268 ++++++++------- health/notifications/discord/README.md | 112 ++++--- health/notifications/dynatrace/README.md | 132 +++++--- health/notifications/email/README.md | 141 ++++---- health/notifications/flock/README.md | 109 +++++-- health/notifications/gotify/README.md | 99 ++++-- health/notifications/irc/README.md | 142 +++++--- health/notifications/kavenegar/README.md | 113 +++++-- health/notifications/matrix/README.md | 124 ++++--- health/notifications/messagebird/README.md | 110 +++++-- health/notifications/msteams/README.md | 115 +++++-- health/notifications/ntfy/README.md | 156 +++++---- health/notifications/opsgenie/README.md | 100 ++++-- health/notifications/pagerduty/README.md | 116 ++++--- health/notifications/prowl/README.md | 119 ++++--- health/notifications/pushbullet/README.md | 113 ++++--- health/notifications/pushover/README.md | 110 +++++-- health/notifications/rocketchat/README.md | 112 +++++-- health/notifications/slack/README.md | 105 ++++-- health/notifications/smstools3/README.md | 125 ++++--- health/notifications/syslog/README.md | 125 ++++--- health/notifications/telegram/README.md | 113 ++++--- health/notifications/twilio/README.md | 112 ++++--- .../cloud-notifications/integrations/discord.md | 44 +++ .../cloud-notifications/integrations/mattermost.md | 54 ++++ .../cloud-notifications/integrations/opsgenie.md | 46 +++ .../cloud-notifications/integrations/pagerduty.md | 45 +++ .../cloud-notifications/integrations/rocketchat.md | 54 ++++ .../cloud-notifications/integrations/slack.md | 52 +++ .../cloud-notifications/integrations/webhook.md | 241 ++++++++++++++ 286 files changed, 31680 insertions(+), 6954 deletions(-) create mode 100644 collectors/apps.plugin/integrations/applications.md create mode 100644 collectors/apps.plugin/integrations/user_groups.md create mode 100644 collectors/apps.plugin/integrations/users.md create mode 100644 collectors/cgroups.plugin/integrations/containers.md create mode 100644 collectors/cgroups.plugin/integrations/kubernetes_containers.md create mode 100644 collectors/cgroups.plugin/integrations/libvirt_containers.md create mode 100644 collectors/cgroups.plugin/integrations/lxc_containers.md create mode 100644 collectors/cgroups.plugin/integrations/ovirt_containers.md create mode 100644 collectors/cgroups.plugin/integrations/proxmox_containers.md create mode 100644 collectors/cgroups.plugin/integrations/systemd_services.md create mode 100644 collectors/cgroups.plugin/integrations/virtual_machines.md mode change 100644 => 120000 collectors/charts.d.plugin/ap/README.md create mode 100644 collectors/charts.d.plugin/ap/integrations/access_points.md mode change 100644 => 120000 collectors/charts.d.plugin/apcupsd/README.md create mode 100644 collectors/charts.d.plugin/apcupsd/integrations/apc_ups.md mode change 100644 => 120000 collectors/charts.d.plugin/libreswan/README.md create mode 100644 collectors/charts.d.plugin/libreswan/integrations/libreswan.md mode change 100644 => 120000 collectors/charts.d.plugin/nut/README.md create mode 100644 collectors/charts.d.plugin/nut/integrations/network_ups_tools_nut.md mode change 100644 => 120000 collectors/charts.d.plugin/opensips/README.md create mode 100644 collectors/charts.d.plugin/opensips/integrations/opensips.md mode change 100644 => 120000 collectors/charts.d.plugin/sensors/README.md create mode 100644 collectors/charts.d.plugin/sensors/integrations/linux_sensors_sysfs.md mode change 100644 => 120000 collectors/cups.plugin/README.md create mode 100644 collectors/cups.plugin/integrations/cups.md create mode 100644 collectors/debugfs.plugin/integrations/linux_zswap.md create mode 100644 collectors/debugfs.plugin/integrations/power_capping.md create mode 100644 collectors/debugfs.plugin/integrations/system_memory_fragmentation.md mode change 100644 => 120000 collectors/diskspace.plugin/README.md create mode 100644 collectors/diskspace.plugin/integrations/disk_space.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_cachestat.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_dcstat.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_disk.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_filedescriptor.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_filesystem.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_hardirq.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_mdflush.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_mount.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_oomkill.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_process.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_processes.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_shm.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_socket.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_softirq.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_swap.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_sync.md create mode 100644 collectors/ebpf.plugin/integrations/ebpf_vfs.md create mode 100644 collectors/freebsd.plugin/integrations/dev.cpu.0.freq.md create mode 100644 collectors/freebsd.plugin/integrations/dev.cpu.temperature.md create mode 100644 collectors/freebsd.plugin/integrations/devstat.md create mode 100644 collectors/freebsd.plugin/integrations/getifaddrs.md create mode 100644 collectors/freebsd.plugin/integrations/getmntinfo.md create mode 100644 collectors/freebsd.plugin/integrations/hw.intrcnt.md create mode 100644 collectors/freebsd.plugin/integrations/ipfw.md create mode 100644 collectors/freebsd.plugin/integrations/kern.cp_time.md create mode 100644 collectors/freebsd.plugin/integrations/kern.ipc.msq.md create mode 100644 collectors/freebsd.plugin/integrations/kern.ipc.sem.md create mode 100644 collectors/freebsd.plugin/integrations/kern.ipc.shm.md create mode 100644 collectors/freebsd.plugin/integrations/net.inet.icmp.stats.md create mode 100644 collectors/freebsd.plugin/integrations/net.inet.ip.stats.md create mode 100644 collectors/freebsd.plugin/integrations/net.inet.tcp.states.md create mode 100644 collectors/freebsd.plugin/integrations/net.inet.tcp.stats.md create mode 100644 collectors/freebsd.plugin/integrations/net.inet.udp.stats.md create mode 100644 collectors/freebsd.plugin/integrations/net.inet6.icmp6.stats.md create mode 100644 collectors/freebsd.plugin/integrations/net.inet6.ip6.stats.md create mode 100644 collectors/freebsd.plugin/integrations/net.isr.md create mode 100644 collectors/freebsd.plugin/integrations/system.ram.md create mode 100644 collectors/freebsd.plugin/integrations/uptime.md create mode 100644 collectors/freebsd.plugin/integrations/vm.loadavg.md create mode 100644 collectors/freebsd.plugin/integrations/vm.stats.sys.v_intr.md create mode 100644 collectors/freebsd.plugin/integrations/vm.stats.sys.v_soft.md create mode 100644 collectors/freebsd.plugin/integrations/vm.stats.sys.v_swtch.md create mode 100644 collectors/freebsd.plugin/integrations/vm.stats.vm.v_pgfaults.md create mode 100644 collectors/freebsd.plugin/integrations/vm.stats.vm.v_swappgs.md create mode 100644 collectors/freebsd.plugin/integrations/vm.swap_info.md create mode 100644 collectors/freebsd.plugin/integrations/vm.vmtotal.md create mode 100644 collectors/freebsd.plugin/integrations/zfs.md mode change 100644 => 120000 collectors/freeipmi.plugin/README.md create mode 100644 collectors/freeipmi.plugin/integrations/intelligent_platform_management_interface_ipmi.md mode change 100644 => 120000 collectors/idlejitter.plugin/README.md create mode 100644 collectors/idlejitter.plugin/integrations/idle_os_jitter.md mode change 100644 => 120000 collectors/ioping.plugin/README.md create mode 100644 collectors/ioping.plugin/integrations/ioping.md mode change 100644 => 120000 collectors/macos.plugin/README.md create mode 100644 collectors/macos.plugin/integrations/macos.md mode change 100644 => 120000 collectors/nfacct.plugin/README.md create mode 100644 collectors/nfacct.plugin/integrations/netfilter.md mode change 100644 => 120000 collectors/perf.plugin/README.md create mode 100644 collectors/perf.plugin/integrations/cpu_performance.md create mode 100644 collectors/proc.plugin/integrations/amd_gpu.md create mode 100644 collectors/proc.plugin/integrations/btrfs.md create mode 100644 collectors/proc.plugin/integrations/conntrack.md create mode 100644 collectors/proc.plugin/integrations/disk_statistics.md create mode 100644 collectors/proc.plugin/integrations/entropy.md create mode 100644 collectors/proc.plugin/integrations/infiniband.md create mode 100644 collectors/proc.plugin/integrations/inter_process_communication.md create mode 100644 collectors/proc.plugin/integrations/interrupts.md create mode 100644 collectors/proc.plugin/integrations/ip_virtual_server.md create mode 100644 collectors/proc.plugin/integrations/ipv6_socket_statistics.md create mode 100644 collectors/proc.plugin/integrations/kernel_same-page_merging.md create mode 100644 collectors/proc.plugin/integrations/md_raid.md create mode 100644 collectors/proc.plugin/integrations/memory_modules_dimms.md create mode 100644 collectors/proc.plugin/integrations/memory_statistics.md create mode 100644 collectors/proc.plugin/integrations/memory_usage.md create mode 100644 collectors/proc.plugin/integrations/network_interfaces.md create mode 100644 collectors/proc.plugin/integrations/network_statistics.md create mode 100644 collectors/proc.plugin/integrations/nfs_client.md create mode 100644 collectors/proc.plugin/integrations/nfs_server.md create mode 100644 collectors/proc.plugin/integrations/non-uniform_memory_access.md create mode 100644 collectors/proc.plugin/integrations/page_types.md create mode 100644 collectors/proc.plugin/integrations/power_supply.md create mode 100644 collectors/proc.plugin/integrations/pressure_stall_information.md create mode 100644 collectors/proc.plugin/integrations/sctp_statistics.md create mode 100644 collectors/proc.plugin/integrations/socket_statistics.md create mode 100644 collectors/proc.plugin/integrations/softirq_statistics.md create mode 100644 collectors/proc.plugin/integrations/softnet_statistics.md create mode 100644 collectors/proc.plugin/integrations/synproxy.md create mode 100644 collectors/proc.plugin/integrations/system_load_average.md create mode 100644 collectors/proc.plugin/integrations/system_statistics.md create mode 100644 collectors/proc.plugin/integrations/system_uptime.md create mode 100644 collectors/proc.plugin/integrations/wireless_network_interfaces.md create mode 100644 collectors/proc.plugin/integrations/zfs_adaptive_replacement_cache.md create mode 100644 collectors/proc.plugin/integrations/zfs_pools.md create mode 100644 collectors/proc.plugin/integrations/zram.md mode change 100644 => 120000 collectors/python.d.plugin/adaptec_raid/README.md create mode 100644 collectors/python.d.plugin/adaptec_raid/integrations/adaptecraid.md mode change 100644 => 120000 collectors/python.d.plugin/alarms/README.md create mode 100644 collectors/python.d.plugin/alarms/integrations/netdata_agent_alarms.md mode change 100644 => 120000 collectors/python.d.plugin/am2320/README.md create mode 100644 collectors/python.d.plugin/am2320/integrations/am2320.md mode change 100644 => 120000 collectors/python.d.plugin/beanstalk/README.md create mode 100644 collectors/python.d.plugin/beanstalk/integrations/beanstalk.md mode change 100644 => 120000 collectors/python.d.plugin/bind_rndc/README.md create mode 100644 collectors/python.d.plugin/bind_rndc/integrations/isc_bind_rndc.md mode change 100644 => 120000 collectors/python.d.plugin/boinc/README.md create mode 100644 collectors/python.d.plugin/boinc/integrations/boinc.md mode change 100644 => 120000 collectors/python.d.plugin/ceph/README.md create mode 100644 collectors/python.d.plugin/ceph/integrations/ceph.md mode change 100644 => 120000 collectors/python.d.plugin/changefinder/README.md create mode 100644 collectors/python.d.plugin/changefinder/integrations/python.d_changefinder.md mode change 100644 => 120000 collectors/python.d.plugin/dovecot/README.md create mode 100644 collectors/python.d.plugin/dovecot/integrations/dovecot.md mode change 100644 => 120000 collectors/python.d.plugin/example/README.md create mode 100644 collectors/python.d.plugin/example/integrations/example_collector.md mode change 100644 => 120000 collectors/python.d.plugin/exim/README.md create mode 100644 collectors/python.d.plugin/exim/integrations/exim.md mode change 100644 => 120000 collectors/python.d.plugin/fail2ban/README.md create mode 100644 collectors/python.d.plugin/fail2ban/integrations/fail2ban.md mode change 100644 => 120000 collectors/python.d.plugin/gearman/README.md create mode 100644 collectors/python.d.plugin/gearman/integrations/gearman.md mode change 100644 => 120000 collectors/python.d.plugin/go_expvar/README.md create mode 100644 collectors/python.d.plugin/go_expvar/integrations/go_applications_expvar.md mode change 100644 => 120000 collectors/python.d.plugin/hddtemp/README.md create mode 100644 collectors/python.d.plugin/hddtemp/integrations/hdd_temperature.md mode change 100644 => 120000 collectors/python.d.plugin/hpssa/README.md create mode 100644 collectors/python.d.plugin/hpssa/integrations/hp_smart_storage_arrays.md mode change 100644 => 120000 collectors/python.d.plugin/icecast/README.md create mode 100644 collectors/python.d.plugin/icecast/integrations/icecast.md mode change 100644 => 120000 collectors/python.d.plugin/ipfs/README.md create mode 100644 collectors/python.d.plugin/ipfs/integrations/ipfs.md mode change 100644 => 120000 collectors/python.d.plugin/litespeed/README.md create mode 100644 collectors/python.d.plugin/litespeed/integrations/litespeed.md mode change 100644 => 120000 collectors/python.d.plugin/megacli/README.md create mode 100644 collectors/python.d.plugin/megacli/integrations/megacli.md mode change 100644 => 120000 collectors/python.d.plugin/memcached/README.md create mode 100644 collectors/python.d.plugin/memcached/integrations/memcached.md mode change 100644 => 120000 collectors/python.d.plugin/monit/README.md create mode 100644 collectors/python.d.plugin/monit/integrations/monit.md mode change 100644 => 120000 collectors/python.d.plugin/nsd/README.md create mode 100644 collectors/python.d.plugin/nsd/integrations/name_server_daemon.md mode change 100644 => 120000 collectors/python.d.plugin/openldap/README.md create mode 100644 collectors/python.d.plugin/openldap/integrations/openldap.md mode change 100644 => 120000 collectors/python.d.plugin/oracledb/README.md create mode 100644 collectors/python.d.plugin/oracledb/integrations/oracle_db.md mode change 100644 => 120000 collectors/python.d.plugin/pandas/README.md create mode 100644 collectors/python.d.plugin/pandas/integrations/pandas.md mode change 100644 => 120000 collectors/python.d.plugin/postfix/README.md create mode 100644 collectors/python.d.plugin/postfix/integrations/postfix.md mode change 100644 => 120000 collectors/python.d.plugin/puppet/README.md create mode 100644 collectors/python.d.plugin/puppet/integrations/puppet.md mode change 100644 => 120000 collectors/python.d.plugin/rethinkdbs/README.md create mode 100644 collectors/python.d.plugin/rethinkdbs/integrations/rethinkdb.md mode change 100644 => 120000 collectors/python.d.plugin/retroshare/README.md create mode 100644 collectors/python.d.plugin/retroshare/integrations/retroshare.md mode change 100644 => 120000 collectors/python.d.plugin/riakkv/README.md create mode 100644 collectors/python.d.plugin/riakkv/integrations/riakkv.md mode change 100644 => 120000 collectors/python.d.plugin/samba/README.md create mode 100644 collectors/python.d.plugin/samba/integrations/samba.md mode change 100644 => 120000 collectors/python.d.plugin/sensors/README.md create mode 100644 collectors/python.d.plugin/sensors/integrations/linux_sensors_lm-sensors.md mode change 100644 => 120000 collectors/python.d.plugin/smartd_log/README.md create mode 100644 collectors/python.d.plugin/smartd_log/integrations/s.m.a.r.t..md mode change 100644 => 120000 collectors/python.d.plugin/spigotmc/README.md create mode 100644 collectors/python.d.plugin/spigotmc/integrations/spigotmc.md mode change 100644 => 120000 collectors/python.d.plugin/squid/README.md create mode 100644 collectors/python.d.plugin/squid/integrations/squid.md mode change 100644 => 120000 collectors/python.d.plugin/tomcat/README.md create mode 100644 collectors/python.d.plugin/tomcat/integrations/tomcat.md mode change 100644 => 120000 collectors/python.d.plugin/tor/README.md create mode 100644 collectors/python.d.plugin/tor/integrations/tor.md mode change 100644 => 120000 collectors/python.d.plugin/uwsgi/README.md create mode 100644 collectors/python.d.plugin/uwsgi/integrations/uwsgi.md mode change 100644 => 120000 collectors/python.d.plugin/varnish/README.md create mode 100644 collectors/python.d.plugin/varnish/integrations/varnish.md mode change 100644 => 120000 collectors/python.d.plugin/w1sensor/README.md create mode 100644 collectors/python.d.plugin/w1sensor/integrations/1-wire_sensors.md mode change 100644 => 120000 collectors/python.d.plugin/zscores/README.md create mode 100644 collectors/python.d.plugin/zscores/integrations/python.d_zscores.md mode change 100644 => 120000 collectors/slabinfo.plugin/README.md create mode 100644 collectors/slabinfo.plugin/integrations/linux_kernel_slab_allocator_statistics.md mode change 100644 => 120000 collectors/tc.plugin/README.md create mode 100644 collectors/tc.plugin/integrations/tc_qos_classes.md mode change 100644 => 120000 collectors/timex.plugin/README.md create mode 100644 collectors/timex.plugin/integrations/timex.md mode change 100644 => 120000 collectors/xenstat.plugin/README.md create mode 100644 collectors/xenstat.plugin/integrations/xen-xcp-ng.md mode change 100644 => 120000 exporting/aws_kinesis/README.md create mode 100644 exporting/aws_kinesis/integrations/aws_kinesis.md create mode 100644 exporting/graphite/integrations/blueflood.md create mode 100644 exporting/graphite/integrations/graphite.md create mode 100644 exporting/graphite/integrations/influxdb.md create mode 100644 exporting/graphite/integrations/kairosdb.md mode change 100644 => 120000 exporting/json/README.md create mode 100644 exporting/json/integrations/json.md mode change 100644 => 120000 exporting/mongodb/README.md create mode 100644 exporting/mongodb/integrations/mongodb.md mode change 100644 => 120000 exporting/opentsdb/README.md create mode 100644 exporting/opentsdb/integrations/opentsdb.md create mode 100644 exporting/prometheus/integrations/appoptics.md create mode 100644 exporting/prometheus/integrations/azure_data_explorer.md create mode 100644 exporting/prometheus/integrations/azure_event_hub.md create mode 100644 exporting/prometheus/integrations/chronix.md create mode 100644 exporting/prometheus/integrations/cortex.md create mode 100644 exporting/prometheus/integrations/cratedb.md create mode 100644 exporting/prometheus/integrations/elasticsearch.md create mode 100644 exporting/prometheus/integrations/gnocchi.md create mode 100644 exporting/prometheus/integrations/google_bigquery.md create mode 100644 exporting/prometheus/integrations/irondb.md create mode 100644 exporting/prometheus/integrations/kafka.md create mode 100644 exporting/prometheus/integrations/m3db.md create mode 100644 exporting/prometheus/integrations/metricfire.md create mode 100644 exporting/prometheus/integrations/new_relic.md create mode 100644 exporting/prometheus/integrations/postgresql.md create mode 100644 exporting/prometheus/integrations/prometheus_remote_write.md create mode 100644 exporting/prometheus/integrations/quasardb.md create mode 100644 exporting/prometheus/integrations/splunk_signalfx.md create mode 100644 exporting/prometheus/integrations/thanos.md create mode 100644 exporting/prometheus/integrations/tikv.md create mode 100644 exporting/prometheus/integrations/timescaledb.md create mode 100644 exporting/prometheus/integrations/victoriametrics.md create mode 100644 exporting/prometheus/integrations/vmware_aria.md create mode 100644 exporting/prometheus/integrations/wavefront.md mode change 100644 => 120000 exporting/pubsub/README.md create mode 100644 exporting/pubsub/integrations/google_cloud_pub_sub.md create mode 100644 integrations/cloud-notifications/integrations/discord.md create mode 100644 integrations/cloud-notifications/integrations/mattermost.md create mode 100644 integrations/cloud-notifications/integrations/opsgenie.md create mode 100644 integrations/cloud-notifications/integrations/pagerduty.md create mode 100644 integrations/cloud-notifications/integrations/rocketchat.md create mode 100644 integrations/cloud-notifications/integrations/slack.md create mode 100644 integrations/cloud-notifications/integrations/webhook.md diff --git a/collectors/apps.plugin/integrations/applications.md b/collectors/apps.plugin/integrations/applications.md new file mode 100644 index 0000000000..68c34d49f1 --- /dev/null +++ b/collectors/apps.plugin/integrations/applications.md @@ -0,0 +1,112 @@ + + +# Applications + +Plugin: apps.plugin +Module: apps + +## Overview + +Monitor Applications for optimal software performance and resource usage. + + + +This collector is supported on all platforms. + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +This integration doesn't support auto-detection. + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per Applications instance + + + +This scope has no labels. + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| apps.cpu | a dimension per app group | percentage | +| apps.cpu_user | a dimension per app group | percentage | +| apps.cpu_system | a dimension per app group | percentage | +| apps.cpu_guest | a dimension per app group | percentage | +| apps.mem | a dimension per app group | MiB | +| apps.rss | a dimension per app group | MiB | +| apps.vmem | a dimension per app group | MiB | +| apps.swap | a dimension per app group | MiB | +| apps.major_faults | a dimension per app group | page faults/s | +| apps.minor_faults | a dimension per app group | page faults/s | +| apps.preads | a dimension per app group | KiB/s | +| apps.pwrites | a dimension per app group | KiB/s | +| apps.lreads | a dimension per app group | KiB/s | +| apps.lwrites | a dimension per app group | KiB/s | +| apps.threads | a dimension per app group | threads | +| apps.processes | a dimension per app group | processes | +| apps.voluntary_ctxt_switches | a dimension per app group | processes | +| apps.involuntary_ctxt_switches | a dimension per app group | processes | +| apps.uptime | a dimension per app group | seconds | +| apps.uptime_min | a dimension per app group | seconds | +| apps.uptime_avg | a dimension per app group | seconds | +| apps.uptime_max | a dimension per app group | seconds | +| apps.files | a dimension per app group | open files | +| apps.sockets | a dimension per app group | open sockets | +| apps.pipes | a dimension per app group | open pipes | + + + +## Alerts + +There are no alerts configured by default for this integration. + + +## Setup + +### Prerequisites + +No action required. + +### Configuration + +#### File + +There is no configuration file. +#### Options + + + +There are no configuration options. + +#### Examples +There are no configuration examples. + + diff --git a/collectors/apps.plugin/integrations/user_groups.md b/collectors/apps.plugin/integrations/user_groups.md new file mode 100644 index 0000000000..2dd0e4fdf3 --- /dev/null +++ b/collectors/apps.plugin/integrations/user_groups.md @@ -0,0 +1,112 @@ + + +# User Groups + +Plugin: apps.plugin +Module: groups + +## Overview + +This integration monitors resource utilization on a user groups context. + + + +This collector is supported on all platforms. + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +This integration doesn't support auto-detection. + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per User Groups instance + + + +This scope has no labels. + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| groups.cpu | a dimension per user group | percentage | +| groups.cpu_user | a dimension per user group | percentage | +| groups.cpu_system | a dimension per user group | percentage | +| groups.cpu_guest | a dimension per user group | percentage | +| groups.mem | a dimension per user group | MiB | +| groups.rss | a dimension per user group | MiB | +| groups.vmem | a dimension per user group | MiB | +| groups.swap | a dimension per user group | MiB | +| groups.major_faults | a dimension per user group | page faults/s | +| groups.minor_faults | a dimension per user group | page faults/s | +| groups.preads | a dimension per user group | KiB/s | +| groups.pwrites | a dimension per user group | KiB/s | +| groups.lreads | a dimension per user group | KiB/s | +| groups.lwrites | a dimension per user group | KiB/s | +| groups.threads | a dimension per user group | threads | +| groups.processes | a dimension per user group | processes | +| groups.voluntary_ctxt_switches | a dimension per app group | processes | +| groups.involuntary_ctxt_switches | a dimension per app group | processes | +| groups.uptime | a dimension per user group | seconds | +| groups.uptime_min | a dimension per user group | seconds | +| groups.uptime_avg | a dimension per user group | seconds | +| groups.uptime_max | a dimension per user group | seconds | +| groups.files | a dimension per user group | open files | +| groups.sockets | a dimension per user group | open sockets | +| groups.pipes | a dimension per user group | open pipes | + + + +## Alerts + +There are no alerts configured by default for this integration. + + +## Setup + +### Prerequisites + +No action required. + +### Configuration + +#### File + +There is no configuration file. +#### Options + + + +There are no configuration options. + +#### Examples +There are no configuration examples. + + diff --git a/collectors/apps.plugin/integrations/users.md b/collectors/apps.plugin/integrations/users.md new file mode 100644 index 0000000000..5a5ec83c3c --- /dev/null +++ b/collectors/apps.plugin/integrations/users.md @@ -0,0 +1,112 @@ + + +# Users + +Plugin: apps.plugin +Module: users + +## Overview + +This integration monitors resource utilization on a user context. + + + +This collector is supported on all platforms. + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +This integration doesn't support auto-detection. + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per Users instance + + + +This scope has no labels. + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| users.cpu | a dimension per user | percentage | +| users.cpu_user | a dimension per user | percentage | +| users.cpu_system | a dimension per user | percentage | +| users.cpu_guest | a dimension per user | percentage | +| users.mem | a dimension per user | MiB | +| users.rss | a dimension per user | MiB | +| users.vmem | a dimension per user | MiB | +| users.swap | a dimension per user | MiB | +| users.major_faults | a dimension per user | page faults/s | +| users.minor_faults | a dimension per user | page faults/s | +| users.preads | a dimension per user | KiB/s | +| users.pwrites | a dimension per user | KiB/s | +| users.lreads | a dimension per user | KiB/s | +| users.lwrites | a dimension per user | KiB/s | +| users.threads | a dimension per user | threads | +| users.processes | a dimension per user | processes | +| users.voluntary_ctxt_switches | a dimension per app group | processes | +| users.involuntary_ctxt_switches | a dimension per app group | processes | +| users.uptime | a dimension per user | seconds | +| users.uptime_min | a dimension per user | seconds | +| users.uptime_avg | a dimension per user | seconds | +| users.uptime_max | a dimension per user | seconds | +| users.files | a dimension per user | open files | +| users.sockets | a dimension per user | open sockets | +| users.pipes | a dimension per user | open pipes | + + + +## Alerts + +There are no alerts configured by default for this integration. + + +## Setup + +### Prerequisites + +No action required. + +### Configuration + +#### File + +There is no configuration file. +#### Options + + + +There are no configuration options. + +#### Examples +There are no configuration examples. + + diff --git a/collectors/cgroups.plugin/integrations/containers.md b/collectors/cgroups.plugin/integrations/containers.md new file mode 100644 index 0000000000..43116fd7f5 --- /dev/null +++ b/collectors/cgroups.plugin/integrations/containers.md @@ -0,0 +1,160 @@ + + +# Containers + +Plugin: cgroups.plugin +Module: /sys/fs/cgroup + +## Overview + +Monitor Containers for performance, resource usage, and health status. + + + +This collector is supported on all platforms. + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +This integration doesn't support auto-detection. + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per cgroup + + + +Labels: + +| Label | Description | +|:-----------|:----------------| +| container_name | TBD | +| image | TBD | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| cgroup.cpu_limit | used | percentage | +| cgroup.cpu | user, system | percentage | +| cgroup.cpu_per_core | a dimension per core | percentage | +| cgroup.throttled | throttled | percentage | +| cgroup.throttled_duration | duration | ms | +| cgroup.cpu_shares | shares | shares | +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB | +| cgroup.writeback | dirty, writeback | MiB | +| cgroup.mem_activity | in, out | MiB/s | +| cgroup.pgfaults | pgfault, swap | MiB/s | +| cgroup.mem_usage | ram, swap | MiB | +| cgroup.mem_usage_limit | available, used | MiB | +| cgroup.mem_utilization | utilization | percentage | +| cgroup.mem_failcnt | failures | count | +| cgroup.io | read, write | KiB/s | +| cgroup.serviced_ops | read, write | operations/s | +| cgroup.throttle_io | read, write | KiB/s | +| cgroup.throttle_serviced_ops | read, write | operations/s | +| cgroup.queued_ops | read, write | operations | +| cgroup.merged_ops | read, write | operations/s | +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage | +| cgroup.cpu_some_pressure_stall_time | time | ms | +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage | +| cgroup.cpu_full_pressure_stall_time | time | ms | +| cgroup.memory_some_pressure | some10, some60, some300 | percentage | +| cgroup.memory_some_pressure_stall_time | time | ms | +| cgroup.memory_full_pressure | some10, some60, some300 | percentage | +| cgroup.memory_full_pressure_stall_time | time | ms | +| cgroup.io_some_pressure | some10, some60, some300 | percentage | +| cgroup.io_some_pressure_stall_time | time | ms | +| cgroup.io_full_pressure | some10, some60, some300 | percentage | +| cgroup.io_full_pressure_stall_time | time | ms | + +### Per cgroup network device + + + +Labels: + +| Label | Description | +|:-----------|:----------------| +| container_name | TBD | +| image | TBD | +| device | TBD | +| interface_type | TBD | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| cgroup.net_net | received, sent | kilobits/s | +| cgroup.net_packets | received, sent, multicast | pps | +| cgroup.net_errors | inbound, outbound | errors/s | +| cgroup.net_drops | inbound, outbound | errors/s | +| cgroup.net_fifo | receive, transmit | errors/s | +| cgroup.net_compressed | receive, sent | pps | +| cgroup.net_events | frames, collisions, carrier | events/s | +| cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state | +| cgroup.net_carrier | up, down | state | +| cgroup.net_mtu | mtu | octets | + + + +## Alerts + + +The following alerts are available: + +| Alert name | On metric | Description | +|:------------|:----------|:------------| +| [ cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes | +| [ cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | cgroup.mem_usage | cgroup memory utilization | +| [ cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute | +| [ cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute | + + +## Setup + +### Prerequisites + +No action required. + +### Configuration + +#### File + +There is no configuration file. +#### Options + + + +There are no configuration options. + +#### Examples +There are no configuration examples. + + diff --git a/collectors/cgroups.plugin/integrations/kubernetes_containers.md b/collectors/cgroups.plugin/integrations/kubernetes_containers.md new file mode 100644 index 0000000000..2b9efef057 --- /dev/null +++ b/collectors/cgroups.plugin/integrations/kubernetes_containers.md @@ -0,0 +1,178 @@ + + +# Kubernetes Containers + +Plugin: cgroups.plugin +Module: /sys/fs/cgroup + +## Overview + +Monitor Containers for performance, resource usage, and health status. + + + +This collector is supported on all platforms. + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +This integration doesn't support auto-detection. + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per k8s cgroup + + + +Labels: + +| Label | Description | +|:-----------|:----------------| +| k8s_namespace | TBD | +| k8s_pod_name | TBD | +| k8s_pod_uid | TBD | +| k8s_controller_kind | TBD | +| k8s_controller_name | TBD | +| k8s_node_name | TBD | +| k8s_container_name | TBD | +| k8s_container_id | TBD | +| k8s_kind | TBD | +| k8s_qos_class | TBD | +| k8s_cluster_id | TBD | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| k8s.cgroup.cpu_limit | used | percentage | +| k8s.cgroup.cpu | user, system | percentage | +| k8s.cgroup.cpu_per_core | a dimension per core | percentage | +| k8s.cgroup.throttled | throttled | percentage | +| k8s.cgroup.throttled_duration | duration | ms | +| k8s.cgroup.cpu_shares | shares | shares | +| k8s.cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB | +| k8s.cgroup.writeback | dirty, writeback | MiB | +| k8s.cgroup.mem_activity | in, out | MiB/s | +| k8s.cgroup.pgfaults | pgfault, swap | MiB/s | +| k8s.cgroup.mem_usage | ram, swap | MiB | +| k8s.cgroup.mem_usage_limit | available, used | MiB | +| k8s.cgroup.mem_utilization | utilization | percentage | +| k8s.cgroup.mem_failcnt | failures | count | +| k8s.cgroup.io | read, write | KiB/s | +| k8s.cgroup.serviced_ops | read, write | operations/s | +| k8s.cgroup.throttle_io | read, write | KiB/s | +| k8s.cgroup.throttle_serviced_ops | read, write | operations/s | +| k8s.cgroup.queued_ops | read, write | operations | +| k8s.cgroup.merged_ops | read, write | operations/s | +| k8s.cgroup.cpu_some_pressure | some10, some60, some300 | percentage | +| k8s.cgroup.cpu_some_pressure_stall_time | time | ms | +| k8s.cgroup.cpu_full_pressure | some10, some60, some300 | percentage | +| k8s.cgroup.cpu_full_pressure_stall_time | time | ms | +| k8s.cgroup.memory_some_pressure | some10, some60, some300 | percentage | +| k8s.cgroup.memory_some_pressure_stall_time | time | ms | +| k8s.cgroup.memory_full_pressure | some10, some60, some300 | percentage | +| k8s.cgroup.memory_full_pressure_stall_time | time | ms | +| k8s.cgroup.io_some_pressure | some10, some60, some300 | percentage | +| k8s.cgroup.io_some_pressure_stall_time | time | ms | +| k8s.cgroup.io_full_pressure | some10, some60, some300 | percentage | +| k8s.cgroup.io_full_pressure_stall_time | time | ms | + +### Per k8s cgroup network device + + + +Labels: + +| Label | Description | +|:-----------|:----------------| +| device | TBD | +| interface_type | TBD | +| k8s_namespace | TBD | +| k8s_pod_name | TBD | +| k8s_pod_uid | TBD | +| k8s_controller_kind | TBD | +| k8s_controller_name | TBD | +| k8s_node_name | TBD | +| k8s_container_name | TBD | +| k8s_container_id | TBD | +| k8s_kind | TBD | +| k8s_qos_class | TBD | +| k8s_cluster_id | TBD | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| k8s.cgroup.net_net | received, sent | kilobits/s | +| k8s.cgroup.net_packets | received, sent, multicast | pps | +| k8s.cgroup.net_errors | inbound, outbound | errors/s | +| k8s.cgroup.net_drops | inbound, outbound | errors/s | +| k8s.cgroup.net_fifo | receive, transmit | errors/s | +| k8s.cgroup.net_compressed | receive, sent | pps | +| k8s.cgroup.net_events | frames, collisions, carrier | events/s | +| k8s.cgroup.net_operstate | up, down, notpresent, lowerlayerdown, testing, dormant, unknown | state | +| k8s.cgroup.net_carrier | up, down | state | +| k8s.cgroup.net_mtu | mtu | octets | + + + +## Alerts + + +The following alerts are available: + +| Alert name | On metric | Description | +|:------------|:----------|:------------| +| [ k8s_cgroup_10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | k8s.cgroup.cpu_limit | average cgroup CPU utilization over the last 10 minutes | +| [ k8s_cgroup_ram_in_use ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | k8s.cgroup.mem_usage | cgroup memory utilization | +| [ k8s_cgroup_1m_received_packets_rate ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | k8s.cgroup.net_packets | average number of packets received by the network interface ${label:device} over the last minute | +| [ k8s_cgroup_10s_received_packets_storm ](https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf) | k8s.cgroup.net_packets | ratio of average number of received packets for the network interface ${label:device} over the last 10 seconds, compared to the rate over the last minute | + + +## Setup + +### Prerequisites + +No action required. + +### Configuration + +#### File + +There is no configuration file. +#### Options + + + +There are no configuration options. + +#### Examples +There are no configuration examples. + + diff --git a/collectors/cgroups.plugin/integrations/libvirt_containers.md b/collectors/cgroups.plugin/integrations/libvirt_containers.md new file mode 100644 index 0000000000..f4939a0723 --- /dev/null +++ b/collectors/cgroups.plugin/integrations/libvirt_containers.md @@ -0,0 +1,160 @@ + + +# Libvirt Containers + +Plugin: cgroups.plugin +Module: /sys/fs/cgroup + +## Overview + +Monitor Libvirt for performance, resource usage, and health status. + + + +This collector is supported on all platforms. + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +This integration doesn't support auto-detection. + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per cgroup + + + +Labels: + +| Label | Description | +|:-----------|:----------------| +| container_name | TBD | +| image | TBD | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| cgroup.cpu_limit | used | percentage | +| cgroup.cpu | user, system | percentage | +| cgroup.cpu_per_core | a dimension per core | percentage | +| cgroup.throttled | throttled | percentage | +| cgroup.throttled_duration | duration | ms | +| cgroup.cpu_shares | shares | shares | +| cgroup.mem | cache, rss, swap, rss_huge, mapped_file | MiB | +| cgroup.writeback | dirty, writeback | MiB | +| cgroup.mem_activity | in, out | MiB/s | +| cgroup.pgfaults | pgfault, swap | MiB/s | +| cgroup.mem_usage | ram, swap | MiB | +| cgroup.mem_usage_limit | available, used | MiB | +| cgroup.mem_utilization | utilization | percentage | +| cgroup.mem_failcnt | failures | count | +| cgroup.io | read, write | KiB/s | +| cgroup.serviced_ops | read, write | operations/s | +| cgroup.throttle_io | read, write | KiB/s | +| cgroup.throttle_serviced_ops | read, write | operations/s | +| cgroup.queued_ops | read, write | operations | +| cgroup.merged_ops | read, write | operations/s | +| cgroup.cpu_some_pressure | some10, some60, some300 | percentage | +| cgroup.cpu_some_pressure_stall_time | time | ms | +| cgroup.cpu_full_pressure | some10, some60, some300 | percentage | +| cgroup.cpu_full_pressure_stall_time | time | ms | +| cgroup.memory_some_pressure | some10, some60, some300 | percentage | +| cgroup.memory_some_pressure_stall_time | time | ms | +| cgroup.memory_full_pressure | some10, some60, some300 | percentage | +| cgroup.memory_full_pressure_stall_time | time | ms | +| cgroup.io_some_pressure | some10, some60, some300 | percentage | +| cgroup.io_some_pressure_stall_time | time | ms | +| cgroup.io_full_pressure | some10, some60, some300 | percentage | +| cgroup.io_full_pressure_stall_time | time | ms | + +### Per cgroup network device + + + +Labels: + +| Label | Description | +|:-----------|:----------------| +| container_name | TBD | +| image | TBD | +| device | TBD | +| interface_type | TBD | + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| cgroup.net_net | received, s