Regenerate integrations.js (#17505)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Apr 23, 2024 at 21:27 UTC
96b5d0fc8c2f3eea98fdf080d3a2266c13fe9234
6 files changed
+242
-80
integrations/cloud-authentication/integrations/okta_sso.md
+1
-1
@@ -46,6 +46,6 @@ Steps needed to be done on Okta Admin Portal:
46
47
### SP-initiated SSO
48
49
-If you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md).
49
+If you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).
50
51
integrations/integrations.js
+40
-39
@@ -3988,6 +3988,45 @@ export const integrations = [
3988
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/envoy/metadata.yaml",
3989
"related_resources": ""
3990
},
3991
+ {
3992
+ "meta": {
3993
+ "id": "collector-go.d.plugin-fail2ban",
3994
+ "plugin_name": "go.d.plugin",
3995
+ "module_name": "fail2ban",
3996
+ "monitored_instance": {
3997
+ "name": "Fail2ban",
3998
+ "link": "https://github.com/fail2ban/fail2ban#readme",
3999
+ "icon_filename": "fail2ban.png",
4000
+ "categories": [
4001
+ "data-collection.authentication-and-authorization"
4002
+ ]
4003
+ },
4004
+ "keywords": [
4005
+ "fail2ban",
4006
+ "security",
4007
+ "authentication",
4008
+ "authorization"
4009
+ ],
4010
+ "related_resources": {
4011
+ "integrations": {
4012
+ "list": []
4013
+ }
4014
+ },
4015
+ "info_provided_to_referring_integrations": {
4016
+ "description": ""
4017
+ },
4018
+ "most_popular": false
4019
+ },
4020
+ "overview": "# Fail2ban\n\nPlugin: go.d.plugin\nModule: fail2ban\n\n## Overview\n\nThis collector tracks two main metrics for each jail: currently banned IPs and active failure incidents. It relies on the [`fail2ban-client`](https://linux.die.net/man/1/fail2ban-client) CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\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",
4021
+ "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/fail2ban.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/fail2ban.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n{% details summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | fail2ban-client binary execution timeout. | 2 | no |\n\n{% /details %}\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: fail2ban\n update_every: 5 # Collect Fail2Ban jails statistics every 5 seconds\n\n```\n{% /details %}\n",
4022
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `fail2ban` 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 fail2ban\n ```\n\n",
4023
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
4024
+ "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 jail\n\nThese metrics refer to the Jail.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| jail | Jail's name |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| fail2ban.jail_banned_ips | banned | addresses |\n| fail2ban.jail_active_failures | active_failures | failures |\n\n",
4025
+ "integration_type": "collector",
4026
+ "id": "go.d.plugin-fail2ban-Fail2ban",
4027
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/fail2ban/metadata.yaml",
4028
+ "related_resources": ""
4029
+ },
4030
{
4031
"meta": {
4032
"id": "collector-go.d.plugin-filecheck",
@@ -18521,44 +18560,6 @@ export const integrations = [
18560
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/exim/metadata.yaml",
18561
"related_resources": ""
18562
},
18524
- {
18525
- "meta": {
18526
- "plugin_name": "python.d.plugin",
18527
- "module_name": "fail2ban",
18528
- "monitored_instance": {
18529
- "name": "Fail2ban",
18530
- "link": "https://www.fail2ban.org/",
18531
- "categories": [
18532
- "data-collection.authentication-and-authorization"
18533
- ],
18534
- "icon_filename": "fail2ban.png"
18535
- },
18536
- "related_resources": {
18537
- "integrations": {
18538
- "list": []
18539
- }
18540
- },
18541
- "info_provided_to_referring_integrations": {
18542
- "description": ""
18543
- },
18544
- "keywords": [
18545
- "fail2ban",
18546
- "security",
18547
- "authentication",
18548
- "authorization"
18549
- ],
18550
- "most_popular": false
18551
- },
18552
- "overview": "# Fail2ban\n\nPlugin: python.d.plugin\nModule: fail2ban\n\n## Overview\n\nMonitor Fail2ban performance for prime intrusion prevention operations. Monitor ban counts, jail statuses, and failed login attempts to ensure robust network security.\n\n\nIt collects metrics through reading the default log and configuration files of fail2ban.\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\nThe `fail2ban.log` file must be readable by the user `netdata`.\n - change the file ownership and access permissions.\n - update `/etc/logrotate.d/fail2ban`` to persist the changes after rotating the log file.\n\nTo change the file ownership and access permissions, execute the following:\n\n```shell\nsudo chown root:netdata /var/log/fail2ban.log\nsudo chmod 640 /var/log/fail2ban.log\n```\n\nTo persist the changes after rotating the log file, add `create 640 root netdata` to the `/etc/logrotate.d/fail2ban`:\n\n```shell\n/var/log/fail2ban.log {\n\n weekly\n rotate 4\n compress\n\n delaycompress\n missingok\n postrotate\n fail2ban-client flushlogs 1>/dev/null\n endscript\n\n # If fail2ban runs as non-root it still needs to have write access\n # to logfiles.\n # create 640 fail2ban adm\n create 640 root netdata\n}\n```\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default the collector will attempt to read log file at /var/log/fail2ban.log and conf file at /etc/fail2ban/jail.local.\nIf conf file is not found default jail is ssh.\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",
18553
- "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/fail2ban.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config python.d/fail2ban.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.\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\n{% details summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| log_path | path to fail2ban.log. | /var/log/fail2ban.log | no |\n| conf_path | path to jail.local/jail.conf. | /etc/fail2ban/jail.local | no |\n| conf_dir | path to jail.d/. | /etc/fail2ban/jail.d/ | no |\n| exclude | jails you want to exclude from autodetection. | | no |\n| update_every | Sets the default data collection frequency. | 1 | 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\nlocal:\n log_path: '/var/log/fail2ban.log'\n conf_path: '/etc/fail2ban/jail.local'\n\n```\n",
18554
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `fail2ban` 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 fail2ban debug trace\n ```\n\n### Debug Mode\n\n\n\n",
18555
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
18556
- "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 Fail2ban instance\n\nThese metrics refer to the entire monitored application.\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| fail2ban.failed_attempts | a dimension per jail | attempts/s |\n| fail2ban.bans | a dimension per jail | bans/s |\n| fail2ban.banned_ips | a dimension per jail | ips |\n\n",
18557
- "integration_type": "collector",
18558
- "id": "python.d.plugin-fail2ban-Fail2ban",
18559
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/fail2ban/metadata.yaml",
18560
- "related_resources": ""
18561
- },
18563
{
18564
"meta": {
18565
"plugin_name": "python.d.plugin",
@@ -22279,7 +22280,7 @@ export const integrations = [
22280
"okta-sso"
22281
],
22282
"overview": "# Okta SSO\n\nIntegrate your organization's Okta account with Netdata to better manage your team's access controls to Netdata Cloud.\n",
22282
- "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n",
22283
+ "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n### SP-initiated SSO\n\nIf you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).\n\n",
22284
"integration_type": "authentication",
22285
"edit_link": "https://github.com/netdata/netdata/blob/master/integrations/cloud-authentication/metadata.yaml",
22286
"troubleshooting": ""
integrations/integrations.json
+40
-39
@@ -3986,6 +3986,45 @@
3986
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/envoy/metadata.yaml",
3987
"related_resources": ""
3988
},
3989
+ {
3990
+ "meta": {
3991
+ "id": "collector-go.d.plugin-fail2ban",
3992
+ "plugin_name": "go.d.plugin",
3993
+ "module_name": "fail2ban",
3994
+ "monitored_instance": {
3995
+ "name": "Fail2ban",
3996
+ "link": "https://github.com/fail2ban/fail2ban#readme",
3997
+ "icon_filename": "fail2ban.png",
3998
+ "categories": [
3999
+ "data-collection.authentication-and-authorization"
4000
+ ]
4001
+ },
4002
+ "keywords": [
4003
+ "fail2ban",
4004
+ "security",
4005
+ "authentication",
4006
+ "authorization"
4007
+ ],
4008
+ "related_resources": {
4009
+ "integrations": {
4010
+ "list": []
4011
+ }
4012
+ },
4013
+ "info_provided_to_referring_integrations": {
4014
+ "description": ""
4015
+ },
4016
+ "most_popular": false
4017
+ },
4018
+ "overview": "# Fail2ban\n\nPlugin: go.d.plugin\nModule: fail2ban\n\n## Overview\n\nThis collector tracks two main metrics for each jail: currently banned IPs and active failure incidents. It relies on the [`fail2ban-client`](https://linux.die.net/man/1/fail2ban-client) CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\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",
4019
+ "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/fail2ban.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/fail2ban.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | fail2ban-client binary execution timeout. | 2 | no |\n\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n```yaml\njobs:\n - name: fail2ban\n update_every: 5 # Collect Fail2Ban jails statistics every 5 seconds\n\n```\n",
4020
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `fail2ban` 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 fail2ban\n ```\n\n",
4021
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
4022
+ "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 jail\n\nThese metrics refer to the Jail.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| jail | Jail's name |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| fail2ban.jail_banned_ips | banned | addresses |\n| fail2ban.jail_active_failures | active_failures | failures |\n\n",
4023
+ "integration_type": "collector",
4024
+ "id": "go.d.plugin-fail2ban-Fail2ban",
4025
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/fail2ban/metadata.yaml",
4026
+ "related_resources": ""
4027
+ },
4028
{
4029
"meta": {
4030
"id": "collector-go.d.plugin-filecheck",
@@ -18519,44 +18558,6 @@
18558
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/exim/metadata.yaml",
18559
"related_resources": ""
18560
},
18522
- {
18523
- "meta": {
18524
- "plugin_name": "python.d.plugin",
18525
- "module_name": "fail2ban",
18526
- "monitored_instance": {
18527
- "name": "Fail2ban",
18528
- "link": "https://www.fail2ban.org/",
18529
- "categories": [
18530
- "data-collection.authentication-and-authorization"
18531
- ],
18532
- "icon_filename": "fail2ban.png"
18533
- },
18534
- "related_resources": {
18535
- "integrations": {
18536
- "list": []
18537
- }
18538
- },
18539
- "info_provided_to_referring_integrations": {
18540
- "description": ""
18541
- },
18542
- "keywords": [
18543
- "fail2ban",
18544
- "security",
18545
- "authentication",
18546
- "authorization"
18547
- ],
18548
- "most_popular": false
18549
- },
18550
- "overview": "# Fail2ban\n\nPlugin: python.d.plugin\nModule: fail2ban\n\n## Overview\n\nMonitor Fail2ban performance for prime intrusion prevention operations. Monitor ban counts, jail statuses, and failed login attempts to ensure robust network security.\n\n\nIt collects metrics through reading the default log and configuration files of fail2ban.\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\nThe `fail2ban.log` file must be readable by the user `netdata`.\n - change the file ownership and access permissions.\n - update `/etc/logrotate.d/fail2ban`` to persist the changes after rotating the log file.\n\nTo change the file ownership and access permissions, execute the following:\n\n```shell\nsudo chown root:netdata /var/log/fail2ban.log\nsudo chmod 640 /var/log/fail2ban.log\n```\n\nTo persist the changes after rotating the log file, add `create 640 root netdata` to the `/etc/logrotate.d/fail2ban`:\n\n```shell\n/var/log/fail2ban.log {\n\n weekly\n rotate 4\n compress\n\n delaycompress\n missingok\n postrotate\n fail2ban-client flushlogs 1>/dev/null\n endscript\n\n # If fail2ban runs as non-root it still needs to have write access\n # to logfiles.\n # create 640 fail2ban adm\n create 640 root netdata\n}\n```\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default the collector will attempt to read log file at /var/log/fail2ban.log and conf file at /etc/fail2ban/jail.local.\nIf conf file is not found default jail is ssh.\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",
18551
- "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/fail2ban.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config python.d/fail2ban.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.\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\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| log_path | path to fail2ban.log. | /var/log/fail2ban.log | no |\n| conf_path | path to jail.local/jail.conf. | /etc/fail2ban/jail.local | no |\n| conf_dir | path to jail.d/. | /etc/fail2ban/jail.d/ | no |\n| exclude | jails you want to exclude from autodetection. | | no |\n| update_every | Sets the default data collection frequency. | 1 | 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\nlocal:\n log_path: '/var/log/fail2ban.log'\n conf_path: '/etc/fail2ban/jail.local'\n\n```\n",
18552
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `fail2ban` 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 fail2ban debug trace\n ```\n\n### Debug Mode\n\n\n\n",
18553
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
18554
- "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 Fail2ban instance\n\nThese metrics refer to the entire monitored application.\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| fail2ban.failed_attempts | a dimension per jail | attempts/s |\n| fail2ban.bans | a dimension per jail | bans/s |\n| fail2ban.banned_ips | a dimension per jail | ips |\n\n",
18555
- "integration_type": "collector",
18556
- "id": "python.d.plugin-fail2ban-Fail2ban",
18557
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/fail2ban/metadata.yaml",
18558
- "related_resources": ""
18559
- },
18561
{
18562
"meta": {
18563
"plugin_name": "python.d.plugin",
@@ -22277,7 +22278,7 @@
22278
"okta-sso"
22279
],
22280
"overview": "# Okta SSO\n\nIntegrate your organization's Okta account with Netdata to better manage your team's access controls to Netdata Cloud.\n",
22280
- "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n",
22281
+ "setup": "## Setup\n\n### Prerequisites\n- An Okta account\n- A Netdata Cloud account\n- Access to the Space as an administrator\n- Space needs to be on the Business plan or higher\n\n### Setting up Okta\nSteps needed to be done on Okta Admin Portal:\n1. Click on **Applications** tab and choose to **Browse App Catalogue**\n2. Find Netdata's preconfigured app for easy setup and click **Add Integration**\n3. Give the app, that will be in your apps dashboard, the preferred **Application label** and click **Next** to move to the Sign-On options tab\n4. In the **Sign-On Options** all the values we expect are already filled and no additional data is required\n5. Click **Done**. You are able to go back and edit any fields later if need be\n6. Go to the **Assignments** tab and enter the People or Group assignments as per your organization\u2019s policies\n\n### Netdata Configuration Steps\n1. Click on the Space settings cog (located above your profile icon)\n2. Click on the **Authentication** tab\n3. On the Okta SSO card, click on **Configure**\n4. Fill in the [required credentials](https://developer.okta.com/docs/guides/find-your-app-credentials/main/), you get them from **Okta Admin Portal**:\n - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`\n - **Client ID** you can get it from **General** tab on application you configured on Okta\n - **Client Secret** you can get it from **General** tab on application you configured on Okta\n\n### SP-initiated SSO\n\nIf you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md#from-netdata-sign-up-page).\n\n",
22282
"integration_type": "authentication",
22283
"edit_link": "https://github.com/netdata/netdata/blob/master/integrations/cloud-authentication/metadata.yaml",
22284
"troubleshooting": ""
src/collectors/COLLECTORS.md
+1
-1
@@ -83,7 +83,7 @@ If you don't see the app/service you'd like to monitor in this list:
83
84
### Authentication and Authorization
85
86
-- [Fail2ban](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/fail2ban/integrations/fail2ban.md)
86
+- [Fail2ban](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/fail2ban/integrations/fail2ban.md)
87
88
- [FreeRADIUS](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/freeradius/integrations/freeradius.md)
89
src/go/collectors/go.d.plugin/modules/fail2ban/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/fail2ban.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/fail2ban/integrations/fail2ban.md
new
+159
@@ -0,0 +1,159 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/fail2ban/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/fail2ban/metadata.yaml"
4
+sidebar_label: "Fail2ban"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Authentication and Authorization"
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
+# Fail2ban
12
+
13
+
14
+<img src="https://netdata.cloud/img/fail2ban.png" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: fail2ban
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector tracks two main metrics for each jail: currently banned IPs and active failure incidents. It relies on the [`fail2ban-client`](https://linux.die.net/man/1/fail2ban-client) CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.
25
+
26
+
27
+
28
+
29
+This collector is supported on all platforms.
30
+
31
+This collector only supports collecting metrics from a single instance of this integration.
32
+
33
+
34
+### Default Behavior
35
+
36
+#### Auto-Detection
37
+
38
+This integration doesn't support auto-detection.
39
+
40
+#### Limits
41
+
42
+The default configuration for this integration does not impose any limits on data collection.
43
+
44
+#### Performance Impact
45
+
46
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
47
+
48
+
49
+## Metrics
50
+
51
+Metrics grouped by *scope*.
52
+
53
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
54
+
55
+
56
+
57
+### Per jail
58
+
59
+These metrics refer to the Jail.
60
+
61
+Labels:
62
+
63
+| Label | Description |
64
+|:-----------|:----------------|
65
+| jail | Jail's name |
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| fail2ban.jail_banned_ips | banned | addresses |
72
+| fail2ban.jail_active_failures | active_failures | failures |
73
+
74
+
75
+
76
+## Alerts
77
+
78
+There are no alerts configured by default for this integration.
79
+
80
+
81
+## Setup
82
+
83
+### Prerequisites
84
+
85
+No action required.
86
+
87
+### Configuration
88
+
89
+#### File
90
+
91
+The configuration file name for this integration is `go.d/fail2ban.conf`.
92
+
93
+
94
+You can edit the configuration file using the `edit-config` script from the
95
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
96
+
97
+```bash
98
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
99
+sudo ./edit-config go.d/fail2ban.conf
100
+```
101
+#### Options
102
+
103
+The following options can be defined globally: update_every.
104
+
105
+
106
+<details><summary>Config options</summary>
107
+
108
+| Name | Description | Default | Required |
109
+|:----|:-----------|:-------|:--------:|
110
+| update_every | Data collection frequency. | 10 | no |
111
+| timeout | fail2ban-client binary execution timeout. | 2 | no |
112
+
113
+</details>
114
+
115
+#### Examples
116
+
117
+##### Custom update_every
118
+
119
+Allows you to override the default data collection interval.
120
+
121
+<details><summary>Config</summary>
122
+
123
+```yaml
124
+jobs:
125
+ - name: fail2ban
126
+ update_every: 5 # Collect Fail2Ban jails statistics every 5 seconds
127
+
128
+```
129
+</details>
130
+
131
+
132
+
133
+## Troubleshooting
134
+
135
+### Debug Mode
136
+
137
+To troubleshoot issues with the `fail2ban` collector, run the `go.d.plugin` with the debug option enabled. The output
138
+should give you clues as to why the collector isn't working.
139
+
140
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
141
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
142
+
143
+ ```bash
144
+ cd /usr/libexec/netdata/plugins.d/
145
+ ```
146
+
147
+- Switch to the `netdata` user.
148
+
149
+ ```bash
150
+ sudo -u netdata -s
151
+ ```
152
+
153
+- Run the `go.d.plugin` to debug the collector:
154
+
155
+ ```bash
156
+ ./go.d.plugin -d -m fail2ban
157
+ ```
158
+
159
+