summaryrefslogtreecommitdiffstats
path: root/collectors/apps.plugin
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/apps.plugin')
-rw-r--r--collectors/apps.plugin/integrations/applications.md114
-rw-r--r--collectors/apps.plugin/integrations/user_groups.md114
-rw-r--r--collectors/apps.plugin/integrations/users.md114
3 files changed, 342 insertions, 0 deletions
diff --git a/collectors/apps.plugin/integrations/applications.md b/collectors/apps.plugin/integrations/applications.md
new file mode 100644
index 0000000000..5e529dd48e
--- /dev/null
+++ b/collectors/apps.plugin/integrations/applications.md
@@ -0,0 +1,114 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/integrations/applications.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/metadata.yaml"
+sidebar_label: "Applications"
+learn_status: "Published"
+learn_rel_path: "Data Collection/Processes and System Services"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
+endmeta-->
+
+# Applications
+
+Plugin: apps.plugin
+Module: apps
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## 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..e2ce90543d
--- /dev/null
+++ b/collectors/apps.plugin/integrations/user_groups.md
@@ -0,0 +1,114 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/integrations/user_groups.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/metadata.yaml"
+sidebar_label: "User Groups"
+learn_status: "Published"
+learn_rel_path: "Data Collection/Processes and System Services"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
+endmeta-->
+
+# User Groups
+
+Plugin: apps.plugin
+Module: groups
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## 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..760d178000
--- /dev/null
+++ b/collectors/apps.plugin/integrations/users.md
@@ -0,0 +1,114 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/integrations/users.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/metadata.yaml"
+sidebar_label: "Users"
+learn_status: "Published"
+learn_rel_path: "Data Collection/Processes and System Services"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
+endmeta-->
+
+# Users
+
+Plugin: apps.plugin
+Module: users
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## 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.
+
+