@cryptotaxi247 / netdata-1 / commits / 6aa13a430

Regenerate integrations.js (#18225)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>

Netdata bot committed Jul 24, 2024 at 18:52 UTC 6aa13a4307a0c9e30a8f6072eab63df28853dfbf

5 files changed +355 -81

integrations/integrations.js

+40 -40

@@ -16408,6 +16408,46 @@ export const integrations = [

16408 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tengine/metadata.yaml",

16409 "related_resources": ""

16410 },

16411 + {

16412 + "meta": {

16413 + "plugin_name": "go.d.plugin",

16414 + "module_name": "tomcat",

16415 + "monitored_instance": {

16416 + "name": "Tomcat",

16417 + "link": "https://tomcat.apache.org/",

16418 + "categories": [

16419 + "data-collection.web-servers-and-web-proxies"

16420 + ],

16421 + "icon_filename": "tomcat.svg"

16422 + },

16423 + "related_resources": {

16424 + "integrations": {

16425 + "list": []

16426 + }

16427 + },

16428 + "info_provided_to_referring_integrations": {

16429 + "description": ""

16430 + },

16431 + "keywords": [

16432 + "apache",

16433 + "tomcat",

16434 + "webserver",

16435 + "websocket",

16436 + "jakarta",

16437 + "javaEE"

16438 + ],

16439 + "most_popular": false

16440 + },

16441 + "overview": "# Tomcat\n\nPlugin: go.d.plugin\nModule: tomcat\n\n## Overview\n\nThis collector monitors Tomcat metrics about bandwidth, processing time, threads and more.\n\n\nIt parses the information provided by the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) HTTP endpoint.\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\nBy default, this Tomcat collector cannot access the server's status page. To enable data collection, you will need to configure access credentials with appropriate permissions.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nIf the Netdata agent and Tomcat are on the same host, the collector will attempt to connect to the Tomcat server's status page at `http://localhost:8080/manager/status?XML=true`.\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",

16442 + "setup": "## Setup\n\n### Prerequisites\n\n#### Access to Tomcat Status Endpoint\n\nThe Netdata agent needs read-only access to its status endpoint to collect data from the Tomcat server.\n\nYou can achieve this by creating a dedicated user named `netdata` with read-only permissions specifically for accessing the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) endpoint.\n\nOnce you've created the `netdata` user, you'll need to configure the username and password in the collector configuration file.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/tomcat.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/tomcat.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | http://127.0.0.1:8080 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | POST | no |\n| body | HTTP request body. | | no |\n| headers | HTTP 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\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8080\n username: John\n password: Doe\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{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8080\n username: admin1\n password: hackme1\n\n - name: remote\n url: http://192.0.2.1:8080\n username: admin2\n password: hackme2\n\n```\n{% /details %}\n",

16443 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `tomcat` 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 tomcat\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `tomcat` 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 tomcat\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 tomcat /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 tomcat\n```\n\n",

16444 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

16445 + "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 Tomcat 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| tomcat.jvm_memory_usage | free, used | bytes |\n\n### Per jvm memory pool\n\nThese metrics refer to the JVM memory pool.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| mempool_name | Memory Pool name. |\n| mempool_type | Memory Pool type. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| tomcat.jvm_mem_pool_memory_usage | commited, used, max | bytes |\n\n### Per connector\n\nThese metrics refer to the connector.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| connector_name | Connector name. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| tomcat.connector_requests | requests | requests/s |\n| tomcat.connector_bandwidth | received, sent | bytes/s |\n| tomcat.connector_requests_processing_time | processing_time | milliseconds |\n| tomcat.connector_errors | errors | errors/s |\n| tomcat.connector_request_threads | idle, busy | threads |\n\n",

16446 + "integration_type": "collector",

16447 + "id": "go.d.plugin-tomcat-Tomcat",

16448 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tomcat/metadata.yaml",

16449 + "related_resources": ""

16450 + },

16451 {

16452 "meta": {

16453 "id": "collector-go.d.plugin-traefik",

@@ -19354,46 +19394,6 @@ export const integrations = [

19394 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/squid/metadata.yaml",

19395 "related_resources": ""

19396 },

19357 - {

19358 - "meta": {

19359 - "plugin_name": "python.d.plugin",

19360 - "module_name": "tomcat",

19361 - "monitored_instance": {

19362 - "name": "Tomcat",

19363 - "link": "https://tomcat.apache.org/",

19364 - "categories": [

19365 - "data-collection.web-servers-and-web-proxies"

19366 - ],

19367 - "icon_filename": "tomcat.svg"

19368 - },

19369 - "related_resources": {

19370 - "integrations": {

19371 - "list": []

19372 - }

19373 - },

19374 - "info_provided_to_referring_integrations": {

19375 - "description": ""

19376 - },

19377 - "keywords": [

19378 - "apache",

19379 - "tomcat",

19380 - "webserver",

19381 - "websocket",

19382 - "jakarta",

19383 - "javaEE"

19384 - ],

19385 - "most_popular": false

19386 - },

19387 - "overview": "# Tomcat\n\nPlugin: python.d.plugin\nModule: tomcat\n\n## Overview\n\nThis collector monitors Tomcat metrics about bandwidth, processing time, threads and more.\n\n\nIt parses the information provided by the http endpoint of the `/manager/status` in XML format\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\nYou need to provide the username and the password, to access the webserver's status page. Create a seperate user with read only rights for this particular endpoint\n\n### Default Behavior\n\n#### Auto-Detection\n\nIf the Netdata Agent and the Tomcat webserver are in the same host, without configuration, module attempts to connect to http://localhost:8080/manager/status?XML=true, without any credentials. So it will probably fail.\n\n#### Limits\n\nThis module is not supporting SSL communication. If you want a Netdata Agent to monitor a Tomcat deployment, you shouldnt try to monitor it via public network (public internet). Credentials are passed by Netdata in an unsecure port\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",

19388 - "setup": "## Setup\n\n### Prerequisites\n\n#### Create a read-only `netdata` user, to monitor the `/status` endpoint.\n\nThis is necessary for configuring the collector.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/tomcat.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/tomcat.conf\n```\n#### Options\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.Additionally, 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\n{% details open=true summary=\"Config options per job\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Sets the default data collection frequency. | 5 | 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| url | The URL of the Tomcat server's status endpoint. Always add the suffix ?XML=true. | no | yes |\n| user | A valid user with read permission to access the /manager/status endpoint of the server. Required if the endpoint is password protected | no | no |\n| pass | A valid password for the user in question. Required if the endpoint is password protected | no | no |\n| connector_name | The connector component that communicates with a web connector via the AJP protocol, e.g ajp-bio-8009 | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration\n\n```yaml\nlocalhost:\n name : 'local'\n url : 'http://localhost:8080/manager/status?XML=true'\n\n```\n##### Using an IPv4 endpoint\n\nA typical configuration using an IPv4 endpoint\n\n{% details open=true summary=\"Config\" %}\n```yaml\nlocal_ipv4:\n name : 'local'\n url : 'http://127.0.0.1:8080/manager/status?XML=true'\n\n```\n{% /details %}\n##### Using an IPv6 endpoint\n\nA typical configuration using an IPv6 endpoint\n\n{% details open=true summary=\"Config\" %}\n```yaml\nlocal_ipv6:\n name : 'local'\n url : 'http://[::1]:8080/manager/status?XML=true'\n\n```\n{% /details %}\n",

19389 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `tomcat` 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 tomcat debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `tomcat` 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 tomcat\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 tomcat /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 tomcat\n```\n\n",

19390 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

19391 - "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 Tomcat 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| tomcat.accesses | accesses, errors | requests/s |\n| tomcat.bandwidth | sent, received | KiB/s |\n| tomcat.processing_time | processing time | seconds |\n| tomcat.threads | current, busy | current threads |\n| tomcat.jvm | free, eden, survivor, tenured, code cache, compressed, metaspace | MiB |\n| tomcat.jvm_eden | used, committed, max | MiB |\n| tomcat.jvm_survivor | used, committed, max | MiB |\n| tomcat.jvm_tenured | used, committed, max | MiB |\n\n",

19392 - "integration_type": "collector",

19393 - "id": "python.d.plugin-tomcat-Tomcat",

19394 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/tomcat/metadata.yaml",

19395 - "related_resources": ""

19396 - },

19397 {

19398 "meta": {

19399 "plugin_name": "python.d.plugin",

integrations/integrations.json

+40 -40

@@ -16406,6 +16406,46 @@

16406 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tengine/metadata.yaml",

16407 "related_resources": ""

16408 },

16409 + {

16410 + "meta": {

16411 + "plugin_name": "go.d.plugin",

16412 + "module_name": "tomcat",

16413 + "monitored_instance": {

16414 + "name": "Tomcat",

16415 + "link": "https://tomcat.apache.org/",

16416 + "categories": [

16417 + "data-collection.web-servers-and-web-proxies"

16418 + ],

16419 + "icon_filename": "tomcat.svg"

16420 + },

16421 + "related_resources": {

16422 + "integrations": {

16423 + "list": []

16424 + }

16425 + },

16426 + "info_provided_to_referring_integrations": {

16427 + "description": ""

16428 + },

16429 + "keywords": [

16430 + "apache",

16431 + "tomcat",

16432 + "webserver",

16433 + "websocket",

16434 + "jakarta",

16435 + "javaEE"

16436 + ],

16437 + "most_popular": false

16438 + },

16439 + "overview": "# Tomcat\n\nPlugin: go.d.plugin\nModule: tomcat\n\n## Overview\n\nThis collector monitors Tomcat metrics about bandwidth, processing time, threads and more.\n\n\nIt parses the information provided by the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) HTTP endpoint.\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\nBy default, this Tomcat collector cannot access the server's status page. To enable data collection, you will need to configure access credentials with appropriate permissions.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nIf the Netdata agent and Tomcat are on the same host, the collector will attempt to connect to the Tomcat server's status page at `http://localhost:8080/manager/status?XML=true`.\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",

16440 + "setup": "## Setup\n\n### Prerequisites\n\n#### Access to Tomcat Status Endpoint\n\nThe Netdata agent needs read-only access to its status endpoint to collect data from the Tomcat server.\n\nYou can achieve this by creating a dedicated user named `netdata` with read-only permissions specifically for accessing the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) endpoint.\n\nOnce you've created the `netdata` user, you'll need to configure the username and password in the collector configuration file.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/tomcat.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/tomcat.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| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | http://127.0.0.1:8080 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | POST | no |\n| body | HTTP request body. | | no |\n| headers | HTTP 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\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8080\n username: John\n password: Doe\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: http://127.0.0.1:8080\n username: admin1\n password: hackme1\n\n - name: remote\n url: http://192.0.2.1:8080\n username: admin2\n password: hackme2\n\n```\n",

16441 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `tomcat` 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 tomcat\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `tomcat` 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 tomcat\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 tomcat /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 tomcat\n```\n\n",

16442 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

16443 + "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 Tomcat 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| tomcat.jvm_memory_usage | free, used | bytes |\n\n### Per jvm memory pool\n\nThese metrics refer to the JVM memory pool.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| mempool_name | Memory Pool name. |\n| mempool_type | Memory Pool type. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| tomcat.jvm_mem_pool_memory_usage | commited, used, max | bytes |\n\n### Per connector\n\nThese metrics refer to the connector.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| connector_name | Connector name. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| tomcat.connector_requests | requests | requests/s |\n| tomcat.connector_bandwidth | received, sent | bytes/s |\n| tomcat.connector_requests_processing_time | processing_time | milliseconds |\n| tomcat.connector_errors | errors | errors/s |\n| tomcat.connector_request_threads | idle, busy | threads |\n\n",

16444 + "integration_type": "collector",

16445 + "id": "go.d.plugin-tomcat-Tomcat",

16446 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tomcat/metadata.yaml",

16447 + "related_resources": ""

16448 + },

16449 {

16450 "meta": {

16451 "id": "collector-go.d.plugin-traefik",

@@ -19352,46 +19392,6 @@

19392 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/squid/metadata.yaml",

19393 "related_resources": ""

19394 },

19355 - {

19356 - "meta": {

19357 - "plugin_name": "python.d.plugin",

19358 - "module_name": "tomcat",

19359 - "monitored_instance": {

19360 - "name": "Tomcat",

19361 - "link": "https://tomcat.apache.org/",

19362 - "categories": [

19363 - "data-collection.web-servers-and-web-proxies"

19364 - ],

19365 - "icon_filename": "tomcat.svg"

19366 - },

19367 - "related_resources": {

19368 - "integrations": {

19369 - "list": []

19370 - }

19371 - },

19372 - "info_provided_to_referring_integrations": {

19373 - "description": ""

19374 - },

19375 - "keywords": [

19376 - "apache",

19377 - "tomcat",

19378 - "webserver",

19379 - "websocket",

19380 - "jakarta",

19381 - "javaEE"

19382 - ],

19383 - "most_popular": false

19384 - },

19385 - "overview": "# Tomcat\n\nPlugin: python.d.plugin\nModule: tomcat\n\n## Overview\n\nThis collector monitors Tomcat metrics about bandwidth, processing time, threads and more.\n\n\nIt parses the information provided by the http endpoint of the `/manager/status` in XML format\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\nYou need to provide the username and the password, to access the webserver's status page. Create a seperate user with read only rights for this particular endpoint\n\n### Default Behavior\n\n#### Auto-Detection\n\nIf the Netdata Agent and the Tomcat webserver are in the same host, without configuration, module attempts to connect to http://localhost:8080/manager/status?XML=true, without any credentials. So it will probably fail.\n\n#### Limits\n\nThis module is not supporting SSL communication. If you want a Netdata Agent to monitor a Tomcat deployment, you shouldnt try to monitor it via public network (public internet). Credentials are passed by Netdata in an unsecure port\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",

19386 - "setup": "## Setup\n\n### Prerequisites\n\n#### Create a read-only `netdata` user, to monitor the `/status` endpoint.\n\nThis is necessary for configuring the collector.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/tomcat.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/tomcat.conf\n```\n#### Options\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.Additionally, 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\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Sets the default data collection frequency. | 5 | 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| url | The URL of the Tomcat server's status endpoint. Always add the suffix ?XML=true. | no | yes |\n| user | A valid user with read permission to access the /manager/status endpoint of the server. Required if the endpoint is password protected | no | no |\n| pass | A valid password for the user in question. Required if the endpoint is password protected | no | no |\n| connector_name | The connector component that communicates with a web connector via the AJP protocol, e.g ajp-bio-8009 | | no |\n\n#### Examples\n\n##### Basic\n\nA basic example configuration\n\n```yaml\nlocalhost:\n name : 'local'\n url : 'http://localhost:8080/manager/status?XML=true'\n\n```\n##### Using an IPv4 endpoint\n\nA typical configuration using an IPv4 endpoint\n\n```yaml\nlocal_ipv4:\n name : 'local'\n url : 'http://127.0.0.1:8080/manager/status?XML=true'\n\n```\n##### Using an IPv6 endpoint\n\nA typical configuration using an IPv6 endpoint\n\n```yaml\nlocal_ipv6:\n name : 'local'\n url : 'http://[::1]:8080/manager/status?XML=true'\n\n```\n",

19387 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `tomcat` 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 tomcat debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `tomcat` 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 tomcat\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 tomcat /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 tomcat\n```\n\n",

19388 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

19389 - "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 Tomcat 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| tomcat.accesses | accesses, errors | requests/s |\n| tomcat.bandwidth | sent, received | KiB/s |\n| tomcat.processing_time | processing time | seconds |\n| tomcat.threads | current, busy | current threads |\n| tomcat.jvm | free, eden, survivor, tenured, code cache, compressed, metaspace | MiB |\n| tomcat.jvm_eden | used, committed, max | MiB |\n| tomcat.jvm_survivor | used, committed, max | MiB |\n| tomcat.jvm_tenured | used, committed, max | MiB |\n\n",

19390 - "integration_type": "collector",

19391 - "id": "python.d.plugin-tomcat-Tomcat",

19392 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/tomcat/metadata.yaml",

19393 - "related_resources": ""

19394 - },

19395 {

19396 "meta": {

19397 "plugin_name": "python.d.plugin",

src/collectors/COLLECTORS.md

+1 -1

@@ -1155,7 +1155,7 @@ If you don't see the app/service you'd like to monitor in this list:

1155

1156 - [Tengine](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tengine/integrations/tengine.md)

1157

1158 -- [Tomcat](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/tomcat/integrations/tomcat.md)

1158 +- [Tomcat](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tomcat/integrations/tomcat.md)

1159

1160 - [Traefik](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/traefik/integrations/traefik.md)

1161

src/go/plugin/go.d/modules/tomcat/README.md new

@@ -0,0 +1 @@

1 +integrations/tomcat.md

\ No newline at end of file

src/go/plugin/go.d/modules/tomcat/integrations/tomcat.md new

+273

@@ -0,0 +1,273 @@

1 +<!--startmeta

2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/tomcat/README.md"

3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/tomcat/metadata.yaml"

4 +sidebar_label: "Tomcat"

5 +learn_status: "Published"

6 +learn_rel_path: "Collecting Metrics/Web Servers and Web Proxies"

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 +# Tomcat

12 +

13 +

14 +<img src="https://netdata.cloud/img/tomcat.svg" width="150"/>

15 +

16 +

17 +Plugin: go.d.plugin

18 +Module: tomcat

19 +

20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

21 +

22 +## Overview

23 +

24 +This collector monitors Tomcat metrics about bandwidth, processing time, threads and more.

25 +

26 +

27 +It parses the information provided by the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) HTTP endpoint.

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 +By default, this Tomcat collector cannot access the server's status page. To enable data collection, you will need to configure access credentials with appropriate permissions.

35 +

36 +

37 +### Default Behavior

38 +

39 +#### Auto-Detection

40 +

41 +If the Netdata agent and Tomcat are on the same host, the collector will attempt to connect to the Tomcat server's status page at `http://localhost:8080/manager/status?XML=true`.

42 +

43 +

44 +#### Limits

45 +

46 +The default configuration for this integration does not impose any limits on data collection.

47 +

48 +#### Performance Impact

49 +

50 +The default configuration for this integration is not expected to impose a significant performance impact on the system.

51 +

52 +

53 +## Metrics

54 +

55 +Metrics grouped by *scope*.

56 +

57 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

58 +

59 +

60 +

61 +### Per Tomcat instance

62 +

63 +These metrics refer to the entire monitored application.

64 +

65 +This scope has no labels.

66 +

67 +Metrics:

68 +

69 +| Metric | Dimensions | Unit |

70 +|:------|:----------|:----|

71 +| tomcat.jvm_memory_usage | free, used | bytes |

72 +

73 +### Per jvm memory pool

74 +

75 +These metrics refer to the JVM memory pool.

76 +

77 +Labels:

78 +

79 +| Label | Description |

80 +|:-----------|:----------------|

81 +| mempool_name | Memory Pool name. |

82 +| mempool_type | Memory Pool type. |

83 +

84 +Metrics:

85 +

86 +| Metric | Dimensions | Unit |

87 +|:------|:----------|:----|

88 +| tomcat.jvm_mem_pool_memory_usage | commited, used, max | bytes |

89 +

90 +### Per connector

91 +

92 +These metrics refer to the connector.

93 +

94 +Labels:

95 +

96 +| Label | Description |

97 +|:-----------|:----------------|

98 +| connector_name | Connector name. |

99 +

100 +Metrics:

101 +

102 +| Metric | Dimensions | Unit |

103 +|:------|:----------|:----|

104 +| tomcat.connector_requests | requests | requests/s |

105 +| tomcat.connector_bandwidth | received, sent | bytes/s |

106 +| tomcat.connector_requests_processing_time | processing_time | milliseconds |

107 +| tomcat.connector_errors | errors | errors/s |

108 +| tomcat.connector_request_threads | idle, busy | threads |

109 +

110 +

111 +

112 +## Alerts

113 +

114 +There are no alerts configured by default for this integration.

115 +

116 +

117 +## Setup

118 +

119 +### Prerequisites

120 +

121 +#### Access to Tomcat Status Endpoint

122 +

123 +The Netdata agent needs read-only access to its status endpoint to collect data from the Tomcat server.

124 +

125 +You can achieve this by creating a dedicated user named `netdata` with read-only permissions specifically for accessing the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) endpoint.

126 +

127 +Once you've created the `netdata` user, you'll need to configure the username and password in the collector configuration file.

128 +

129 +

130 +

131 +### Configuration

132 +

133 +#### File

134 +

135 +The configuration file name for this integration is `go.d/tomcat.conf`.

136 +

137 +

138 +You can edit the configuration file using the `edit-config` script from the

139 +Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).

140 +

141 +```bash

142 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata

143 +sudo ./edit-config go.d/tomcat.conf

144 +```

145 +#### Options

146 +

147 +The following options can be defined globally: update_every, autodetection_retry.

148 +

149 +

150 +<details open><summary>Config options</summary>

151 +

153 +|:----|:-----------|:-------|:--------:|

154 +| update_every | Data collection frequency. | 1 | no |

155 +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |

156 +| url | Server URL. | http://127.0.0.1:8080 | yes |

157 +| timeout | HTTP request timeout. | 1 | no |

158 +| username | Username for basic HTTP authentication. | | no |

159 +| password | Password for basic HTTP authentication. | | no |

160 +| proxy_url | Proxy URL. | | no |

161 +| proxy_username | Username for proxy basic HTTP authentication. | | no |

162 +| proxy_password | Password for proxy basic HTTP authentication. | | no |

164 +| body | HTTP request body. | | no |

165 +| headers | HTTP request headers. | | no |

166 +| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |

167 +| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |

168 +| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |

169 +| tls_cert | Client TLS certificate. | | no |

170 +| tls_key | Client TLS key. | | no |

171 +

172 +</details>

173 +

174 +#### Examples

175 +

176 +##### Basic

177 +

178 +A basic example configuration.

179 +

180 +```yaml

181 +jobs:

182 + - name: local

183 + url: http://127.0.0.1:8080

184 + username: John

185 + password: Doe

186 +

187 +```

188 +##### Multi-instance

189 +

190 +> **Note**: When you define multiple jobs, their names must be unique.

191 +

192 +Collecting metrics from local and remote instances.

193 +

194 +

195 +<details open><summary>Config</summary>

196 +

197 +```yaml

198 +jobs:

199 + - name: local

200 + url: http://127.0.0.1:8080

201 + username: admin1

202 + password: hackme1

203 +

204 + - name: remote

205 + url: http://192.0.2.1:8080

206 + username: admin2

207 + password: hackme2

208 +

209 +```

210 +</details>

211 +

212 +

213 +

214 +## Troubleshooting

215 +

216 +### Debug Mode

217 +

218 +To troubleshoot issues with the `tomcat` collector, run the `go.d.plugin` with the debug option enabled. The output

219 +should give you clues as to why the collector isn't working.

220 +

221 +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on

222 + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.

223 +

224 + ```bash

225 + cd /usr/libexec/netdata/plugins.d/

226 + ```

227 +

228 +- Switch to the `netdata` user.

229 +

230 + ```bash

231 + sudo -u netdata -s

232 + ```

233 +

234 +- Run the `go.d.plugin` to debug the collector:

235 +

236 + ```bash

237 + ./go.d.plugin -d -m tomcat

238 + ```

239 +

240 +### Getting Logs

241 +

242 +If you're encountering problems with the `tomcat` collector, follow these steps to retrieve logs and identify potential issues:

243 +

244 +- **Run the command** specific to your system (systemd, non-systemd, or Docker container).

245 +- **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.

246 +

247 +#### System with systemd

248 +

249 +Use the following command to view logs generated since the last Netdata service restart:

250 +

251 +```bash

252 +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep tomcat

253 +```

254 +

255 +#### System without systemd

256 +

257 +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:

258 +

259 +```bash

260 +grep tomcat /var/log/netdata/collector.log

261 +```

262 +

263 +**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.

264 +

265 +#### Docker Container

266 +

267 +If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

268 +

269 +```bash

270 +docker logs netdata 2>&1 | grep tomcat

271 +```

272 +

273 +