Regenerate integrations.js (#18110)
Co-authored-by: Ancairon <70198089+Ancairon@users.noreply.github.com>
Netdata bot committed
Jul 11, 2024 at 02:43 UTC
a420bfd386aeb3d0cb086fc9c02e4be2f755ebcb
5 files changed
+305
-73
integrations/integrations.js
+36
-36
@@ -15825,6 +15825,42 @@ export const integrations = [
15825
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/pulsar/metadata.yaml",
15826
"related_resources": ""
15827
},
15828
+ {
15829
+ "meta": {
15830
+ "id": "collector-go.d.plugin-puppet",
15831
+ "plugin_name": "go.d.plugin",
15832
+ "module_name": "puppet",
15833
+ "monitored_instance": {
15834
+ "name": "Puppet",
15835
+ "link": "https://www.puppet.com/",
15836
+ "categories": [
15837
+ "data-collection.ci-cd-systems"
15838
+ ],
15839
+ "icon_filename": "puppet.svg"
15840
+ },
15841
+ "related_resources": {
15842
+ "integrations": {
15843
+ "list": []
15844
+ }
15845
+ },
15846
+ "info_provided_to_referring_integrations": {
15847
+ "description": ""
15848
+ },
15849
+ "keywords": [
15850
+ "puppet"
15851
+ ],
15852
+ "most_popular": false
15853
+ },
15854
+ "overview": "# Puppet\n\nPlugin: go.d.plugin\nModule: puppet\n\n## Overview\n\nThis collector monitors Puppet metrics, including JVM heap and non-heap memory, CPU usage, and file descriptors.\n\n\nIt uses Puppet's metrics API endpoint [/status/v1/services](https://www.puppet.com/docs/puppetserver/5.3/status-api/v1/services.html) to gather the metrics.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, it detects Puppet instances running on localhost that are listening on port 8140.\nOn startup, it tries to collect metrics from:\n\n- https://127.0.0.1:8140\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
15855
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/puppet.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/puppet.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details open=true summary=\"\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| url | The base URL where the Puppet instance can be accessed. | https://127.0.0.1:8140 | yes |\n| timeout | HTTPS request timeout. | 1 | no |\n| username | Username for basic HTTPS authentication. | | no |\n| password | Password for basic HTTPS authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTPS authentication. | | no |\n| proxy_password | Password for proxy basic HTTPS authentication. | | no |\n| method | HTTPS request method. | POST | no |\n| body | HTTPS request body. | | no |\n| headers | HTTPS request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic with self-signed certificate\n\nPuppet with self-signed TLS certificate.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:8140\n tls_skip_verify: yes\n\n```\n{% /details %}\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:8140\n tls_skip_verify: yes\n\n - name: remote\n url: https://192.0.2.1:8140\n tls_skip_verify: yes\n\n```\n{% /details %}\n",
15856
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `puppet` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m puppet\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `puppet` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep puppet\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep puppet /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep puppet\n```\n\n",
15857
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15858
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Puppet instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| puppet.jvm_heap | committed, used | MiB |\n| puppet.jvm_nonheap | committed, used | MiB |\n| puppet.cpu | execution, GC | percentage |\n| puppet.fdopen | used | descriptors |\n\n",
15859
+ "integration_type": "collector",
15860
+ "id": "go.d.plugin-puppet-Puppet",
15861
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/puppet/metadata.yaml",
15862
+ "related_resources": ""
15863
+ },
15864
{
15865
"meta": {
15866
"id": "collector-go.d.plugin-rabbitmq",
@@ -19097,42 +19133,6 @@ export const integrations = [
19133
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/metadata.yaml",
19134
"related_resources": ""
19135
},
19100
- {
19101
- "meta": {
19102
- "plugin_name": "python.d.plugin",
19103
- "module_name": "puppet",
19104
- "monitored_instance": {
19105
- "name": "Puppet",
19106
- "link": "https://www.puppet.com/",
19107
- "categories": [
19108
- "data-collection.ci-cd-systems"
19109
- ],
19110
- "icon_filename": "puppet.svg"
19111
- },
19112
- "related_resources": {
19113
- "integrations": {
19114
- "list": []
19115
- }
19116
- },
19117
- "info_provided_to_referring_integrations": {
19118
- "description": ""
19119
- },
19120
- "keywords": [
19121
- "puppet",
19122
- "jvm heap"
19123
- ],
19124
- "most_popular": false
19125
- },
19126
- "overview": "# Puppet\n\nPlugin: python.d.plugin\nModule: puppet\n\n## Overview\n\nThis collector monitors Puppet metrics about JVM Heap, Non-Heap, CPU usage and file descriptors.'\n\n\nIt uses Puppet's metrics API endpoint to gather the metrics.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, this collector will use `https://fqdn.example.com:8140` as the URL to look for metrics.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
19127
- "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/puppet.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config python.d/puppet.conf\n```\n#### Options\n\nThis particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.\n\nThere are 2 sections:\n\n* Global variables\n* One or more JOBS that can define multiple different instances to monitor.\n\nThe following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.\n\nAdditionally, the following collapsed table contains all the options that can be configured inside a JOB definition.\n\nEvery configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.\n\n> Notes:\n> - Exact Fully Qualified Domain Name of the node should be used.\n> - Usually Puppet Server/DB startup time is VERY long. So, there should be quite reasonable retry count.\n> - A secured PuppetDB config may require a client certificate. This does not apply to the default PuppetDB configuration though.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| url | HTTP or HTTPS URL, exact Fully Qualified Domain Name of the node should be used. | https://fqdn.example.com:8081 | yes |\n| tls_verify | Control HTTPS server certificate verification. | False | no |\n| tls_ca_file | Optional CA (bundle) file to use | | no |\n| tls_cert_file | Optional client certificate file | | no |\n| tls_key_file | Optional client key file | | no |\n| update_every | Sets the default data collection frequency. | 30 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration\n\n```yaml\npuppetserver:\n url: 'https://fqdn.example.com:8140'\n autodetection_retry: 1\n\n```\n##### TLS Certificate\n\nAn example using a TLS certificate\n\n{% details open=true summary=\"Config\" %}\n```yaml\npuppetdb:\n url: 'https://fqdn.example.com:8081'\n tls_cert_file: /path/to/client.crt\n tls_key_file: /path/to/client.key\n autodetection_retry: 1\n\n```\n{% /details %}\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n{% details open=true summary=\"Config\" %}\n```yaml\npuppetserver1:\n url: 'https://fqdn.example.com:8140'\n autodetection_retry: 1\n\npuppetserver2:\n url: 'https://fqdn.example2.com:8140'\n autodetection_retry: 1\n\n```\n{% /details %}\n",
19128
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `puppet` collector, run the `python.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `python.d.plugin` to debug the collector:\n\n ```bash\n ./python.d.plugin puppet debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `puppet` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep puppet\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep puppet /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep puppet\n```\n\n",
19129
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19130
- "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Puppet instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| puppet.jvm_heap | committed, used | MiB |\n| puppet.jvm_nonheap | committed, used | MiB |\n| puppet.cpu | execution, GC | percentage |\n| puppet.fdopen | used | descriptors |\n\n",
19131
- "integration_type": "collector",
19132
- "id": "python.d.plugin-puppet-Puppet",
19133
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/puppet/metadata.yaml",
19134
- "related_resources": ""
19135
- },
19136
{
19137
"meta": {
19138
"plugin_name": "python.d.plugin",
integrations/integrations.json
+36
-36
@@ -15823,6 +15823,42 @@
15823
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/pulsar/metadata.yaml",
15824
"related_resources": ""
15825
},
15826
+ {
15827
+ "meta": {
15828
+ "id": "collector-go.d.plugin-puppet",
15829
+ "plugin_name": "go.d.plugin",
15830
+ "module_name": "puppet",
15831
+ "monitored_instance": {
15832
+ "name": "Puppet",
15833
+ "link": "https://www.puppet.com/",
15834
+ "categories": [
15835
+ "data-collection.ci-cd-systems"
15836
+ ],
15837
+ "icon_filename": "puppet.svg"
15838
+ },
15839
+ "related_resources": {
15840
+ "integrations": {
15841
+ "list": []
15842
+ }
15843
+ },
15844
+ "info_provided_to_referring_integrations": {
15845
+ "description": ""
15846
+ },
15847
+ "keywords": [
15848
+ "puppet"
15849
+ ],
15850
+ "most_popular": false
15851
+ },
15852
+ "overview": "# Puppet\n\nPlugin: go.d.plugin\nModule: puppet\n\n## Overview\n\nThis collector monitors Puppet metrics, including JVM heap and non-heap memory, CPU usage, and file descriptors.\n\n\nIt uses Puppet's metrics API endpoint [/status/v1/services](https://www.puppet.com/docs/puppetserver/5.3/status-api/v1/services.html) to gather the metrics.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, it detects Puppet instances running on localhost that are listening on port 8140.\nOn startup, it tries to collect metrics from:\n\n- https://127.0.0.1:8140\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
15853
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/puppet.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/puppet.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| url | The base URL where the Puppet instance can be accessed. | https://127.0.0.1:8140 | yes |\n| timeout | HTTPS request timeout. | 1 | no |\n| username | Username for basic HTTPS authentication. | | no |\n| password | Password for basic HTTPS authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTPS authentication. | | no |\n| proxy_password | Password for proxy basic HTTPS authentication. | | no |\n| method | HTTPS request method. | POST | no |\n| body | HTTPS request body. | | no |\n| headers | HTTPS request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n#### Examples\n\n##### Basic with self-signed certificate\n\nPuppet with self-signed TLS certificate.\n\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:8140\n tls_skip_verify: yes\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:8140\n tls_skip_verify: yes\n\n - name: remote\n url: https://192.0.2.1:8140\n tls_skip_verify: yes\n\n```\n",
15854
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `puppet` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m puppet\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `puppet` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep puppet\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep puppet /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep puppet\n```\n\n",
15855
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15856
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Puppet instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| puppet.jvm_heap | committed, used | MiB |\n| puppet.jvm_nonheap | committed, used | MiB |\n| puppet.cpu | execution, GC | percentage |\n| puppet.fdopen | used | descriptors |\n\n",
15857
+ "integration_type": "collector",
15858
+ "id": "go.d.plugin-puppet-Puppet",
15859
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/puppet/metadata.yaml",
15860
+ "related_resources": ""
15861
+ },
15862
{
15863
"meta": {
15864
"id": "collector-go.d.plugin-rabbitmq",
@@ -19095,42 +19131,6 @@
19131
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/metadata.yaml",
19132
"related_resources": ""
19133
},
19098
- {
19099
- "meta": {
19100
- "plugin_name": "python.d.plugin",
19101
- "module_name": "puppet",
19102
- "monitored_instance": {
19103
- "name": "Puppet",
19104
- "link": "https://www.puppet.com/",
19105
- "categories": [
19106
- "data-collection.ci-cd-systems"
19107
- ],
19108
- "icon_filename": "puppet.svg"
19109
- },
19110
- "related_resources": {
19111
- "integrations": {
19112
- "list": []
19113
- }
19114
- },
19115
- "info_provided_to_referring_integrations": {
19116
- "description": ""
19117
- },
19118
- "keywords": [
19119
- "puppet",
19120
- "jvm heap"
19121
- ],
19122
- "most_popular": false
19123
- },
19124
- "overview": "# Puppet\n\nPlugin: python.d.plugin\nModule: puppet\n\n## Overview\n\nThis collector monitors Puppet metrics about JVM Heap, Non-Heap, CPU usage and file descriptors.'\n\n\nIt uses Puppet's metrics API endpoint to gather the metrics.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, this collector will use `https://fqdn.example.com:8140` as the URL to look for metrics.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
19125
- "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/puppet.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config python.d/puppet.conf\n```\n#### Options\n\nThis particular collector does not need further configuration to work if permissions are satisfied, but you can always customize it's data collection behavior.\n\nThere are 2 sections:\n\n* Global variables\n* One or more JOBS that can define multiple different instances to monitor.\n\nThe following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.\n\nAdditionally, the following collapsed table contains all the options that can be configured inside a JOB definition.\n\nEvery configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.\n\n> Notes:\n> - Exact Fully Qualified Domain Name of the node should be used.\n> - Usually Puppet Server/DB startup time is VERY long. So, there should be quite reasonable retry count.\n> - A secured PuppetDB config may require a client certificate. This does not apply to the default PuppetDB configuration though.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| url | HTTP or HTTPS URL, exact Fully Qualified Domain Name of the node should be used. | https://fqdn.example.com:8081 | yes |\n| tls_verify | Control HTTPS server certificate verification. | False | no |\n| tls_ca_file | Optional CA (bundle) file to use | | no |\n| tls_cert_file | Optional client certificate file | | no |\n| tls_key_file | Optional client key file | | no |\n| update_every | Sets the default data collection frequency. | 30 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n\n#### Examples\n\n##### Basic\n\nA basic example configuration\n\n```yaml\npuppetserver:\n url: 'https://fqdn.example.com:8140'\n autodetection_retry: 1\n\n```\n##### TLS Certificate\n\nAn example using a TLS certificate\n\n```yaml\npuppetdb:\n url: 'https://fqdn.example.com:8081'\n tls_cert_file: /path/to/client.crt\n tls_key_file: /path/to/client.key\n autodetection_retry: 1\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n```yaml\npuppetserver1:\n url: 'https://fqdn.example.com:8140'\n autodetection_retry: 1\n\npuppetserver2:\n url: 'https://fqdn.example2.com:8140'\n autodetection_retry: 1\n\n```\n",
19126
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `puppet` collector, run the `python.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `python.d.plugin` to debug the collector:\n\n ```bash\n ./python.d.plugin puppet debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `puppet` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep puppet\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep puppet /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep puppet\n```\n\n",
19127
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19128
- "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Puppet instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| puppet.jvm_heap | committed, used | MiB |\n| puppet.jvm_nonheap | committed, used | MiB |\n| puppet.cpu | execution, GC | percentage |\n| puppet.fdopen | used | descriptors |\n\n",
19129
- "integration_type": "collector",
19130
- "id": "python.d.plugin-puppet-Puppet",
19131
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/puppet/metadata.yaml",
19132
- "related_resources": ""
19133
- },
19134
{
19135
"meta": {
19136
"plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1
-1
@@ -109,7 +109,7 @@ If you don't see the app/service you'd like to monitor in this list:
109
110
- [Jenkins](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/jenkins.md)
111
112
-- [Puppet](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/puppet/integrations/puppet.md)
112
+- [Puppet](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/puppet/integrations/puppet.md)
113
114
### Cloud Provider Managed
115
src/go/plugin/go.d/modules/puppet/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/puppet.md
\ No newline at end of file
src/go/plugin/go.d/modules/puppet/integrations/puppet.md
new
+231
@@ -0,0 +1,231 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/puppet/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/puppet/metadata.yaml"
4
+sidebar_label: "Puppet"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/CICD Platforms"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# Puppet
12
+
13
+
14
+<img src="https://netdata.cloud/img/puppet.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: puppet
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors Puppet metrics, including JVM heap and non-heap memory, CPU usage, and file descriptors.
25
+
26
+
27
+It uses Puppet's metrics API endpoint [/status/v1/services](https://www.puppet.com/docs/puppetserver/5.3/status-api/v1/services.html) to gather the metrics.
28
+
29
+
30
+This collector is supported on all platforms.
31
+
32
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
33
+
34
+
35
+### Default Behavior
36
+
37
+#### Auto-Detection
38
+
39
+By default, it detects Puppet instances running on localhost that are listening on port 8140.
40
+On startup, it tries to collect metrics from:
41
+
42
+- https://127.0.0.1:8140
43
+
44
+
45
+#### Limits
46
+
47
+The default configuration for this integration does not impose any limits on data collection.
48
+
49
+#### Performance Impact
50
+
51
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
52
+
53
+
54
+## Metrics
55
+
56
+Metrics grouped by *scope*.
57
+
58
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
59
+
60
+
61
+
62
+### Per Puppet instance
63
+
64
+These metrics refer to the entire monitored application.
65
+
66
+This scope has no labels.
67
+
68
+Metrics:
69
+
70
+| Metric | Dimensions | Unit |
71
+|:------|:----------|:----|
72
+| puppet.jvm_heap | committed, used | MiB |
73
+| puppet.jvm_nonheap | committed, used | MiB |
74
+| puppet.cpu | execution, GC | percentage |
75
+| puppet.fdopen | used | descriptors |
76
+
77
+
78
+
79
+## Alerts
80
+
81
+There are no alerts configured by default for this integration.
82
+
83
+
84
+## Setup
85
+
86
+### Prerequisites
87
+
88
+No action required.
89
+
90
+### Configuration
91
+
92
+#### File
93
+
94
+The configuration file name for this integration is `go.d/puppet.conf`.
95
+
96
+
97
+You can edit the configuration file using the `edit-config` script from the
98
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
99
+
100
+```bash
101
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
102
+sudo ./edit-config go.d/puppet.conf
103
+```
104
+#### Options
105
+
106
+The following options can be defined globally: update_every, autodetection_retry.
107
+
108
+
109
+<details open><summary></summary>
110
+
111
+| Name | Description | Default | Required |
112
+|:----|:-----------|:-------|:--------:|
113
+| url | The base URL where the Puppet instance can be accessed. | https://127.0.0.1:8140 | yes |
114
+| timeout | HTTPS request timeout. | 1 | no |
115
+| username | Username for basic HTTPS authentication. | | no |
116
+| password | Password for basic HTTPS authentication. | | no |
117
+| proxy_url | Proxy URL. | | no |
118
+| proxy_username | Username for proxy basic HTTPS authentication. | | no |
119
+| proxy_password | Password for proxy basic HTTPS authentication. | | no |
120
+| method | HTTPS request method. | POST | no |
121
+| body | HTTPS request body. | | no |
122
+| headers | HTTPS request headers. | | no |
123
+| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
124
+| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
125
+| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |
126
+| tls_cert | Client TLS certificate. | | no |
127
+| tls_key | Client TLS key. | | no |
128
+
129
+</details>
130
+
131
+#### Examples
132
+
133
+##### Basic with self-signed certificate
134
+
135
+Puppet with self-signed TLS certificate.
136
+
137
+<details open><summary>Config</summary>
138
+
139
+```yaml
140
+jobs:
141
+ - name: local
142
+ url: https://127.0.0.1:8140
143
+ tls_skip_verify: yes
144
+
145
+```
146
+</details>
147
+
148
+##### Multi-instance
149
+
150
+> **Note**: When you define multiple jobs, their names must be unique.
151
+
152
+Collecting metrics from local and remote instances.
153
+
154
+
155
+<details open><summary>Config</summary>
156
+
157
+```yaml
158
+jobs:
159
+ - name: local
160
+ url: https://127.0.0.1:8140
161
+ tls_skip_verify: yes
162
+
163
+ - name: remote
164
+ url: https://192.0.2.1:8140
165
+ tls_skip_verify: yes
166
+
167
+```
168
+</details>
169
+
170
+
171
+
172
+## Troubleshooting
173
+
174
+### Debug Mode
175
+
176
+To troubleshoot issues with the `puppet` collector, run the `go.d.plugin` with the debug option enabled. The output
177
+should give you clues as to why the collector isn't working.
178
+
179
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
180
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
181
+
182
+ ```bash
183
+ cd /usr/libexec/netdata/plugins.d/
184
+ ```
185
+
186
+- Switch to the `netdata` user.
187
+
188
+ ```bash
189
+ sudo -u netdata -s
190
+ ```
191
+
192
+- Run the `go.d.plugin` to debug the collector:
193
+
194
+ ```bash
195
+ ./go.d.plugin -d -m puppet
196
+ ```
197
+
198
+### Getting Logs
199
+
200
+If you're encountering problems with the `puppet` collector, follow these steps to retrieve logs and identify potential issues:
201
+
202
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
203
+- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
204
+
205
+#### System with systemd
206
+
207
+Use the following command to view logs generated since the last Netdata service restart:
208
+
209
+```bash
210
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep puppet
211
+```
212
+
213
+#### System without systemd
214
+
215
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
216
+
217
+```bash
218
+grep puppet /var/log/netdata/collector.log
219
+```
220
+
221
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
222
+
223
+#### Docker Container
224
+
225
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
226
+
227
+```bash
228
+docker logs netdata 2>&1 | grep puppet
229
+```
230
+
231
+