summaryrefslogtreecommitdiffstats
path: root/collectors/perf.plugin/metadata.yaml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-08-10 09:18:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-08-10 09:18:49 +0000
commitdd814a7c1a8de056a79f7238578b09236edd5506 (patch)
tree429e7eed5a634a4efe9a6877ce66da8e64aa1782 /collectors/perf.plugin/metadata.yaml
parentAdding upstream version 1.41.0. (diff)
downloadnetdata-upstream/1.42.0.tar.xz
netdata-upstream/1.42.0.zip
Adding upstream version 1.42.0.upstream/1.42.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'collectors/perf.plugin/metadata.yaml')
-rw-r--r--collectors/perf.plugin/metadata.yaml397
1 files changed, 215 insertions, 182 deletions
diff --git a/collectors/perf.plugin/metadata.yaml b/collectors/perf.plugin/metadata.yaml
index a93970e5..d7539b50 100644
--- a/collectors/perf.plugin/metadata.yaml
+++ b/collectors/perf.plugin/metadata.yaml
@@ -1,183 +1,216 @@
-meta:
- plugin_name: perf.plugin
- module_name: perf.plugin
- monitored_instance:
- name: CPU performance
- link: ''
- categories:
- - data-collection.linux-systems
- icon_filename: 'bolt.svg'
- related_resources:
- integrations:
- list: []
- info_provided_to_referring_integrations:
- description: ''
- keywords: []
- most_popular: false
-overview:
- data_collection:
- metrics_description: 'Monitor CPU performance to ensure optimal computational operations. Monitor core usage, load averages, and thermal throttling for seamless computation tasks.'
- method_description: ''
- supported_platforms:
- include: []
- exclude: []
- multi-instance: true
- additional_permissions:
- description: ''
- default_behavior:
- auto_detection:
- description: ''
- limits:
- description: ''
- performance_impact:
- description: ''
-setup:
- prerequisites:
- list: []
- configuration:
- file:
- name: ''
- description: ''
- options:
- description: ''
- folding:
- title: ''
- enabled: true
- list: []
- examples:
- folding:
- enabled: true
- title: ''
- list: []
-troubleshooting:
- problems:
- list: []
-alerts: []
-metrics:
- folding:
- title: Metrics
- enabled: false
- description: ""
- availability: []
- scopes:
- - name: global
- description: ""
- labels: []
+plugin_name: perf.plugin
+modules:
+ - meta:
+ plugin_name: perf.plugin
+ module_name: perf.plugin
+ monitored_instance:
+ name: CPU performance
+ link: "https://kernel.org/"
+ categories:
+ - data-collection.linux-systems
+ icon_filename: "bolt.svg"
+ related_resources:
+ integrations:
+ list: []
+ info_provided_to_referring_integrations:
+ description: ""
+ keywords:
+ - linux
+ - cpu performance
+ - cpu cache
+ - perf.plugin
+ most_popular: false
+ overview:
+ data_collection:
+ metrics_description: "This collector monitors CPU performance metrics about cycles, instructions, migrations, cache operations and more."
+ method_description: "It uses syscall (2) to open a file descriptior to monitor the perf events."
+ supported_platforms:
+ include:
+ - Linux
+ exclude: []
+ multi_instance: true
+ additional_permissions:
+ description: "It needs setuid to use necessary syscall to collect perf events. Netada sets the permission during installation time."
+ default_behavior:
+ auto_detection:
+ description: ""
+ limits:
+ description: ""
+ performance_impact:
+ description: ""
+ setup:
+ prerequisites:
+ list: []
+ configuration:
+ file:
+ name: "netdata.conf"
+ section_name: "[plugin:perf]"
+ description: "The main netdata configuration file."
+ options:
+ description: |
+ You can get the available options running:
+
+ ```bash
+ /usr/libexec/netdata/plugins.d/perf.plugin --help
+ ````
+ folding:
+ title: "Config options"
+ enabled: true
+ list:
+ - name: update every
+ description: Data collection frequency.
+ default_value: 1
+ required: false
+ - name: command options
+ description: Command options that specify charts shown by plugin.
+ default_value: 1
+ required: true
+ examples:
+ folding:
+ enabled: true
+ title: "Config"
+ list:
+ - name: All metrics
+ folding:
+ enabled: false
+ description: Monitor all metrics available.
+ config: |
+ [plugin:perf]
+ command options = all
+ - name: CPU cycles
+ description: Monitor CPU cycles.
+ config: |
+ [plugin:perf]
+ command options = cycles
+ troubleshooting:
+ problems:
+ list: []
+ alerts: []
metrics:
- - name: perf.cpu_cycles
- description: CPU cycles
- unit: "cycles/s"
- chart_type: line
- dimensions:
- - name: cpu
- - name: ref_cpu
- - name: perf.instructions
- description: Instructions
- unit: "instructions/s"
- chart_type: line
- dimensions:
- - name: instructions
- - name: perf.instructions_per_cycle
- description: Instructions per Cycle(IPC)
- unit: "instructions/cycle"
- chart_type: line
- dimensions:
- - name: ipc
- - name: perf.branch_instructions
- description: Branch instructions
- unit: "instructions/s"
- chart_type: line
- dimensions:
- - name: instructions
- - name: misses
- - name: perf.cache
- description: Cache operations
- unit: "operations/s"
- chart_type: line
- dimensions:
- - name: references
- - name: misses
- - name: perf.bus_cycles
- description: Bus cycles
- unit: "cycles/s"
- chart_type: line
- dimensions:
- - name: bus
- - name: perf.stalled_cycles
- description: Stalled frontend and backend cycles
- unit: "cycles/s"
- chart_type: line
- dimensions:
- - name: frontend
- - name: backend
- - name: perf.migrations
- description: CPU migrations
- unit: "migrations"
- chart_type: line
- dimensions:
- - name: migrations
- - name: perf.alignment_faults
- description: Alignment faults
- unit: "faults"
- chart_type: line
- dimensions:
- - name: faults
- - name: perf.emulation_faults
- description: Emulation faults
- unit: "faults"
- chart_type: line
- dimensions:
- - name: faults
- - name: perf.l1d_cache
- description: L1D cache operations
- unit: "events/s"
- chart_type: line
- dimensions:
- - name: read_access
- - name: read_misses
- - name: write_access
- - name: write_misses
- - name: perf.l1d_cache_prefetch
- description: L1D prefetch cache operations
- unit: "prefetches/s"
- chart_type: line
- dimensions:
- - name: prefetches
- - name: perf.l1i_cache
- description: L1I cache operations
- unit: "events/s"
- chart_type: line
- dimensions:
- - name: read_access
- - name: read_misses
- - name: perf.ll_cache
- description: LL cache operations
- unit: "events/s"
- chart_type: line
- dimensions:
- - name: read_access
- - name: read_misses
- - name: write_access
- - name: write_misses
- - name: perf.dtlb_cache
- description: DTLB cache operations
- unit: "events/s"
- chart_type: line
- dimensions:
- - name: read_access
- - name: read_misses
- - name: write_access
- - name: write_misses
- - name: perf.itlb_cache
- description: ITLB cache operations
- unit: "events/s"
- chart_type: line
- dimensions:
- - name: read_access
- - name: read_misses
- - name: perf.pbu_cache
- description: PBU cache operations
- unit: "events/s"
- chart_type: line
- dimensions:
- - name: read_access
+ folding:
+ title: Metrics
+ enabled: false
+ description: ""
+ availability: []
+ scopes:
+ - name: global
+ description: "These metrics refer to the entire monitored application."
+ labels: []
+ metrics:
+ - name: perf.cpu_cycles
+ description: CPU cycles
+ unit: "cycles/s"
+ chart_type: line
+ dimensions:
+ - name: cpu
+ - name: ref_cpu
+ - name: perf.instructions
+ description: Instructions
+ unit: "instructions/s"
+ chart_type: line
+ dimensions:
+ - name: instructions
+ - name: perf.instructions_per_cycle
+ description: Instructions per Cycle(IPC)
+ unit: "instructions/cycle"
+ chart_type: line
+ dimensions:
+ - name: ipc
+ - name: perf.branch_instructions
+ description: Branch instructions
+ unit: "instructions/s"
+ chart_type: line
+ dimensions:
+ - name: instructions
+ - name: misses
+ - name: perf.cache
+ description: Cache operations
+ unit: "operations/s"
+ chart_type: line
+ dimensions:
+ - name: references
+ - name: misses
+ - name: perf.bus_cycles
+ description: Bus cycles
+ unit: "cycles/s"
+ chart_type: line
+ dimensions:
+ - name: bus
+ - name: perf.stalled_cycles
+ description: Stalled frontend and backend cycles
+ unit: "cycles/s"
+ chart_type: line
+ dimensions:
+ - name: frontend
+ - name: backend
+ - name: perf.migrations
+ description: CPU migrations
+ unit: "migrations"
+ chart_type: line
+ dimensions:
+ - name: migrations
+ - name: perf.alignment_faults
+ description: Alignment faults
+ unit: "faults"
+ chart_type: line
+ dimensions:
+ - name: faults
+ - name: perf.emulation_faults
+ description: Emulation faults
+ unit: "faults"
+ chart_type: line
+ dimensions:
+ - name: faults
+ - name: perf.l1d_cache
+ description: L1D cache operations
+ unit: "events/s"
+ chart_type: line
+ dimensions:
+ - name: read_access
+ - name: read_misses
+ - name: write_access
+ - name: write_misses
+ - name: perf.l1d_cache_prefetch
+ description: L1D prefetch cache operations
+ unit: "prefetches/s"
+ chart_type: line
+ dimensions:
+ - name: prefetches
+ - name: perf.l1i_cache
+ description: L1I cache operations
+ unit: "events/s"
+ chart_type: line
+ dimensions:
+ - name: read_access
+ - name: read_misses
+ - name: perf.ll_cache
+ description: LL cache operations
+ unit: "events/s"
+ chart_type: line
+ dimensions:
+ - name: read_access
+ - name: read_misses
+ - name: write_access
+ - name: write_misses
+ - name: perf.dtlb_cache
+ description: DTLB cache operations
+ unit: "events/s"
+ chart_type: line
+ dimensions:
+ - name: read_access
+ - name: read_misses
+ - name: write_access
+ - name: write_misses
+ - name: perf.itlb_cache
+ description: ITLB cache operations
+ unit: "events/s"
+ chart_type: line
+ dimensions:
+ - name: read_access
+ - name: read_misses
+ - name: perf.pbu_cache
+ description: PBU cache operations
+ unit: "events/s"
+ chart_type: line
+ dimensions:
+ - name: read_access