From 7e33738ba4c9452c235620df2454cc8855b112f5 Mon Sep 17 00:00:00 2001 From: Fotis Voutsas Date: Thu, 6 Jul 2023 18:28:37 +0300 Subject: update generated yamls with ony the necessary info. Add also multi module schema --- collectors/apps.plugin/metadata.yaml | 666 +--- collectors/cgroups.plugin/metadata.yaml | 551 ++- collectors/charts.d.plugin/ap/metadata.yaml | 113 +- collectors/charts.d.plugin/apcupsd/metadata.yaml | 127 +- collectors/charts.d.plugin/libreswan/metadata.yaml | 105 +- collectors/charts.d.plugin/nut/metadata.yaml | 129 +- collectors/charts.d.plugin/opensips/metadata.yaml | 139 +- collectors/charts.d.plugin/sensors/metadata.yaml | 115 +- collectors/cups.plugin/metadata.yaml | 118 +- collectors/debugfs.plugin/metadata.yaml | 225 +- collectors/diskspace.plugin/metadata.yaml | 111 +- collectors/ebpf.plugin/metadata.yaml | 2170 +++------- collectors/freebsd.plugin/metadata.yaml | 3372 +++------------- collectors/freeipmi.plugin/metadata.yaml | 122 +- collectors/idlejitter.plugin/metadata.yaml | 103 +- collectors/ioping.plugin/metadata.yaml | 103 +- collectors/macos.plugin/metadata.yaml | 503 +-- collectors/metadata/schemas/multi-module.json | 16 + collectors/nfacct.plugin/metadata.yaml | 115 +- collectors/perf.plugin/metadata.yaml | 135 +- collectors/proc.plugin/metadata.yaml | 4176 +++++--------------- .../python.d.plugin/adaptec_raid/metadata.yaml | 112 +- collectors/python.d.plugin/alarms/metadata.yaml | 105 +- collectors/python.d.plugin/am2320/metadata.yaml | 105 +- collectors/python.d.plugin/anomalies/metadata.yaml | 108 +- collectors/python.d.plugin/beanstalk/metadata.yaml | 137 +- collectors/python.d.plugin/bind_rndc/metadata.yaml | 109 +- collectors/python.d.plugin/boinc/metadata.yaml | 118 +- collectors/python.d.plugin/ceph/metadata.yaml | 131 +- .../python.d.plugin/changefinder/metadata.yaml | 105 +- collectors/python.d.plugin/dovecot/metadata.yaml | 125 +- collectors/python.d.plugin/exim/metadata.yaml | 103 +- collectors/python.d.plugin/fail2ban/metadata.yaml | 107 +- collectors/python.d.plugin/gearman/metadata.yaml | 110 +- collectors/python.d.plugin/go_expvar/metadata.yaml | 115 +- collectors/python.d.plugin/haproxy/metadata.yaml | 164 +- collectors/python.d.plugin/hddtemp/metadata.yaml | 103 +- collectors/python.d.plugin/hpssa/metadata.yaml | 111 +- collectors/python.d.plugin/icecast/metadata.yaml | 103 +- collectors/python.d.plugin/ipfs/metadata.yaml | 109 +- collectors/python.d.plugin/litespeed/metadata.yaml | 119 +- collectors/python.d.plugin/megacli/metadata.yaml | 128 +- collectors/python.d.plugin/memcached/metadata.yaml | 135 +- collectors/python.d.plugin/monit/metadata.yaml | 125 +- collectors/python.d.plugin/nsd/metadata.yaml | 113 +- .../python.d.plugin/nvidia_smi/metadata.yaml | 131 +- collectors/python.d.plugin/openldap/metadata.yaml | 115 +- collectors/python.d.plugin/oracledb/metadata.yaml | 145 +- collectors/python.d.plugin/postfix/metadata.yaml | 105 +- collectors/python.d.plugin/puppet/metadata.yaml | 109 +- .../python.d.plugin/rethinkdbs/metadata.yaml | 122 +- .../python.d.plugin/retroshare/metadata.yaml | 107 +- collectors/python.d.plugin/riakkv/metadata.yaml | 166 +- collectors/python.d.plugin/samba/metadata.yaml | 115 +- collectors/python.d.plugin/sensors/metadata.yaml | 115 +- .../python.d.plugin/smartd_log/metadata.yaml | 171 +- collectors/python.d.plugin/spigotmc/metadata.yaml | 107 +- collectors/python.d.plugin/squid/metadata.yaml | 109 +- collectors/python.d.plugin/tomcat/metadata.yaml | 117 +- collectors/python.d.plugin/tor/metadata.yaml | 103 +- collectors/python.d.plugin/traefik/metadata.yaml | 117 +- collectors/python.d.plugin/uwsgi/metadata.yaml | 117 +- collectors/python.d.plugin/varnish/metadata.yaml | 145 +- collectors/python.d.plugin/w1sensor/metadata.yaml | 103 +- collectors/python.d.plugin/zscores/metadata.yaml | 105 +- collectors/slabinfo.plugin/metadata.yaml | 107 +- collectors/tc.plugin/metadata.yaml | 111 +- collectors/timex.plugin/metadata.yaml | 107 +- collectors/xenstat.plugin/metadata.yaml | 146 +- 69 files changed, 4067 insertions(+), 14842 deletions(-) create mode 100644 collectors/metadata/schemas/multi-module.json diff --git a/collectors/apps.plugin/metadata.yaml b/collectors/apps.plugin/metadata.yaml index fab01060af..cbe4e719fd 100644 --- a/collectors/apps.plugin/metadata.yaml +++ b/collectors/apps.plugin/metadata.yaml @@ -1,904 +1,624 @@ name: apps.plugin -title: TBD modules: - - name: system - title: COLLECTORNAME Monitoring - duplicate_for_virtual_integrations: - list: - - '[Ubuntu](link to ubuntu)' - - '[Redhat](link to redhat)' - overview: - operation: - description: This collector periodically does http requests to one or more - {[Apache](link to collector)} (<- CI will remove the curly brackets, they - are for replacing with the virtual integrations, to replace the link each - time) web servers to collect the metrics mod_status plugin that apache exposes - platforms: - description: If this collector can't run on some platforms specify them here - and set it to false, otherwise set this to true and this text will not be - rendered, instead a templated message will appear - use_templated_text: true - multi-instance: - boolean: true - permissions: - description: if there are any notable permission requirements, eg running - as root and so on, specify them here and set it to false, otherwise set - it to true and a templated message will appear - use_templated_text: true - related: - description: give a simple description if there are any other collectors related - to this collector. Example -> To get the most out of your apache servers, - you can monitor its processes for resources utilization and their log files - to turn them into real-time metrics. Check our related resources for more - information. (if not, leave empty) - setup: - prerequisites: - list: - - title: Prerequisite title for heading - text: List like with dashes, TBD, use | and newline for multiline - behavior: - auto_detection: - description: The collector auto-detects apache web servers running on localhost - ports 80, 443, and 8080. - limits: - description: The collector is limited to x amount of tables or any other - limitation, leave empty if none - impact: - description: Is there any impact on the application when using the default - configuration? Maybe on a db collector having to many tables might slow - down the db if collection happens per second, leave empty if none - configuration: - file: - description: 'which file the user has to edit. Example: go.d/apache.conf' - options: - description: TBD, use | and newline for multiline - folding: - title: Config options - enabled: true - list: - - name: option name - description: option description - default: a number or a string - required: true or false - examples: - folding: - title: Config - enabled: false - list: - - name: Basic / else describe what this example is about - description: A basic example configuration / describe your example - data: input the example data in yaml format - troubleshooting: - problems: - list: - - name: possible troubleshooting title - text: describe - debugging: - description: How to run this in debug mode? Use | and newline with indent, - to write in markdown - logs: - description: How can I monitor logs for this plugin? - related_resources: - integrations: - list: - - apache - - weblog - - httpcheck - - etc - provide: - description: What info I can provide for other plugins that reference me? - this will only be visible in their end, they will scrape this text. Example - -> apps.plugin allows monitoring individual processes CPU, Memory, Disk - I/O and many more resources utilization. + - module_name: system + plugin_name: apps.plugin alerts: [] metrics: - description: some description for this section, or leave empty folding: title: Metrics enabled: false - scope: - global: - name: global - description: TBD + description: '' + availability: [] + scopes: + - name: global + description: '' labels: [] metrics: - name: system.processes_state + availability: [] description: System Processes State unit: processes + chart_type: line dimensions: - name: running - name: sleeping_interruptible - name: sleeping_uninterruptible - name: zombie - name: stopped - - name: apps - title: COLLECTORNAME Monitoring - duplicate_for_virtual_integrations: - list: - - '[Ubuntu](link to ubuntu)' - - '[Redhat](link to redhat)' - overview: - operation: - description: This collector periodically does http requests to one or more - {[Apache](link to collector)} (<- CI will remove the curly brackets, they - are for replacing with the virtual integrations, to replace the link each - time) web servers to collect the metrics mod_status plugin that apache exposes - platforms: - description: If this collector can't run on some platforms specify them here - and set it to false, otherwise set this to true and this text will not be - rendered, instead a templated message will appear - use_templated_text: true - multi-instance: - boolean: true - permissions: - description: if there are any notable permission requirements, eg running - as root and so on, specify them here and set it to false, otherwise set - it to true and a templated message will appear - use_templated_text: true - related: - description: give a simple description if there are any other collectors related - to this collector. Example -> To get the most out of your apache servers, - you can monitor its processes for resources utilization and their log files - to turn them into real-time metrics. Check our related resources for more - information. (if not, leave empty) - setup: - prerequisites: - list: - - title: Prerequisite title for heading - text: List like with dashes, TBD, use | and newline for multiline - behavior: - auto_detection: - description: The collector auto-detects apache web servers running on localhost - ports 80, 443, and 8080. - limits: - description: The collector is limited to x amount of tables or any other - limitation, leave empty if none - impact: - description: Is there any impact on the application when using the default - configuration? Maybe on a db collector having to many tables might slow - down the db if collection happens per second, leave empty if none - configuration: - file: - description: 'which file the user has to edit. Example: go.d/apache.conf' - options: - description: TBD, use | and newline for multiline - folding: - title: Config options - enabled: true - list: - - name: option name - description: option description - default: a number or a string - required: true or false - examples: - folding: - title: Config - enabled: false - list: - - name: Basic / else describe what this example is about - description: A basic example configuration / describe your example - data: input the example data in yaml format - troubleshooting: - problems: - list: - - name: possible troubleshooting title - text: describe - debugging: - description: How to run this in debug mode? Use | and newline with indent, - to write in markdown - logs: - description: How can I monitor logs for this plugin? - related_resources: - integrations: - list: - - apache - - weblog - - httpcheck - - etc - provide: - description: What info I can provide for other plugins that reference me? - this will only be visible in their end, they will scrape this text. Example - -> apps.plugin allows monitoring individual processes CPU, Memory, Disk - I/O and many more resources utilization. + - module_name: apps + plugin_name: apps.plugin alerts: [] metrics: - description: some description for this section, or leave empty folding: title: Metrics enabled: false - scope: - global: - name: global - description: TBD + description: '' + availability: [] + scopes: + - name: global + description: '' labels: [] metrics: - name: apps.cpu + availability: [] description: Apps CPU Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.cpu_user + availability: [] description: Apps CPU User Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.cpu_system + availability: [] description: Apps CPU System Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.cpu_guest + availability: [] description: Apps CPU Guest Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.mem + availability: [] description: Apps Real Memory (w/o shared) unit: MiB + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.rss + availability: [] description: Apps Resident Set Size (w/shared) unit: MiB + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.vmem + availability: [] description: Apps Virtual Memory Size unit: MiB + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.swap + availability: [] description: Apps Swap Memory unit: MiB + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.major_faults + availability: [] description: Apps Major Page Faults (swap read) unit: page faults/s + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.minor_faults + availability: [] description: Apps Minor Page Faults (swap read) unit: page faults/s + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.preads + availability: [] description: Apps Disk Reads unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.pwrites + availability: [] description: Apps Disk Writes unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.lreads + availability: [] description: Apps Disk Logical Reads unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.lwrites + availability: [] description: Apps I/O Logical Writes unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.threads + availability: [] description: Apps Threads unit: threads + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.processes + availability: [] description: Apps Processes unit: processes + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.voluntary_ctxt_switches + availability: [] description: Apps Voluntary Context Switches unit: processes + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.involuntary_ctxt_switches + availability: [] description: Apps Involuntary Context Switches unit: processes + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.uptime + availability: [] description: Apps Carried Over Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per app group - name: apps.uptime_min + availability: [] description: Apps Minimum Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per app group - name: apps.uptime_avg + availability: [] description: Apps Average Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per app group - name: apps.uptime_max + availability: [] description: Apps Maximum Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per app group - name: apps.files + availability: [] description: Apps Open Files unit: open files + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.sockets + availability: [] description: Apps Open Sockets unit: open sockets + chart_type: stacked dimensions: - name: a dimension per app group - name: apps.pipes + availability: [] description: Apps Open Pipes unit: open pipes + chart_type: stacked dimensions: - name: a dimension per app group - - name: groups - title: COLLECTORNAME Monitoring - duplicate_for_virtual_integrations: - list: - - '[Ubuntu](link to ubuntu)' - - '[Redhat](link to redhat)' - overview: - operation: - description: This collector periodically does http requests to one or more - {[Apache](link to collector)} (<- CI will remove the curly brackets, they - are for replacing with the virtual integrations, to replace the link each - time) web servers to collect the metrics mod_status plugin that apache exposes - platforms: - description: If this collector can't run on some platforms specify them here - and set it to false, otherwise set this to true and this text will not be - rendered, instead a templated message will appear - use_templated_text: true - multi-instance: - boolean: true - permissions: - description: if there are any notable permission requirements, eg running - as root and so on, specify them here and set it to false, otherwise set - it to true and a templated message will appear - use_templated_text: true - related: - description: give a simple description if there are any other collectors related - to this collector. Example -> To get the most out of your apache servers, - you can monitor its processes for resources utilization and their log files - to turn them into real-time metrics. Check our related resources for more - information. (if not, leave empty) - setup: - prerequisites: - list: - - title: Prerequisite title for heading - text: List like with dashes, TBD, use | and newline for multiline - behavior: - auto_detection: - description: The collector auto-detects apache web servers running on localhost - ports 80, 443, and 8080. - limits: - description: The collector is limited to x amount of tables or any other - limitation, leave empty if none - impact: - description: Is there any impact on the application when using the default - configuration? Maybe on a db collector having to many tables might slow - down the db if collection happens per second, leave empty if none - configuration: - file: - description: 'which file the user has to edit. Example: go.d/apache.conf' - options: - description: TBD, use | and newline for multiline - folding: - title: Config options - enabled: true - list: - - name: option name - description: option description - default: a number or a string - required: true or false - examples: - folding: - title: Config - enabled: false - list: - - name: Basic / else describe what this example is about - description: A basic example configuration / describe your example - data: input the example data in yaml format - troubleshooting: - problems: - list: - - name: possible troubleshooting title - text: describe - debugging: - description: How to run this in debug mode? Use | and newline with indent, - to write in markdown - logs: - description: How can I monitor logs for this plugin? - related_resources: - integrations: - list: - - apache - - weblog - - httpcheck - - etc - provide: - description: What info I can provide for other plugins that reference me? - this will only be visible in their end, they will scrape this text. Example - -> apps.plugin allows monitoring individual processes CPU, Memory, Disk - I/O and many more resources utilization. + - module_name: groups + plugin_name: apps.plugin alerts: [] metrics: - description: some description for this section, or leave empty folding: title: Metrics enabled: false - scope: - global: - name: global - description: TBD + description: '' + availability: [] + scopes: + - name: global + description: '' labels: [] metrics: - name: groups.cpu + availability: [] description: User Groups CPU Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.cpu_user + availability: [] description: User Groups CPU User Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.cpu_system + availability: [] description: User Groups CPU System Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.cpu_guest + availability: [] description: User Groups CPU Guest Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.mem + availability: [] description: User Groups Real Memory (w/o shared) unit: MiB + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.rss + availability: [] description: User Groups Resident Set Size (w/shared) unit: MiB + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.vmem + availability: [] description: User Groups Virtual Memory Size unit: MiB + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.swap + availability: [] description: User Groups Swap Memory unit: MiB + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.major_faults + availability: [] description: User Groups Major Page Faults (swap read) unit: page faults/s + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.minor_faults + availability: [] description: User Groups Page Faults (swap read) unit: page faults/s + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.preads + availability: [] description: User Groups Disk Reads unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.pwrites + availability: [] description: User Groups Disk Writes unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.lreads + availability: [] description: User Groups Disk Logical Reads unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.lwrites + availability: [] description: User Groups I/O Logical Writes unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.threads + availability: [] description: User Groups Threads unit: threads + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.processes + availability: [] description: User Groups Processes unit: processes + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.voluntary_ctxt_switches + availability: [] description: User Groups Voluntary Context Switches unit: processes + chart_type: stacked dimensions: - name: a dimension per app group - name: groups.involuntary_ctxt_switches + availability: [] description: User Groups Involuntary Context Switches unit: processes + chart_type: stacked dimensions: - name: a dimension per app group - name: groups.uptime + availability: [] description: User Groups Carried Over Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user group - name: groups.uptime_min + availability: [] description: User Groups Minimum Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user group - name: groups.uptime_avg + availability: [] description: User Groups Average Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user group - name: groups.uptime_max + availability: [] description: User Groups Maximum Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user group - name: groups.files + availability: [] description: User Groups Open Files unit: open files + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.sockets + availability: [] description: User Groups Open Sockets unit: open sockets + chart_type: stacked dimensions: - name: a dimension per user group - name: groups.pipes + availability: [] description: User Groups Open Pipes unit: open pipes + chart_type: stacked dimensions: - name: a dimension per user group - - name: users - title: COLLECTORNAME Monitoring - duplicate_for_virtual_integrations: - list: - - '[Ubuntu](link to ubuntu)' - - '[Redhat](link to redhat)' - overview: - operation: - description: This collector periodically does http requests to one or more - {[Apache](link to collector)} (<- CI will remove the curly brackets, they - are for replacing with the virtual integrations, to replace the link each - time) web servers to collect the metrics mod_status plugin that apache exposes - platforms: - description: If this collector can't run on some platforms specify them here - and set it to false, otherwise set this to true and this text will not be - rendered, instead a templated message will appear - use_templated_text: true - multi-instance: - boolean: true - permissions: - description: if there are any notable permission requirements, eg running - as root and so on, specify them here and set it to false, otherwise set - it to true and a templated message will appear - use_templated_text: true - related: - description: give a simple description if there are any other collectors related - to this collector. Example -> To get the most out of your apache servers, - you can monitor its processes for resources utilization and their log files - to turn them into real-time metrics. Check our related resources for more - information. (if not, leave empty) - setup: - prerequisites: - list: - - title: Prerequisite title for heading - text: List like with dashes, TBD, use | and newline for multiline - behavior: - auto_detection: - description: The collector auto-detects apache web servers running on localhost - ports 80, 443, and 8080. - limits: - description: The collector is limited to x amount of tables or any other - limitation, leave empty if none - impact: - description: Is there any impact on the application when using the default - configuration? Maybe on a db collector having to many tables might slow - down the db if collection happens per second, leave empty if none - configuration: - file: - description: 'which file the user has to edit. Example: go.d/apache.conf' - options: - description: TBD, use | and newline for multiline - folding: - title: Config options - enabled: true - list: - - name: option name - description: option description - default: a number or a string - required: true or false - examples: - folding: - title: Config - enabled: false - list: - - name: Basic / else describe what this example is about - description: A basic example configuration / describe your example - data: input the example data in yaml format - troubleshooting: - problems: - list: - - name: possible troubleshooting title - text: describe - debugging: - description: How to run this in debug mode? Use | and newline with indent, - to write in markdown - logs: - description: How can I monitor logs for this plugin? - related_resources: - integrations: - list: - - apache - - weblog - - httpcheck - - etc - provide: - description: What info I can provide for other plugins that reference me? - this will only be visible in their end, they will scrape this text. Example - -> apps.plugin allows monitoring individual processes CPU, Memory, Disk - I/O and many more resources utilization. + - module_name: users + plugin_name: apps.plugin alerts: [] metrics: - description: some description for this section, or leave empty folding: title: Metrics enabled: false - scope: - global: - name: global - description: TBD + description: '' + availability: [] + scopes: + - name: global + description: '' labels: [] metrics: - name: users.cpu + availability: [] description: Users CPU Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user - name: users.cpu_user + availability: [] description: Users CPU User Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user - name: users.cpu_system + availability: [] description: Users CPU System Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user - name: users.cpu_guest + availability: [] description: Users CPU Guest Time (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: a dimension per user - name: users.mem + availability: [] description: Users Real Memory (w/o shared) unit: MiB + chart_type: stacked dimensions: - name: a dimension per user - name: users.rss + availability: [] description: Users Resident Set Size (w/shared) unit: MiB + chart_type: stacked dimensions: - name: a dimension per user - name: users.vmem + availability: [] description: Users Virtual Memory Size unit: MiB + chart_type: stacked dimensions: - name: a dimension per user - name: users.swap + availability: [] description: Users Swap Memory unit: MiB + chart_type: stacked dimensions: - name: a dimension per user - name: users.major_faults + availability: [] description: Users Major Page Faults (swap read) unit: page faults/s + chart_type: stacked dimensions: - name: a dimension per user - name: users.minor_faults + availability: [] description: Users Page Faults (swap read) unit: page faults/s + chart_type: stacked dimensions: - name: a dimension per user - name: users.preads + availability: [] description: Users Disk Reads unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user - name: users.pwrites + availability: [] description: Users Disk Writes unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user - name: users.lreads + availability: [] description: Users Disk Logical Reads unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user - name: users.lwrites + availability: [] description: Users I/O Logical Writes unit: KiB/s + chart_type: stacked dimensions: - name: a dimension per user - name: users.threads + availability: [] description: Users Threads unit: threads + chart_type: stacked dimensions: - name: a dimension per user - name: users.processes + availability: [] description: Users Processes unit: processes + chart_type: stacked dimensions: - name: a dimension per user - name: users.voluntary_ctxt_switches + availability: [] description: Users Voluntary Context Switches unit: processes + chart_type: stacked dimensions: - name: a dimension per app group - name: users.involuntary_ctxt_switches + availability: [] description: Users Involuntary Context Switches unit: processes + chart_type: stacked dimensions: - name: a dimension per app group - name: users.uptime + availability: [] description: Users Carried Over Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user - name: users.uptime_min + availability: [] description: Users Minimum Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user - name: users.uptime_avg + availability: [] description: Users Average Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user - name: users.uptime_max + availability: [] description: Users Maximum Uptime unit: seconds + chart_type: line dimensions: - name: a dimension per user - name: users.files + availability: [] description: Users Open Files unit: open files + chart_type: stacked dimensions: - name: a dimension per user - name: users.sockets + availability: [] description: Users Open Sockets unit: open sockets + chart_type: stacked dimensions: - name: a dimension per user - name: users.pipes + availability: [] description: Users Open Pipes unit: open pipes + chart_type: stacked dimensions: - name: a dimension per user - - name: netdata - title: COLLECTORNAME Monitoring - duplicate_for_virtual_integrations: - list: - - '[Ubuntu](link to ubuntu)' - - '[Redhat](link to redhat)' - overview: - operation: - description: This collector periodically does http requests to one or more - {[Apache](link to collector)} (<- CI will remove the curly brackets, they - are for replacing with the virtual integrations, to replace the link each - time) web servers to collect the metrics mod_status plugin that apache exposes - platforms: - description: If this collector can't run on some platforms specify them here - and set it to false, otherwise set this to true and this text will not be - rendered, instead a templated message will appear - use_templated_text: true - multi-instance: - boolean: true - permissions: - description: if there are any notable permission requirements, eg running - as root and so on, specify them here and set it to false, otherwise set - it to true and a templated message will appear - use_templated_text: true - related: - description: give a simple description if there are any other collectors related - to this collector. Example -> To get the most out of your apache servers, - you can monitor its processes for resources utilization and their log files - to turn them into real-time metrics. Check our related resources for more - information. (if not, leave empty) - setup: - prerequisites: - list: - - title: Prerequisite title for heading - text: List like with dashes, TBD, use | and newline for multiline - behavior: - auto_detection: - description: The collector auto-detects apache web servers running on localhost - ports 80, 443, and 8080. - limits: - description: The collector is limited to x amount of tables or any other - limitation, leave empty if none - impact: - description: Is there any impact on the application when using the default - configuration? Maybe on a db collector having to many tables might slow - down the db if collection happens per second, leave empty if none - configuration: - file: - description: 'which file the user has to edit. Example: go.d/apache.conf' - options: - description: TBD, use | and newline for multiline - folding: - title: Config options - enabled: true - list: - - name: option name - description: option description - default: a number or a string - required: true or false - examples: - folding: - title: Config - enabled: false - list: - - name: Basic / else describe what this example is about - description: A basic example configuration / describe your example - data: input the example data in yaml format - troubleshooting: - problems: - list: - - name: possible troubleshooting title - text: describe - debugging: - description: How to run this in debug mode? Use | and newline with indent, - to write in markdown - logs: - description: How can I monitor logs for this plugin? - related_resources: - integrations: - list: - - apache - - weblog - - httpcheck - - etc - provide: - description: What info I can provide for other plugins that reference me? - this will only be visible in their end, they will scrape this text. Example - -> apps.plugin allows monitoring individual processes CPU, Memory, Disk - I/O and many more resources utilization. + - module_name: netdata + plugin_name: apps.plugin alerts: [] metrics: - description: some description for this section, or leave empty folding: title: Metrics enabled: false - scope: - global: - name: global - description: TBD + description: '' + availability: [] + scopes: + - name: global + description: '' labels: [] metrics: - name: netdata.apps_cpu + availability: [] description: Apps Plugin CPU unit: milliseconds/s + chart_type: stacked dimensions: - name: user - name: system - name: netdata.apps_sizes + availability: [] description: Apps Plugin Files unit: files/s + chart_type: line dimensions: - name: calls - name: files @@ -910,8 +630,10 @@ modules: - name: targets - name: new_pids - name: netdata.apps_fix + availability: [] description: Apps Plugin Normalization Ratios unit: percentage + chart_type: line dimensions: - name: utime - name: stime @@ -919,8 +641,10 @@ modules: - name: minflt - name: majflt - name: netdata.apps_children_fix + availability: [] description: Apps Plugin Exited Children Normalization Ratios unit: percentage + chart_type: line dimensions: - name: utime - name: stime diff --git a/collectors/cgroups.plugin/metadata.yaml b/collectors/cgroups.plugin/metadata.yaml index baf416e64c..8c60067aa2 100644 --- a/collectors/cgroups.plugin/metadata.yaml +++ b/collectors/cgroups.plugin/metadata.yaml @@ -1,121 +1,37 @@ name: cgroups.plugin -title: TBD modules: - - name: /sys/fs/cgroup - title: COLLECTORNAME Monitoring - duplicate_for_virtual_integrations: - list: - - '[Ubuntu](link to ubuntu)' - - '[Redhat](link to redhat)' - overview: - operation: - description: This collector periodically does http requests to one or more - {[Apache](link to collector)} (<- CI will remove the curly brackets, they - are for replacing with the virtual integrations, to replace the link each - time) web servers to collect the metrics mod_status plugin that apache exposes - platforms: - description: If this collector can't run on some platforms specify them here - and set it to false, otherwise set this to true and this text will not be - rendered, instead a templated message will appear - use_templated_text: true - multi-instance: - boolean: true - permissions: - description: if there are any notable permission requirements, eg running - as root and so on, specify them here and set it to false, otherwise set - it to true and a templated message will appear - use_templated_text: true - related: - description: give a simple description if there are any other collectors related - to this collector. Example -> To get the most out of your apache servers, - you can monitor its processes for resources utilization and their log files - to turn them into real-time metrics. Check our related resources for more - information. (if not, leave empty) - setup: - prerequisites: - list: - - title: Prerequisite title for heading - text: List like with dashes, TBD, use | and newline for multiline - behavior: - auto_detection: - description: The collector auto-detects apache web servers running on localhost - ports 80, 443, and 8080. - limits: - description: The collector is limited to x amount of tables or any other - limitation, leave empty if none - impact: - description: Is there any impact on the application when using the default - configuration? Maybe on a db collector having to many tables might slow - down the db if collection happens per second, leave empty if none - configuration: - file: - description: 'which file the user has to edit. Example: go.d/apache.conf' - options: - description: TBD, use | and newline for multiline - folding: - title: Config options - enabled: true - list: - - name: option name - description: option description - default: a number or a string - required: true or false - examples: - folding: - title: Config - enabled: false - list: - - name: Basic / else describe what this example is about - description: A basic example configuration / describe your example - data: input the example data in yaml format - troubleshooting: - problems: - list: - - name: possible troubleshooting title - text: describe - debugging: - description: How to run this in debug mode? Use | and newline with indent, - to write in markdown - logs: - description: How can I monitor logs for this plugin? - related_resources: - integrations: - list: - - apache - - weblog - - httpcheck - - etc - provide: - description: What info I can provide for other plugins that reference me? - this will only be visible in their end, they will scrape this text. Example - -> apps.plugin allows monitoring individual processes CPU, Memory, Disk - I/O and many more resources utilization. + - module_name: /sys/fs/cgroup + plugin_name: cgroups.plugin alerts: - - name: '[cgroup_10min_cpu_usage](https://gihtub.com/netdata/netdata/blob/master/health/health.d/cgroups.conf)' + - name: cgroup_10min_cpu_usage + link: https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf metric: cgroup.cpu_limit info: average cgroup CPU utilization over the last 10 minutes os: linux - - name: '[cgroup_ram_in_use](https://gihtub.com/netdata/netdata/blob/master/health/health.d/cgroups.conf)' + - name: cgroup_ram_in_use + link: https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf metric: cgroup.mem_usage info: cgroup memory utilization os: linux - - name: '[k8s_cgroup_10min_cpu_usage](https://gihtub.com/netdata/netdata/blob/master/health/health.d/cgroups.conf)' + - name: k8s_cgroup_10min_cpu_usage + link: https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf metric: k8s.cgroup.cpu_limit info: average cgroup CPU utilization over the last 10 minutes os: linux - - name: '[k8s_cgroup_ram_in_use](https://gihtub.com/netdata/netdata/blob/master/health/health.d/cgroups.conf)' + - name: k8s_cgroup_ram_in_use + link: https://github.com/netdata/netdata/blob/master/health/health.d/cgroups.conf metric: k8s.cgroup.mem_usage info: cgroup memory utilization os: linux metrics: - description: some description for this section, or leave empty folding: title: Metrics enabled: false - scope: - cgroup: - name: cgroup - description: TBD + description: '' + availability: [] + scopes: + - name: cgroup + description: '' labels: - name: container_name description: TBD @@ -123,39 +39,53 @@ modules: description: TBD metrics: - name: cgroup.cpu_limit + availability: [] description: CPU Usage within the limits unit: percentage + chart_type: line dimensions: - name: used - name: cgroup.cpu + availability: [] description: CPU Usage (100% = 1 core) unit: percentage + chart_type: stacked dimensions: - name: user - name: system - name: cgroup.cpu_per_core + availability: [] description: CPU Usage (100% = 1 core) Per Core unit: percentage + chart_type: line dimensions: - name: a dimension per core - name: cgroup.throttled + availability: [] description: CPU Throttled Runnable Periods unit: percentage + chart_type: line dimensions: - name: throttled - name: cgroup.throttled_duration + availability: [] description: CPU Throttled Time Duration unit: ms + chart_type: line dimensions: - name: duration - name: cgroup.cpu_shares + availability: [] description: CPU Time Relative Share unit: shares + chart_type: line dimensions: - name: shares - name: cgroup.mem + availability: [] description: Memory Usage unit: MiB + chart_type: stacked dimensions: - name: cache - name: rss @@ -163,156 +93,205 @@ modules: - name: rss_huge - name: mapped_file - name: cgroup.writeback + availability: [] description: Writeback Memory unit: MiB + chart_type: area dimensions: - name: dirty - name: writeback - name: cgroup.mem_activity + availability: [] description: Memory Activity unit: MiB/s + chart_type: line dimensions: - name: in - name: out - name: cgroup.pgfaults + availability: [] description: Memory Page Faults unit: MiB/s + chart_type: line dimensions: - name: pgfault - name: swap - name: cgroup.mem_usage + availability: [] description: Used Memory unit: MiB + chart_type: stacked dimensions: - name: ram - name: swap - name: cgroup.mem_usage_limit + availability: [] description: Used RAM within the limits unit: MiB + chart_type: stacked dimensions: - name: available - name: used - name: cgroup.mem_utilization + availability: [] description: Memory Utilization unit: percentage + chart_type: line dimensions: - name: utilization - name: cgroup.mem_failcnt + availability: [] description: Memory Limit Failures unit: count + chart_type: line dimensions: - name: failures - name: cgroup.io + availability: [] description: I/O Bandwidth (all disks) unit: KiB/s + chart_type: area dimensions: - name: read - name: write - name: cgroup.serviced_ops + availability: [] description: Serviced I/O Operations (all disks) unit: operations/s + chart_type: line dimensions: - name: read - name: write - name: cgroup.throttle_io + availability: [] description: Throttle I/O Bandwidth (all disks) unit: KiB/s + chart_type: area dimensions: - name: read - name: write - name: cgroup.throttle_serviced_ops + availability: [] description: Throttle Serviced I/O Operations (all disks) unit: operations/s + chart_type: line dimensions: - name: read - name: write - name: cgroup.queued_ops + availability: [] description: Queued I/O Operations (all disks) unit: operations + chart_type: line dimensions: - name: read - name: write - name: cgroup.merged_ops + availability: [] description: Merged I/O Operations (all disks) unit: operations/s + chart_type: line dimensions: - name: read - name: write - name: cgroup.cpu_some_pressure + availability: [] description: CPU some pressure unit: percentage + chart_type: line dimensions: - name: some10 - name: some60 - name: some300 - name: cgroup.cpu_some_pressure_stall_time + availability: [] description: CPU some pressure stall time unit: ms + chart_type: line dimensions: - name: time - name: cgroup.cpu_full_pressure + availability: [] description: CPU full pressure unit: percentage + chart_type: line dimensions: - name: some10 - name: some60 - name: some300 - name: cgroup.cpu_full_pressure_stall_time + availability: [] description: CPU full pressure stall time unit: ms + chart_type: line dimensions: - name: time - name: cgroup.memory_some_pressure + availability: [] description: Memory some pressure unit: percentage + chart_type: line dimensions: - name: some10 - name: some60 - name: some300 - name: cgroup.memory_some_pressure_stall_time + availability: [] description: Memory some pressure stall time unit: ms + chart_type: line dimensions: - name: time - name: cgroup.memory_full_pressure + availability: [] description: Memory full pressure unit: percentage + chart_type: line dimensions: - name: some10 - name: some60 - name: some300 - name: cgroup.memory_full_pressure_stall_time + availability: [] description: Memory full pressure stall time unit: ms + chart_type: line dimensions: - name: time - name: cgroup.io_some_pressure + availability: [] description: I/O some pressure unit: percentage + chart_type: line dimensions: - name: some10 - name: some60 - name: some300 - name: cgroup.io_some_pressure_stall_time + availability: [] description: I/O some pressure stall time unit: ms + chart_type: line dimensions: - name: time - name: cgroup.io_full_pressure + availability: [] description: I/O some pressure unit: percentage + chart_type: line dimensions: - name: some10 - name: some60 - name: some300 - name: cgroup.io_full_pressure_stall_time + availability: [] description: I/O some pressure stall time unit: ms + chart_type: line dimensions: - name: time - k8s cgroup: - name: k8s cgroup - description: TBD + - name: k8s cgroup + description: '' labels: - name: k8s_namespace description: TBD @@ -338,39 +317,53 @@ modules: description: TBD metrics: - name: k8s.cgroup.cpu_limit + availability: [] description: CPU Usage within the limits unit: percentage + chart_type: line dimensions: - name: used - name: k8s.cgroup.cpu + availability: [] description: CPU Usage (100% = 1000 mCPU) unit: percentage + chart_type: stacked dimensions: - name: user - name: system - name: k8s.cgroup.cpu_per_core + availability: [] description: CPU Usage (100% = 1000 mCPU) Per Core unit: percentage + chart_type: line dimensions: - name: a dimension per core - name: k8s.cgroup.throttled + availability: [] description: CPU Throttled Runnable Periods unit: percentage + chart_type: line dimensions: - name: throttled - name: k8s.cgroup.throttled_duration + availability: [] description: CPU Throttled Time Duration unit: