@cryptotaxi247 / netdata-1 / commits / c361ca405

Regenerate integrations.js (#17748)

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

Netdata bot committed May 24, 2024 at 16:54 UTC c361ca40590e98de88f028f384099e20d72b10c7
6 files changed +389 -362
integrations/integrations.js
+36 -35
@@ -3405,6 +3405,42 @@ export const integrations = [
3405 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/chrony/metadata.yaml",
3406 "related_resources": ""
3407 },
3408 + {
3409 + "meta": {
3410 + "id": "collector-go.d.plugin-clickhouse",
3411 + "plugin_name": "go.d.plugin",
3412 + "module_name": "clickhouse",
3413 + "monitored_instance": {
3414 + "name": "ClickHouse",
3415 + "link": "https://clickhouse.com/",
3416 + "icon_filename": "clickhouse.svg",
3417 + "categories": [
3418 + "data-collection.database-servers"
3419 + ]
3420 + },
3421 + "keywords": [
3422 + "database"
3423 + ],
3424 + "related_resources": {
3425 + "integrations": {
3426 + "list": []
3427 + }
3428 + },
3429 + "info_provided_to_referring_integrations": {
3430 + "description": ""
3431 + },
3432 + "most_popular": false
3433 + },
3434 + "overview": "# ClickHouse\n\nPlugin: go.d.plugin\nModule: clickhouse\n\n## Overview\n\nThis collector retrieves performance data from ClickHouse for connections, queries, resources, replication, IO, and data operations (inserts, selects, merges) using HTTP requests and ClickHouse system tables. It monitors your ClickHouse server's health and activity.\n\n\nIt sends HTTP requests to the ClickHouse [HTTP interface](https://clickhouse.com/docs/en/interfaces/http), executing SELECT queries to retrieve data from various system tables.\nSpecifically, it collects metrics from the following tables:\n\n- system.metrics\n- systemd.async_metrics\n- system.events\n- system.disks\n- system.parts\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 ClickHouse instances running on localhost that are listening on port 8123.\nOn startup, it tries to collect metrics from:\n\n- http://127.0.0.1:8123\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",
3435 + "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/clickhouse.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/clickhouse.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details 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:8123 | 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. | GET | 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:8123\n\n```\n##### HTTP authentication\n\nBasic HTTP authentication.\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8123\n username: username\n password: password\n\n```\n{% /details %}\n##### HTTPS with self-signed certificate\n\nClickHouse with enabled HTTPS and self-signed certificate.\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:8123\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 summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8123\n\n - name: remote\n url: http://192.0.2.1:8123\n\n```\n{% /details %}\n",
3436 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `clickhouse` 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 clickhouse\n ```\n\n",
3437 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
3438 + "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 ClickHouse 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| clickhouse.connections | tcp, http, mysql, postgresql, interserver | connections |\n| clickhouse.slow_reads | slow | reads/s |\n| clickhouse.read_backoff | read_backoff | events/s |\n| clickhouse.memory_usage | used | bytes |\n| clickhouse.queries | successful, failed | queries/s |\n| clickhouse.select_queries | successful, failed | selects/s |\n| clickhouse.insert_queries | successful, failed | inserts/s |\n| clickhouse.queries_preempted | preempted | queries |\n| clickhouse.queries_memory_limit_exceeded | mem_limit_exceeded | queries/s |\n| clickhouse.queries_latency | queries_time | microseconds |\n| clickhouse.select_queries_latency | selects_time | microseconds |\n| clickhouse.insert_queries_latency | inserts_time | microseconds |\n| clickhouse.io | reads, writes | bytes/s |\n| clickhouse.iops | reads, writes | ops/s |\n| clickhouse.io_errors | read, write | errors/s |\n| clickhouse.io_seeks | lseek | ops/s |\n| clickhouse.io_file_opens | file_open | ops/s |\n| clickhouse.replicated_parts_current_activity | fetch, send, check | parts |\n| clickhouse.replicated_readonly_tables | read_only | tables |\n| clickhouse.replicated_data_loss | data_loss | events |\n| clickhouse.replicated_part_fetches | successful, failed | fetches/s |\n| clickhouse.inserted_rows | inserted | rows/s |\n| clickhouse.inserted_bytes | inserted | bytes/s |\n| clickhouse.rejected_inserts | rejected | inserts/s |\n| clickhouse.delayed_inserts | delayed | inserts/s |\n| clickhouse.delayed_inserts_throttle_time | delayed_inserts_throttle_time | milliseconds |\n| clickhouse.selected_bytes | selected | bytes/s |\n| clickhouse.selected_rows | selected | rows/s |\n| clickhouse.selected_parts | selected | parts/s |\n| clickhouse.selected_ranges | selected | ranges/s |\n| clickhouse.selected_marks | selected | marks/s |\n| clickhouse.merges | merge | ops/s |\n| clickhouse.merges_latency | merges_time | milliseconds |\n| clickhouse.merged_uncompressed_bytes | merged_uncompressed | bytes/s |\n| clickhouse.merged_rows | merged | rows/s |\n| clickhouse.merge_tree_data_writer_inserted_rows | inserted | rows/s |\n| clickhouse.merge_tree_data_writer_uncompressed_bytes | inserted | bytes/s |\n| clickhouse.merge_tree_data_writer_compressed_bytes | written | bytes/s |\n| clickhouse.uncompressed_cache_requests | hits, misses | requests/s |\n| clickhouse.mark_cache_requests | hits, misses | requests/s |\n| clickhouse.parts_count | temporary, pre_active, active, deleting, delete_on_destroy, outdated, wide, compact | parts |\n| distributed_connections | active | connections |\n| distributed_connections_attempts | connection | attempts/s |\n| distributed_connections_fail_retries | connection_retry | fails/s |\n| distributed_connections_fail_exhausted_retries | connection_retry_exhausted | fails/s |\n| distributed_files_to_insert | pending_insertions | files |\n| distributed_rejected_inserts | rejected | inserts/s |\n| distributed_delayed_inserts | delayed | inserts/s |\n| distributed_delayed_inserts_latency | delayed_time | milliseconds |\n| distributed_sync_insertion_timeout_exceeded | sync_insertion | timeouts/s |\n| distributed_async_insertions_failures | async_insertions | failures/s |\n| clickhouse.uptime | uptime | seconds |\n\n### Per disk\n\nThese metrics refer to the Disk.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| disk_name | Name of the disk as defined in the [server configuration](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#table_engine-mergetree-multiple-volumes_configure). |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| clickhouse.disk_space_usage | free, used | bytes |\n\n### Per table\n\nThese metrics refer to the Database Table.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| database | Name of the database. |\n| table | Name of the table. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| clickhouse.database_table_size | size | bytes |\n| clickhouse.database_table_parts | parts | parts |\n| clickhouse.database_table_parts | parts | parts |\n| clickhouse.database_table_rows | rows | rows |\n\n",
3439 + "integration_type": "collector",
3440 + "id": "go.d.plugin-clickhouse-ClickHouse",
3441 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/clickhouse/metadata.yaml",
3442 + "related_resources": ""
3443 + },
3444 {
3445 "meta": {
3446 "id": "collector-go.d.plugin-cockroachdb",
@@ -7793,41 +7829,6 @@ export const integrations = [
7829 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/metadata.yaml",
7830 "related_resources": ""
7831 },
7796 - {
7797 - "meta": {
7798 - "id": "collector-go.d.plugin-prometheus-clickhouse",
7799 - "module_name": "prometheus",
7800 - "plugin_name": "go.d.plugin",
7801 - "monitored_instance": {
7802 - "name": "ClickHouse",
7803 - "link": "https://github.com/ClickHouse/ClickHouse",
7804 - "icon_filename": "clickhouse.svg",
7805 - "categories": [
7806 - "data-collection.database-servers"
7807 - ]
7808 - },
7809 - "keywords": [],
7810 - "related_resources": {
7811 - "integrations": {
7812 - "list": []
7813 - }
7814 - },
7815 - "info_provided_to_referring_integrations": {
7816 - "description": ""
7817 - },
7818 - "most_popular": false,
7819 - "community": true
7820 - },
7821 - "overview": "# ClickHouse\n\nPlugin: go.d.plugin\nModule: prometheus\n\n## Overview\n\nMonitor ClickHouse database metrics for efficient data storage and query performance.\n\n\nMetrics are gathered by periodically sending HTTP requests to the ClickHouse built-in Prometheus exporter.\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 instances running on the local host by trying to connect to known ports that are [allocated to exporters](https://github.com/prometheus/prometheus/wiki/Default-port-allocations).\nThe full list of endpoints is available in the collector's [configuration file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/prometheus.conf).\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",
7822 - "setup": "## Setup\n\n### Prerequisites\n\n#### Configure built-in Prometheus exporter\n\nTo configure the built-in Prometheus exporter, follow the [official documentation](https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#server_configuration_parameters-prometheus).\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/prometheus.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/prometheus.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | | yes |\n| selector | Time series selector (filter). | | no |\n| fallback_type | Time series selector (filter). | | no |\n| max_time_series | Global time series limit. If an endpoint returns number of time series > limit the data is not processed. | 2000 | no |\n| max_time_series_per_metric | Time series per metric (metric name) limit. Metrics with number of time series > limit are skipped. | 200 | no |\n| timeout | HTTP request timeout. | 10 | 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. | GET | 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##### selector\n\nThis option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.\n\n- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)\n- Pattern syntax: [selector](/src/go/collectors/go.d.plugin/pkg/prometheus/selector/README.md).\n- Option syntax:\n\n```yaml\nselector:\n allow:\n - pattern1\n - pattern2\n deny:\n - pattern3\n - pattern4\n```\n\n\n##### fallback_type\n\nThis option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.\n\n- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).\n- Option syntax:\n\n```yaml\nfallback_type:\n counter:\n - metric_name_pattern1\n - metric_name_pattern2\n gauge:\n - metric_name_pattern3\n - metric_name_pattern4\n```\n\n\n{% /details %}\n#### Examples\n\n##### Basic\n\n> **Note**: Change the port of the monitored application on which it provides metrics.\n\nA basic example configuration.\n\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:9090/metrics\n\n```\n##### Read metrics from a file\n\nAn example configuration to read metrics from a file.\n\n{% details summary=\"Config\" %}\n```yaml\n# use \"file://\" scheme\njobs:\n - name: myapp\n url: file:///opt/metrics/myapp/metrics.txt\n\n```\n{% /details %}\n##### HTTP authentication\n\n> **Note**: Change the port of the monitored application on which it provides metrics.\n\nBasic HTTP authentication.\n\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:9090/metrics\n username: username\n password: password\n\n```\n{% /details %}\n##### HTTPS with self-signed certificate\n\n> **Note**: Change the port of the monitored application on which it provides metrics.\n\nDo not validate server certificate chain and hostname.\n\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:9090/metrics\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> **Note**: Change the port of the monitored application on which it provides metrics.\n\nCollecting metrics from local and remote instances.\n\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:9090/metrics\n\n - name: remote\n url: http://192.0.2.1:9090/metrics\n\n```\n{% /details %}\n",
7823 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `prometheus` 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 prometheus\n ```\n\n",
7824 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
7825 - "metrics": "## Metrics\n\nThis collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).\n\n| Metric | Chart | Dimension(s) | Algorithm |\n|---------------------------|-------------------------------------------|----------------------|-------------|\n| Gauge | for each label set | one, the metric name | absolute |\n| Counter | for each label set | one, the metric name | incremental |\n| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |\n| Summary (sum and count) | for each label set | the metric name | incremental |\n| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |\n| Histogram (sum and count) | for each label set | the metric name | incremental |\n\nUntyped metrics (have no '# TYPE') processing:\n\n- As Counter or Gauge depending on pattern match when 'fallback_type' is used.\n- As Counter if it has suffix '_total'.\n- As Summary if it has 'quantile' label.\n- As Histogram if it has 'le' label.\n\n**The rest are ignored**.\n\n",
7826 - "integration_type": "collector",
7827 - "id": "go.d.plugin-prometheus-ClickHouse",
7828 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/metadata.yaml",
7829 - "related_resources": ""
7830 - },
7832 {
7833 "meta": {
7834 "id": "collector-go.d.plugin-prometheus-aws_cloudwatch",
integrations/integrations.json
+36 -35
@@ -3403,6 +3403,42 @@
3403 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/chrony/metadata.yaml",
3404 "related_resources": ""
3405 },
3406 + {
3407 + "meta": {
3408 + "id": "collector-go.d.plugin-clickhouse",
3409 + "plugin_name": "go.d.plugin",
3410 + "module_name": "clickhouse",
3411 + "monitored_instance": {
3412 + "name": "ClickHouse",
3413 + "link": "https://clickhouse.com/",
3414 + "icon_filename": "clickhouse.svg",
3415 + "categories": [
3416 + "data-collection.database-servers"
3417 + ]
3418 + },
3419 + "keywords": [
3420 + "database"
3421 + ],
3422 + "related_resources": {
3423 + "integrations": {
3424 + "list": []
3425 + }
3426 + },
3427 + "info_provided_to_referring_integrations": {
3428 + "description": ""
3429 + },
3430 + "most_popular": false
3431 + },
3432 + "overview": "# ClickHouse\n\nPlugin: go.d.plugin\nModule: clickhouse\n\n## Overview\n\nThis collector retrieves performance data from ClickHouse for connections, queries, resources, replication, IO, and data operations (inserts, selects, merges) using HTTP requests and ClickHouse system tables. It monitors your ClickHouse server's health and activity.\n\n\nIt sends HTTP requests to the ClickHouse [HTTP interface](https://clickhouse.com/docs/en/interfaces/http), executing SELECT queries to retrieve data from various system tables.\nSpecifically, it collects metrics from the following tables:\n\n- system.metrics\n- systemd.async_metrics\n- system.events\n- system.disks\n- system.parts\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 ClickHouse instances running on localhost that are listening on port 8123.\nOn startup, it tries to collect metrics from:\n\n- http://127.0.0.1:8123\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",
3433 + "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/clickhouse.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/clickhouse.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:8123 | 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. | GET | 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:8123\n\n```\n##### HTTP authentication\n\nBasic HTTP authentication.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8123\n username: username\n password: password\n\n```\n##### HTTPS with self-signed certificate\n\nClickHouse with enabled HTTPS and self-signed certificate.\n\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:8123\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: http://127.0.0.1:8123\n\n - name: remote\n url: http://192.0.2.1:8123\n\n```\n",
3434 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `clickhouse` 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 clickhouse\n ```\n\n",
3435 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
3436 + "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 ClickHouse 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| clickhouse.connections | tcp, http, mysql, postgresql, interserver | connections |\n| clickhouse.slow_reads | slow | reads/s |\n| clickhouse.read_backoff | read_backoff | events/s |\n| clickhouse.memory_usage | used | bytes |\n| clickhouse.queries | successful, failed | queries/s |\n| clickhouse.select_queries | successful, failed | selects/s |\n| clickhouse.insert_queries | successful, failed | inserts/s |\n| clickhouse.queries_preempted | preempted | queries |\n| clickhouse.queries_memory_limit_exceeded | mem_limit_exceeded | queries/s |\n| clickhouse.queries_latency | queries_time | microseconds |\n| clickhouse.select_queries_latency | selects_time | microseconds |\n| clickhouse.insert_queries_latency | inserts_time | microseconds |\n| clickhouse.io | reads, writes | bytes/s |\n| clickhouse.iops | reads, writes | ops/s |\n| clickhouse.io_errors | read, write | errors/s |\n| clickhouse.io_seeks | lseek | ops/s |\n| clickhouse.io_file_opens | file_open | ops/s |\n| clickhouse.replicated_parts_current_activity | fetch, send, check | parts |\n| clickhouse.replicated_readonly_tables | read_only | tables |\n| clickhouse.replicated_data_loss | data_loss | events |\n| clickhouse.replicated_part_fetches | successful, failed | fetches/s |\n| clickhouse.inserted_rows | inserted | rows/s |\n| clickhouse.inserted_bytes | inserted | bytes/s |\n| clickhouse.rejected_inserts | rejected | inserts/s |\n| clickhouse.delayed_inserts | delayed | inserts/s |\n| clickhouse.delayed_inserts_throttle_time | delayed_inserts_throttle_time | milliseconds |\n| clickhouse.selected_bytes | selected | bytes/s |\n| clickhouse.selected_rows | selected | rows/s |\n| clickhouse.selected_parts | selected | parts/s |\n| clickhouse.selected_ranges | selected | ranges/s |\n| clickhouse.selected_marks | selected | marks/s |\n| clickhouse.merges | merge | ops/s |\n| clickhouse.merges_latency | merges_time | milliseconds |\n| clickhouse.merged_uncompressed_bytes | merged_uncompressed | bytes/s |\n| clickhouse.merged_rows | merged | rows/s |\n| clickhouse.merge_tree_data_writer_inserted_rows | inserted | rows/s |\n| clickhouse.merge_tree_data_writer_uncompressed_bytes | inserted | bytes/s |\n| clickhouse.merge_tree_data_writer_compressed_bytes | written | bytes/s |\n| clickhouse.uncompressed_cache_requests | hits, misses | requests/s |\n| clickhouse.mark_cache_requests | hits, misses | requests/s |\n| clickhouse.parts_count | temporary, pre_active, active, deleting, delete_on_destroy, outdated, wide, compact | parts |\n| distributed_connections | active | connections |\n| distributed_connections_attempts | connection | attempts/s |\n| distributed_connections_fail_retries | connection_retry | fails/s |\n| distributed_connections_fail_exhausted_retries | connection_retry_exhausted | fails/s |\n| distributed_files_to_insert | pending_insertions | files |\n| distributed_rejected_inserts | rejected | inserts/s |\n| distributed_delayed_inserts | delayed | inserts/s |\n| distributed_delayed_inserts_latency | delayed_time | milliseconds |\n| distributed_sync_insertion_timeout_exceeded | sync_insertion | timeouts/s |\n| distributed_async_insertions_failures | async_insertions | failures/s |\n| clickhouse.uptime | uptime | seconds |\n\n### Per disk\n\nThese metrics refer to the Disk.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| disk_name | Name of the disk as defined in the [server configuration](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#table_engine-mergetree-multiple-volumes_configure). |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| clickhouse.disk_space_usage | free, used | bytes |\n\n### Per table\n\nThese metrics refer to the Database Table.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| database | Name of the database. |\n| table | Name of the table. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| clickhouse.database_table_size | size | bytes |\n| clickhouse.database_table_parts | parts | parts |\n| clickhouse.database_table_parts | parts | parts |\n| clickhouse.database_table_rows | rows | rows |\n\n",
3437 + "integration_type": "collector",
3438 + "id": "go.d.plugin-clickhouse-ClickHouse",
3439 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/clickhouse/metadata.yaml",
3440 + "related_resources": ""
3441 + },
3442 {
3443 "meta": {
3444 "id": "collector-go.d.plugin-cockroachdb",
@@ -7791,41 +7827,6 @@
7827 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/metadata.yaml",
7828 "related_resources": ""
7829 },
7794 - {
7795 - "meta": {
7796 - "id": "collector-go.d.plugin-prometheus-clickhouse",
7797 - "module_name": "prometheus",
7798 - "plugin_name": "go.d.plugin",
7799 - "monitored_instance": {
7800 - "name": "ClickHouse",
7801 - "link": "https://github.com/ClickHouse/ClickHouse",
7802 - "icon_filename": "clickhouse.svg",
7803 - "categories": [
7804 - "data-collection.database-servers"
7805 - ]
7806 - },
7807 - "keywords": [],
7808 - "related_resources": {
7809 - "integrations": {
7810 - "list": []
7811 - }
7812 - },
7813 - "info_provided_to_referring_integrations": {
7814 - "description": ""
7815 - },
7816 - "most_popular": false,
7817 - "community": true
7818 - },
7819 - "overview": "# ClickHouse\n\nPlugin: go.d.plugin\nModule: prometheus\n\n## Overview\n\nMonitor ClickHouse database metrics for efficient data storage and query performance.\n\n\nMetrics are gathered by periodically sending HTTP requests to the ClickHouse built-in Prometheus exporter.\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 instances running on the local host by trying to connect to known ports that are [allocated to exporters](https://github.com/prometheus/prometheus/wiki/Default-port-allocations).\nThe full list of endpoints is available in the collector's [configuration file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/prometheus.conf).\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",
7820 - "setup": "## Setup\n\n### Prerequisites\n\n#### Configure built-in Prometheus exporter\n\nTo configure the built-in Prometheus exporter, follow the [official documentation](https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#server_configuration_parameters-prometheus).\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/prometheus.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/prometheus.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. | 10 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | | yes |\n| selector | Time series selector (filter). | | no |\n| fallback_type | Time series selector (filter). | | no |\n| max_time_series | Global time series limit. If an endpoint returns number of time series > limit the data is not processed. | 2000 | no |\n| max_time_series_per_metric | Time series per metric (metric name) limit. Metrics with number of time series > limit are skipped. | 200 | no |\n| timeout | HTTP request timeout. | 10 | 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. | GET | 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##### selector\n\nThis option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.\n\n- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)\n- Pattern syntax: [selector](/src/go/collectors/go.d.plugin/pkg/prometheus/selector/README.md).\n- Option syntax:\n\n```yaml\nselector:\n allow:\n - pattern1\n - pattern2\n deny:\n - pattern3\n - pattern4\n```\n\n\n##### fallback_type\n\nThis option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.\n\n- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).\n- Option syntax:\n\n```yaml\nfallback_type:\n counter:\n - metric_name_pattern1\n - metric_name_pattern2\n gauge:\n - metric_name_pattern3\n - metric_name_pattern4\n```\n\n\n#### Examples\n\n##### Basic\n\n> **Note**: Change the port of the monitored application on which it provides metrics.\n\nA basic example configuration.\n\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:9090/metrics\n\n```\n##### Read metrics from a file\n\nAn example configuration to read metrics from a file.\n\n```yaml\n# use \"file://\" scheme\njobs:\n - name: myapp\n url: file:///opt/metrics/myapp/metrics.txt\n\n```\n##### HTTP authentication\n\n> **Note**: Change the port of the monitored application on which it provides metrics.\n\nBasic HTTP authentication.\n\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:9090/metrics\n username: username\n password: password\n\n```\n##### HTTPS with self-signed certificate\n\n> **Note**: Change the port of the monitored application on which it provides metrics.\n\nDo not validate server certificate chain and hostname.\n\n\n```yaml\njobs:\n - name: local\n url: https://127.0.0.1:9090/metrics\n tls_skip_verify: yes\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n> **Note**: Change the port of the monitored application on which it provides metrics.\n\nCollecting metrics from local and remote instances.\n\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:9090/metrics\n\n - name: remote\n url: http://192.0.2.1:9090/metrics\n\n```\n",
7821 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `prometheus` 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 prometheus\n ```\n\n",
7822 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
7823 - "metrics": "## Metrics\n\nThis collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).\n\n| Metric | Chart | Dimension(s) | Algorithm |\n|---------------------------|-------------------------------------------|----------------------|-------------|\n| Gauge | for each label set | one, the metric name | absolute |\n| Counter | for each label set | one, the metric name | incremental |\n| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |\n| Summary (sum and count) | for each label set | the metric name | incremental |\n| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |\n| Histogram (sum and count) | for each label set | the metric name | incremental |\n\nUntyped metrics (have no '# TYPE') processing:\n\n- As Counter or Gauge depending on pattern match when 'fallback_type' is used.\n- As Counter if it has suffix '_total'.\n- As Summary if it has 'quantile' label.\n- As Histogram if it has 'le' label.\n\n**The rest are ignored**.\n\n",
7824 - "integration_type": "collector",
7825 - "id": "go.d.plugin-prometheus-ClickHouse",
7826 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/metadata.yaml",
7827 - "related_resources": ""
7828 - },
7830 {
7831 "meta": {
7832 "id": "collector-go.d.plugin-prometheus-aws_cloudwatch",
src/collectors/COLLECTORS.md
+1 -1
@@ -233,7 +233,7 @@ If you don't see the app/service you'd like to monitor in this list:
233
234 - [Cassandra](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/cassandra/integrations/cassandra.md)
235
236 -- [ClickHouse](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/clickhouse.md)
236 +- [ClickHouse](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/clickhouse/integrations/clickhouse.md)
237
238 - [ClusterControl CMON](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/clustercontrol_cmon.md)
239
src/go/collectors/go.d.plugin/modules/clickhouse/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/clickhouse.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/clickhouse/integrations/clickhouse.md new
+315
@@ -0,0 +1,315 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/clickhouse/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/clickhouse/metadata.yaml"
4 +sidebar_label: "ClickHouse"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Databases"
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 +# ClickHouse
12 +
13 +
14 +<img src="https://netdata.cloud/img/clickhouse.svg" width="150"/>
15 +
16 +
17 +Plugin: go.d.plugin
18 +Module: clickhouse
19 +
20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21 +
22 +## Overview
23 +
24 +This collector retrieves performance data from ClickHouse for connections, queries, resources, replication, IO, and data operations (inserts, selects, merges) using HTTP requests and ClickHouse system tables. It monitors your ClickHouse server's health and activity.
25 +
26 +
27 +It sends HTTP requests to the ClickHouse [HTTP interface](https://clickhouse.com/docs/en/interfaces/http), executing SELECT queries to retrieve data from various system tables.
28 +Specifically, it collects metrics from the following tables:
29 +
30 +- system.metrics
31 +- systemd.async_metrics
32 +- system.events
33 +- system.disks
34 +- system.parts
35 +
36 +
37 +This collector is supported on all platforms.
38 +
39 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
40 +
41 +
42 +### Default Behavior
43 +
44 +#### Auto-Detection
45 +
46 +By default, it detects ClickHouse instances running on localhost that are listening on port 8123.
47 +On startup, it tries to collect metrics from:
48 +
49 +- http://127.0.0.1:8123
50 +
51 +
52 +#### Limits
53 +
54 +The default configuration for this integration does not impose any limits on data collection.
55 +
56 +#### Performance Impact
57 +
58 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
59 +
60 +
61 +## Metrics
62 +
63 +Metrics grouped by *scope*.
64 +
65 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
66 +
67 +
68 +
69 +### Per ClickHouse instance
70 +
71 +These metrics refer to the entire monitored application.
72 +
73 +This scope has no labels.
74 +
75 +Metrics:
76 +
77 +| Metric | Dimensions | Unit |
78 +|:------|:----------|:----|
79 +| clickhouse.connections | tcp, http, mysql, postgresql, interserver | connections |
80 +| clickhouse.slow_reads | slow | reads/s |
81 +| clickhouse.read_backoff | read_backoff | events/s |
82 +| clickhouse.memory_usage | used | bytes |
83 +| clickhouse.queries | successful, failed | queries/s |
84 +| clickhouse.select_queries | successful, failed | selects/s |
85 +| clickhouse.insert_queries | successful, failed | inserts/s |
86 +| clickhouse.queries_preempted | preempted | queries |
87 +| clickhouse.queries_memory_limit_exceeded | mem_limit_exceeded | queries/s |
88 +| clickhouse.queries_latency | queries_time | microseconds |
89 +| clickhouse.select_queries_latency | selects_time | microseconds |
90 +| clickhouse.insert_queries_latency | inserts_time | microseconds |
91 +| clickhouse.io | reads, writes | bytes/s |
92 +| clickhouse.iops | reads, writes | ops/s |
93 +| clickhouse.io_errors | read, write | errors/s |
94 +| clickhouse.io_seeks | lseek | ops/s |
95 +| clickhouse.io_file_opens | file_open | ops/s |
96 +| clickhouse.replicated_parts_current_activity | fetch, send, check | parts |
97 +| clickhouse.replicated_readonly_tables | read_only | tables |
98 +| clickhouse.replicated_data_loss | data_loss | events |
99 +| clickhouse.replicated_part_fetches | successful, failed | fetches/s |
100 +| clickhouse.inserted_rows | inserted | rows/s |
101 +| clickhouse.inserted_bytes | inserted | bytes/s |
102 +| clickhouse.rejected_inserts | rejected | inserts/s |
103 +| clickhouse.delayed_inserts | delayed | inserts/s |
104 +| clickhouse.delayed_inserts_throttle_time | delayed_inserts_throttle_time | milliseconds |
105 +| clickhouse.selected_bytes | selected | bytes/s |
106 +| clickhouse.selected_rows | selected | rows/s |
107 +| clickhouse.selected_parts | selected | parts/s |
108 +| clickhouse.selected_ranges | selected | ranges/s |
109 +| clickhouse.selected_marks | selected | marks/s |
110 +| clickhouse.merges | merge | ops/s |
111 +| clickhouse.merges_latency | merges_time | milliseconds |
112 +| clickhouse.merged_uncompressed_bytes | merged_uncompressed | bytes/s |
113 +| clickhouse.merged_rows | merged | rows/s |
114 +| clickhouse.merge_tree_data_writer_inserted_rows | inserted | rows/s |
115 +| clickhouse.merge_tree_data_writer_uncompressed_bytes | inserted | bytes/s |
116 +| clickhouse.merge_tree_data_writer_compressed_bytes | written | bytes/s |
117 +| clickhouse.uncompressed_cache_requests | hits, misses | requests/s |
118 +| clickhouse.mark_cache_requests | hits, misses | requests/s |
119 +| clickhouse.parts_count | temporary, pre_active, active, deleting, delete_on_destroy, outdated, wide, compact | parts |
120 +| distributed_connections | active | connections |
121 +| distributed_connections_attempts | connection | attempts/s |
122 +| distributed_connections_fail_retries | connection_retry | fails/s |
123 +| distributed_connections_fail_exhausted_retries | connection_retry_exhausted | fails/s |
124 +| distributed_files_to_insert | pending_insertions | files |
125 +| distributed_rejected_inserts | rejected | inserts/s |
126 +| distributed_delayed_inserts | delayed | inserts/s |
127 +| distributed_delayed_inserts_latency | delayed_time | milliseconds |
128 +| distributed_sync_insertion_timeout_exceeded | sync_insertion | timeouts/s |
129 +| distributed_async_insertions_failures | async_insertions | failures/s |
130 +| clickhouse.uptime | uptime | seconds |
131 +
132 +### Per disk
133 +
134 +These metrics refer to the Disk.
135 +
136 +Labels:
137 +
138 +| Label | Description |
139 +|:-----------|:----------------|
140 +| disk_name | Name of the disk as defined in the [server configuration](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#table_engine-mergetree-multiple-volumes_configure). |
141 +
142 +Metrics:
143 +
144 +| Metric | Dimensions | Unit |
145 +|:------|:----------|:----|
146 +| clickhouse.disk_space_usage | free, used | bytes |
147 +
148 +### Per table
149 +
150 +These metrics refer to the Database Table.
151 +
152 +Labels:
153 +
154 +| Label | Description |
155 +|:-----------|:----------------|
156 +| database | Name of the database. |
157 +| table | Name of the table. |
158 +
159 +Metrics:
160 +
161 +| Metric | Dimensions | Unit |
162 +|:------|:----------|:----|
163 +| clickhouse.database_table_size | size | bytes |
164 +| clickhouse.database_table_parts | parts | parts |
165 +| clickhouse.database_table_parts | parts | parts |
166 +| clickhouse.database_table_rows | rows | rows |
167 +
168 +
169 +
170 +## Alerts
171 +
172 +There are no alerts configured by default for this integration.
173 +
174 +
175 +## Setup
176 +
177 +### Prerequisites
178 +
179 +No action required.
180 +
181 +### Configuration
182 +
183 +#### File
184 +
185 +The configuration file name for this integration is `go.d/clickhouse.conf`.
186 +
187 +
188 +You can edit the configuration file using the `edit-config` script from the
189 +Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
190 +
191 +```bash
192 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
193 +sudo ./edit-config go.d/clickhouse.conf
194 +```
195 +#### Options
196 +
197 +The following options can be defined globally: update_every, autodetection_retry.
198 +
199 +
200 +<details><summary>Config options</summary>
201 +
202 +| Name | Description | Default | Required |
203 +|:----|:-----------|:-------|:--------:|
204 +| update_every | Data collection frequency. | 1 | no |
205 +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
206 +| url | Server URL. | http://127.0.0.1:8123 | yes |
207 +| timeout | HTTP request timeout. | 1 | no |
208 +| username | Username for basic HTTP authentication. | | no |
209 +| password | Password for basic HTTP authentication. | | no |
210 +| proxy_url | Proxy URL. | | no |
211 +| proxy_username | Username for proxy basic HTTP authentication. | | no |
212 +| proxy_password | Password for proxy basic HTTP authentication. | | no |
213 +| method | HTTP request method. | GET | no |
214 +| body | HTTP request body. | | no |
215 +| headers | HTTP request headers. | | no |
216 +| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
217 +| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
218 +| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |
219 +| tls_cert | Client TLS certificate. | | no |
220 +| tls_key | Client TLS key. | | no |
221 +
222 +</details>
223 +
224 +#### Examples
225 +
226 +##### Basic
227 +
228 +A basic example configuration.
229 +
230 +```yaml
231 +jobs:
232 + - name: local
233 + url: http://127.0.0.1:8123
234 +
235 +```
236 +##### HTTP authentication
237 +
238 +Basic HTTP authentication.
239 +
240 +<details><summary>Config</summary>
241 +
242 +```yaml
243 +jobs:
244 + - name: local
245 + url: http://127.0.0.1:8123
246 + username: username
247 + password: password
248 +
249 +```
250 +</details>
251 +
252 +##### HTTPS with self-signed certificate
253 +
254 +ClickHouse with enabled HTTPS and self-signed certificate.
255 +
256 +<details><summary>Config</summary>
257 +
258 +```yaml
259 +jobs:
260 + - name: local
261 + url: https://127.0.0.1:8123
262 + tls_skip_verify: yes
263 +
264 +```
265 +</details>
266 +
267 +##### Multi-instance
268 +
269 +> **Note**: When you define multiple jobs, their names must be unique.
270 +
271 +Collecting metrics from local and remote instances.
272 +
273 +
274 +<details><summary>Config</summary>
275 +
276 +```yaml
277 +jobs:
278 + - name: local
279 + url: http://127.0.0.1:8123
280 +
281 + - name: remote
282 + url: http://192.0.2.1:8123
283 +
284 +```
285 +</details>
286 +
287 +
288 +
289 +## Troubleshooting
290 +
291 +### Debug Mode
292 +
293 +To troubleshoot issues with the `clickhouse` collector, run the `go.d.plugin` with the debug option enabled. The output
294 +should give you clues as to why the collector isn't working.
295 +
296 +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
297 + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
298 +
299 + ```bash
300 + cd /usr/libexec/netdata/plugins.d/
301 + ```
302 +
303 +- Switch to the `netdata` user.
304 +
305 + ```bash
306 + sudo -u netdata -s
307 + ```
308 +
309 +- Run the `go.d.plugin` to debug the collector:
310 +
311 + ```bash
312 + ./go.d.plugin -d -m clickhouse
313 + ```
314 +
315 +
src/go/collectors/go.d.plugin/modules/prometheus/integrations/clickhouse.md deleted
-291
@@ -1,291 +0,0 @@
1 -<!--startmeta
2 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/clickhouse.md"
3 -meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/prometheus/metadata.yaml"
4 -sidebar_label: "ClickHouse"
5 -learn_status: "Published"
6 -learn_rel_path: "Collecting Metrics/Databases"
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 -# ClickHouse
12 -
13 -
14 -<img src="https://netdata.cloud/img/clickhouse.svg" width="150"/>
15 -
16 -
17 -Plugin: go.d.plugin
18 -Module: prometheus
19 -
20 -<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21 -
22 -## Overview
23 -
24 -Monitor ClickHouse database metrics for efficient data storage and query performance.
25 -
26 -
27 -Metrics are gathered by periodically sending HTTP requests to the ClickHouse built-in Prometheus exporter.
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 instances running on the local host by trying to connect to known ports that are [allocated to exporters](https://github.com/prometheus/prometheus/wiki/Default-port-allocations).
40 -The full list of endpoints is available in the collector's [configuration file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/prometheus.conf).
41 -
42 -
43 -#### Limits
44 -
45 -The default configuration for this integration does not impose any limits on data collection.
46 -
47 -#### Performance Impact
48 -
49 -The default configuration for this integration is not expected to impose a significant performance impact on the system.
50 -
51 -
52 -## Metrics
53 -
54 -This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
55 -
56 -| Metric | Chart | Dimension(s) | Algorithm |
57 -|---------------------------|-------------------------------------------|----------------------|-------------|
58 -| Gauge | for each label set | one, the metric name | absolute |
59 -| Counter | for each label set | one, the metric name | incremental |
60 -| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
61 -| Summary (sum and count) | for each label set | the metric name | incremental |
62 -| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
63 -| Histogram (sum and count) | for each label set | the metric name | incremental |
64 -
65 -Untyped metrics (have no '# TYPE') processing:
66 -
67 -- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
68 -- As Counter if it has suffix '_total'.
69 -- As Summary if it has 'quantile' label.
70 -- As Histogram if it has 'le' label.
71 -
72 -**The rest are ignored**.
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 -#### Configure built-in Prometheus exporter
86 -
87 -To configure the built-in Prometheus exporter, follow the [official documentation](https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#server_configuration_parameters-prometheus).
88 -
89 -
90 -
91 -### Configuration
92 -
93 -#### File
94 -
95 -The configuration file name for this integration is `go.d/prometheus.conf`.
96 -
97 -
98 -You can edit the configuration file using the `edit-config` script from the
99 -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
100 -
101 -```bash
102 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
103 -sudo ./edit-config go.d/prometheus.conf
104 -```
105 -#### Options
106 -
107 -The following options can be defined globally: update_every, autodetection_retry.
108 -
109 -
110 -<details><summary>Config options</summary>
111 -
112 -| Name | Description | Default | Required |
113 -|:----|:-----------|:-------|:--------:|
114 -| update_every | Data collection frequency. | 10 | no |
115 -| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
116 -| url | Server URL. | | yes |
117 -| selector | Time series selector (filter). | | no |
118 -| fallback_type | Time series selector (filter). | | no |
119 -| max_time_series | Global time series limit. If an endpoint returns number of time series > limit the data is not processed. | 2000 | no |
120 -| max_time_series_per_metric | Time series per metric (metric name) limit. Metrics with number of time series > limit are skipped. | 200 | no |
121 -| timeout | HTTP request timeout. | 10 | no |
122 -| username | Username for basic HTTP authentication. | | no |
123 -| password | Password for basic HTTP authentication. | | no |
124 -| proxy_url | Proxy URL. | | no |
125 -| proxy_username | Username for proxy basic HTTP authentication. | | no |
126 -| proxy_password | Password for proxy basic HTTP authentication. | | no |
127 -| method | HTTP request method. | GET | no |
128 -| body | HTTP request body. | | no |
129 -| headers | HTTP request headers. | | no |
130 -| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
131 -| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
132 -| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |
133 -| tls_cert | Client TLS certificate. | | no |
134 -| tls_key | Client TLS key. | | no |
135 -
136 -##### selector
137 -
138 -This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
139 -
140 -- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
141 -- Pattern syntax: [selector](/src/go/collectors/go.d.plugin/pkg/prometheus/selector/README.md).
142 -- Option syntax:
143 -
144 -```yaml
145 -selector:
146 - allow:
147 - - pattern1
148 - - pattern2
149 - deny:
150 - - pattern3
151 - - pattern4
152 -```
153 -
154 -
155 -##### fallback_type
156 -
157 -This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
158 -
159 -- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
160 -- Option syntax:
161 -
162 -```yaml
163 -fallback_type:
164 - counter:
165 - - metric_name_pattern1
166 - - metric_name_pattern2
167 - gauge:
168 - - metric_name_pattern3
169 - - metric_name_pattern4
170 -```
171 -
172 -
173 -</details>
174 -
175 -#### Examples
176 -
177 -##### Basic
178 -
179 -> **Note**: Change the port of the monitored application on which it provides metrics.
180 -
181 -A basic example configuration.
182 -
183 -
184 -```yaml
185 -jobs:
186 - - name: local
187 - url: http://127.0.0.1:9090/metrics
188 -
189 -```
190 -##### Read metrics from a file
191 -
192 -An example configuration to read metrics from a file.
193 -
194 -<details><summary>Config</summary>
195 -
196 -```yaml
197 -# use "file://" scheme
198 -jobs:
199 - - name: myapp
200 - url: file:///opt/metrics/myapp/metrics.txt
201 -
202 -```
203 -</details>
204 -
205 -##### HTTP authentication
206 -
207 -> **Note**: Change the port of the monitored application on which it provides metrics.
208 -
209 -Basic HTTP authentication.
210 -
211 -
212 -<details><summary>Config</summary>
213 -
214 -```yaml
215 -jobs:
216 - - name: local
217 - url: http://127.0.0.1:9090/metrics
218 - username: username
219 - password: password
220 -
221 -```
222 -</details>
223 -
224 -##### HTTPS with self-signed certificate
225 -
226 -> **Note**: Change the port of the monitored application on which it provides metrics.
227 -
228 -Do not validate server certificate chain and hostname.
229 -
230 -
231 -<details><summary>Config</summary>
232 -
233 -```yaml
234 -jobs:
235 - - name: local
236 - url: https://127.0.0.1:9090/metrics
237 - tls_skip_verify: yes
238 -
239 -```
240 -</details>
241 -
242 -##### Multi-instance
243 -
244 -> **Note**: When you define multiple jobs, their names must be unique.
245 -> **Note**: Change the port of the monitored application on which it provides metrics.
246 -
247 -Collecting metrics from local and remote instances.
248 -
249 -
250 -<details><summary>Config</summary>
251 -
252 -```yaml
253 -jobs:
254 - - name: local
255 - url: http://127.0.0.1:9090/metrics
256 -
257 - - name: remote
258 - url: http://192.0.2.1:9090/metrics
259 -
260 -```
261 -</details>
262 -
263 -
264 -
265 -## Troubleshooting
266 -
267 -### Debug Mode
268 -
269 -To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
270 -should give you clues as to why the collector isn't working.
271 -
272 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
273 - your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
274 -
275 - ```bash
276 - cd /usr/libexec/netdata/plugins.d/
277 - ```
278 -
279 -- Switch to the `netdata` user.
280 -
281 - ```bash
282 - sudo -u netdata -s
283 - ```
284 -
285 -- Run the `go.d.plugin` to debug the collector:
286 -
287 - ```bash
288 - ./go.d.plugin -d -m prometheus
289 - ```
290 -
291 -