Regenerate integrations docs (#21499)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Dec 22, 2025 at 12:23 UTC
4106b76f1633b62d41690fcdc9c1798b1323093f
110 files changed
+4
-40372
src/collectors/COLLECTORS.md
-107
@@ -77,7 +77,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
77
| [Network statistics](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/network_statistics.md) | This integration provides metrics from the `netstat`, `snmp` and `snmp6` modules. |
78
| [NFS Client](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/nfs_client.md) | This integration provides statistics from the Linux kernel's NFS Client. |
79
| [NFS Server](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/nfs_server.md) | This integration provides statistics from the Linux kernel's NFS Server. |
80
-| [nftables](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nftables.md) | Monitor nftables firewall metrics for efficient network security and management. |
80
| [Non-Uniform Memory Access](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/non-uniform_memory_access.md) | Information about NUMA (Non-Uniform Memory Access) nodes on the system. |
81
| [OpenRC](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openrc.md) | Keep tabs on OpenRC init system metrics for efficient system startup and service management. |
82
| [Page types](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/page_types.md) | This integration provides metrics about the system's memory page types |
@@ -161,14 +160,12 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
160
161
| Integration | Description |
162
|-------------|-------------|
164
-| [cAdvisor](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/cadvisor.md) | Monitor container resource usage and performance metrics with cAdvisor for efficient container management. |
163
| [Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/containers.md) | Monitor Containers for performance, resource usage, and health status. |
164
| [Docker](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/docker/integrations/docker.md) | This collector monitors Docker containers state, health status and more. |
165
| [Docker Engine](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/docker_engine/integrations/docker_engine.md) | This collector monitors the activity and health of Docker Engine and Docker Swarm. |
166
| [Docker Hub repository](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/dockerhub/integrations/docker_hub_repository.md) | This collector keeps track of DockerHub repositories statistics such as the number of stars, pulls, current status, and more. |
167
| [Libvirt Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/libvirt_containers.md) | Monitor Libvirt for performance, resource usage, and health status. |
168
| [LXC Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/lxc_containers.md) | Monitor LXC Containers for performance, resource usage, and health status. |
171
-| [NSX-T](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nsx-t.md) | Track VMware NSX-T software-defined networking metrics for efficient network virtualization and security management. |
169
| [oVirt Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/ovirt_containers.md) | Monitor oVirt for performance, resource usage, and health status. |
170
| [Podman](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/podman.md) | Keep tabs on Podman container runtime metrics for efficient container management and performance. |
171
| [Proxmox Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/proxmox_containers.md) | Monitor Proxmox for performance, resource usage, and health status. |
@@ -192,18 +189,13 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
189
| [Couchbase](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/couchbase/integrations/couchbase.md) | This collector monitors Couchbase servers. |
190
| [CouchDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/couchdb/integrations/couchdb.md) | This collector monitors CouchDB servers. |
191
| [HANA](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hana.md) | Track SAP HANA database metrics for efficient data storage and query performance. |
195
-| [Hasura GraphQL Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hasura_graphql_server.md) | Keep tabs on Hasura GraphQL engine metrics for optimized API performance and management. |
192
| [InfluxDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/influxdb.md) | Monitor InfluxDB time-series database metrics for efficient data storage and query performance. |
197
-| [Machbase](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/machbase.md) | Monitor Machbase time-series database metrics for efficient data storage and query performance. |
193
| [MariaDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/mysql/integrations/mariadb.md) | This collector monitors the health and performance of MySQL servers and collects general statistics, replication and user metrics. |
194
| [MaxScale](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/maxscale/integrations/maxscale.md) | This collector monitors the activity and performance of MaxScale servers. |
195
| [Memcached](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/memcached/integrations/memcached.md) | Monitor Memcached metrics for proficient in-memory key-value store operations. |
201
-| [Memcached (community)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/memcached_community.md) | Monitor Memcached in-memory key-value store metrics for efficient caching performance and management. |
196
| [MongoDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/mongodb/integrations/mongodb.md) | This collector monitors MongoDB servers. |
197
| [MySQL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/mysql/integrations/mysql.md) | This collector monitors the health and performance of MySQL servers and collects general statistics, replication and user metrics. |
204
-| [ODBC](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/odbc.md) | Keep tabs on Open Database Connectivity (ODBC) metrics for efficient database connection and performance. |
198
| [Oracle DB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/oracledb/integrations/oracle_db.md) | This collector monitors the health and performance of Oracle DB servers and collects general statistics, replication and user metrics. |
206
-| [Oracle DB (community)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/oracle_db_community.md) | Track Oracle Database metrics for efficient database management and performance. |
199
| [Patroni](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/patroni.md) | Keep tabs on Patroni PostgreSQL high-availability metrics for efficient database management and performance. |
200
| [Percona MySQL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/mysql/integrations/percona_mysql.md) | This collector monitors the health and performance of MySQL servers and collects general statistics, replication and user metrics. |
201
| [pgBackRest](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/pgbackrest.md) | Monitor pgBackRest PostgreSQL backup metrics for efficient database backup and management. |
@@ -230,16 +222,13 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
222
| [Cilium Proxy](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/cilium_proxy.md) | Track Cilium Proxy metrics for enhanced network security and performance. |
223
| [Kubelet](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/k8s_kubelet/integrations/kubelet.md) | This collector monitors Kubelet instances. |
224
| [Kubeproxy](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/k8s_kubeproxy/integrations/kubeproxy.md) | This collector monitors Kubeproxy instances. |
233
-| [Kubernetes Cluster Cloud Cost](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/kubernetes_cluster_cloud_cost.md) | Keep an eye on Kubernetes cloud cost metrics for efficient cloud resource management and budgeting. |
225
| [Kubernetes Cluster State](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/k8s_state/integrations/kubernetes_cluster_state.md) | This collector monitors Kubernetes Nodes, Pods and Containers. |
226
| [Kubernetes Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/kubernetes_containers.md) | Monitor Containers for performance, resource usage, and health status. |
236
-| [Rancher](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/rancher.md) | Track Rancher container orchestration platform metrics for efficient container management and performance. |
227
228
### Incident Management
229
230
| Integration | Description |
231
|-------------|-------------|
242
-| [OTRS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/otrs.md) | Monitor OTRS (Open-Source Ticket Request System) metrics for efficient helpdesk management and performance. |
232
| [StatusPage](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/statuspage.md) | Monitor StatusPage.io incident and status metrics for efficient incident management and communication. |
233
234
### Service Discovery / Registry
@@ -258,11 +247,9 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
247
| [Apache](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/apache/integrations/apache.md) | This collector monitors the activity and performance of Apache servers, and collects metrics such as the number of connections, workers, requests and more. |
248
| [APIcast](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/apicast.md) | Monitor APIcast performance metrics to optimize API gateway operations and management. |
249
| [Clash](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/clash.md) | Keep an eye on Clash proxy server metrics for optimized network performance and management. |
261
-| [Cloudflare PCAP](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/cloudflare_pcap.md) | Keep tabs on Cloudflare CDN and security metrics for optimized content delivery and protection. |
250
| [Envoy](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/envoy/integrations/envoy.md) | This collector monitors Envoy proxies. |
251
| [Gobetween](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/gobetween.md) | Track Gobetween load balancer metrics for optimized network traffic management and performance. |
252
| [HAProxy](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/haproxy/integrations/haproxy.md) | This collector monitors HAProxy servers. |
265
-| [HHVM](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hhvm.md) | Monitor HipHop Virtual Machine metrics for efficient PHP execution and performance. |
253
| [HTTPD](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/apache/integrations/httpd.md) | This collector monitors the activity and performance of Apache servers, and collects metrics such as the number of connections, workers, requests and more. |
254
| [Lighttpd](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/lighttpd/integrations/lighttpd.md) | This collector monitors the activity and performance of Lighttpd servers, and collects metrics such as the number of connections, workers, requests and more. |
255
| [Litespeed](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/litespeed/integrations/litespeed.md) | Examine Litespeed metrics for insights into web server operations. |
@@ -284,36 +271,15 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
271
272
| Integration | Description |
273
|-------------|-------------|
287
-| [Akamai Global Traffic Management](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/akamai_global_traffic_management.md) | Monitor vital metrics of Akamai Global Traffic Management (GTM) for optimized load balancing and failover. |
288
-| [Akami Cloudmonitor](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/akami_cloudmonitor.md) | Monitor Akamai cloudmonitor provider metrics for comprehensive cloud performance management. |
289
-| [Alibaba Cloud](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/alibaba_cloud.md) | Monitor Alibaba Cloud services and resources for efficient management and cost optimization. |
290
-| [ArvanCloud CDN](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/arvancloud_cdn.md) | Track and analyze ArvanCloud CDN and cloud services performance metrics for optimized delivery and management. |
274
| [AWS EC2 Compute instances](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_ec2_compute_instances.md) | Track AWS EC2 instances key metrics for optimized performance and cost management. |
292
-| [AWS EC2 Spot Instance](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_ec2_spot_instance.md) | Monitor AWS EC2 Spot instances'' performance metrics for efficient resource allocation and cost optimization. |
293
-| [AWS ECS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_ecs.md) | Keep an eye on AWS ECS services and resources for optimized container management and orchestration. |
294
-| [AWS Health events](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_health_events.md) | Track AWS service health metrics for proactive incident management and resolution. |
295
-| [AWS instance health](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_instance_health.md) | Monitor the health of AWS instances for improved performance and availability. |
275
| [AWS Quota](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_quota.md) | Monitor AWS service quotas for effective resource usage and cost management. |
297
-| [AWS S3 buckets](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_s3_buckets.md) | Monitor AWS S3 storage metrics for optimized performance, data management, and cost efficiency. |
298
-| [AWS SQS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_sqs.md) | Track AWS SQS messaging metrics for efficient message processing and queue management. |
299
-| [Azure AD App passwords](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_ad_app_passwords.md) | Safeguard and track Azure App secrets for enhanced security and access management. |
300
-| [Azure application](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_application.md) | Track Azure Monitor metrics for comprehensive resource management and performance optimization. |
301
-| [Azure Elastic Pool SQL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_elastic_pool_sql.md) | Monitor Azure Elastic SQL performance metrics for efficient database management and query optimization. |
302
-| [Azure Resources](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_resources.md) | Keep tabs on Azure resources vital metrics for efficient cloud management and cost optimization. |
303
-| [Azure Service Bus](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_service_bus.md) | Monitor Azure Service Bus messaging metrics for optimized communication and integration. |
304
-| [Azure SQL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_sql.md) | Track Azure SQL performance metrics for efficient database management and query performance. |
305
-| [BigQuery](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/bigquery.md) | Monitor Google BigQuery metrics for optimized data processing and analysis. |
276
| [CloudWatch](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/cloudwatch.md) | Monitor AWS CloudWatch metrics for comprehensive AWS resource management and performance optimization. |
307
-| [Dell EMC ECS cluster](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_ecs_cluster.md) | Monitor Dell EMC ECS object storage metrics for optimized storage management and performance. |
308
-| [DigitalOcean](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/digitalocean.md) | Track DigitalOcean cloud provider metrics for optimized resource management and performance. |
277
| [GCP GCE](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/gcp_gce.md) | Keep an eye on Google Cloud Platform Compute Engine metrics for efficient cloud resource management and performance. |
310
-| [GCP Quota](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/gcp_quota.md) | Monitor Google Cloud Platform quota metrics for optimized resource usage and cost management. |
278
| [Google Cloud Platform](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/google_cloud_platform.md) | Monitor Google Cloud Platform metrics for comprehensive cloud resource management and performance optimization. |
279
| [Google Stackdriver](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/google_stackdriver.md) | Track Google Stackdriver monitoring metrics for optimized cloud performance and diagnostics. |
280
| [Linode](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/linode.md) | Monitor Linode cloud hosting metrics for efficient virtual server management and performance. |
281
| [Lustre metadata](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/lustre_metadata.md) | Keep tabs on Lustre clustered file system for efficient management and performance. |
282
| [Nextcloud servers](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nextcloud_servers.md) | Keep an eye on Nextcloud cloud storage metrics for efficient file hosting and management. |
316
-| [OpenStack](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openstack.md) | Track OpenStack cloud computing platform metrics for efficient infrastructure management and performance. |
283
| [Zerto](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/zerto.md) | Monitor Zerto disaster recovery and data protection metrics for efficient backup and recovery management. |
284
285
### Windows Systems
@@ -347,20 +313,13 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
313
| Integration | Description |
314
|-------------|-------------|
315
| [Alamos FE2 server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/alamos_fe2_server.md) | Keep tabs on Alamos FE2 systems for improved performance and management. |
350
-| [Apache Airflow](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/apache_airflow.md) | Monitor Apache Airflow metrics to optimize task scheduling and workflow management. |
351
-| [Apache Flink](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/apache_flink.md) | Keep an eye on Apache Flink metrics for efficient stream processing and application management. |
352
-| [Audisto](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/audisto.md) | Monitor Audisto SEO and website metrics for improved search performance and optimization. |
353
-| [bpftrace variables](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/bpftrace_variables.md) | Track bpftrace metrics for advanced performance analysis and troubleshooting. |
354
-| [Dependency-Track](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dependency-track.md) | Monitor Dependency-Track metrics for efficient vulnerability management and software supply chain analysis. |
316
| [Go applications (EXPVAR)](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/go_expvar/integrations/go_applications_expvar.md) | This collector monitors Go applications that expose their metrics with the use of the `expvar` package from the Go standard library. |
317
| [Google Pagespeed](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/google_pagespeed.md) | Keep an eye on Google PageSpeed Insights performance metrics for efficient web page optimization and performance. |
318
| [gpsd](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/gpsd.md) | Monitor GPSD (GPS daemon) metrics for efficient GPS data management and performance. |
319
| [IBM AIX systems Njmon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_aix_systems_njmon.md) | Keep an eye on NJmon system performance monitoring metrics for efficient IT infrastructure management and performance. |
320
| [JMX](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/jmx.md) | Track Java Management Extensions (JMX) metrics for efficient Java application management and performance. |
360
-| [jolokia](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/jolokia.md) | Monitor Jolokia JVM metrics for optimized Java application performance and management. |
321
| [NRPE daemon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nrpe_daemon.md) | Monitor Nagios Remote Plugin Executor (NRPE) metrics for efficient system and network monitoring. |
322
| [phpDaemon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/phpdaemon/integrations/phpdaemon.md) | This collector monitors phpDaemon instances. |
363
-| [Sentry](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sentry.md) | Track Sentry error tracking and monitoring platform metrics for efficient application performance and error management. |
323
| [Sysload](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sysload.md) | Monitor system load metrics for efficient system performance and resource management. |
324
| [VSCode](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/vscode.md) | Track Visual Studio Code editor metrics for efficient development environment management and performance. |
325
| [YOURLS URL Shortener](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/yourls_url_shortener.md) | Monitor YOURLS (Your Own URL Shortener) metrics for efficient URL shortening service management and performance. |
@@ -373,29 +332,22 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
332
| [AM2320](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/am2320/integrations/am2320.md) | This collector monitors AM2320 sensor metrics about temperature and humidity. |
333
| [AMD CPU & GPU](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/amd_cpu_&_gpu.md) | Monitor AMD System Management Interface performance for optimized hardware management. |
334
| [AMD GPU](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/amd_gpu.md) | This integration monitors AMD GPU metrics, such as utilization, clock frequency and memory usage. |
376
-| [ARM HWCPipe](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/arm_hwcpipe.md) | Keep track of ARM running Android devices and get metrics for efficient performance optimization. |
335
| [CUPS](https://github.com/netdata/netdata/blob/master/src/collectors/cups.plugin/integrations/cups.md) | Monitor CUPS performance for achieving optimal printing system operations. |
336
| [HDD temperature](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/hddtemp/integrations/hdd_temperature.md) | This collector monitors disk temperatures. |
379
-| [HP iLO](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hp_ilo.md) | Monitor HP Integrated Lights Out (iLO) metrics for efficient server management and diagnostics. |
337
| [IBM CryptoExpress (CEX) cards](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_cryptoexpress_cex_cards.md) | Track IBM Z Crypto Express device metrics for optimized cryptographic performance and management. |
338
| [IBM Z Hardware Management Console](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_z_hardware_management_console.md) | Monitor IBM Z Hardware Management Console metrics for efficient mainframe management and performance. |
339
| [Intel GPU](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/intelgpu/integrations/intel_gpu.md) | This collector gathers performance metrics for Intel integrated GPUs. |
340
| [Intelligent Platform Management Interface (IPMI)](https://github.com/netdata/netdata/blob/master/src/collectors/freeipmi.plugin/integrations/intelligent_platform_management_interface_ipmi.md) | "Monitor enterprise server sensor readings, event log entries, and hardware statuses to ensure reliable server operations." |
384
-| [IPMI (By SoundCloud)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ipmi_by_soundcloud.md) | Monitor IPMI metrics externally for efficient server hardware management and monitoring. |
341
| [Linux Sensors](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/sensors/integrations/linux_sensors.md) | This collector gathers real-time system sensor statistics using the [sysfs](https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface) interface. |
342
| [Nvidia GPU](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/nvidia_smi/integrations/nvidia_gpu.md) | This collector monitors GPUs performance metrics using the [nvidia-smi](https://developer.nvidia.com/nvidia-system-management-interface) CLI tool. |
387
-| [NVML](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nvml.md) | Keep an eye on NVIDIA Management Library (NVML) GPU metrics for efficient GPU performance and management. |
343
| [Raritan PDU](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/raritan_pdu.md) | Monitor Raritan Power Distribution Unit (PDU) metrics for efficient power management and monitoring. |
344
| [S.M.A.R.T.](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/smartctl/integrations/s.m.a.r.t..md) | This collector monitors the health status of storage devices by analyzing S.M.A.R.T. |
390
-| [ServerTech](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/servertech.md) | Keep an eye on Server Technology power distribution unit (PDU) metrics for efficient power management and monitoring. |
345
| [Siemens S7 PLC](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/siemens_s7_plc.md) | Monitor Siemens S7 Programmable Logic Controller (PLC) metrics for efficient industrial automation and control. |
392
-| [T-Rex NVIDIA GPU Miner](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/t-rex_nvidia_gpu_miner.md) | Monitor T-Rex NVIDIA GPU miner metrics for efficient cryptocurrency mining and GPU performance. |
346
347
### macOS Systems
348
349
| Integration | Description |
350
|-------------|-------------|
398
-| [Apple Time Machine](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/apple_time_machine.md) | Track Apple Time Machine backup metrics for efficient data protection and recovery. |
351
| [macOS](https://github.com/netdata/netdata/blob/master/src/collectors/macos.plugin/integrations/macos.md) | Monitor macOS metrics for efficient operating system performance. |
352
353
### Message Brokers
@@ -407,7 +359,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
359
| [Beanstalk](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/beanstalk/integrations/beanstalk.md) | This collector monitors Beanstalk server performance and provides detailed statistics for each tube. |
360
| [IBM MQ](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_mq.md) | Keep tabs on IBM MQ message queue metrics for efficient message transport and performance. |
361
| [Kafka](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/kafka.md) | Keep an eye on Kafka message queue metrics for optimized data streaming and performance. |
410
-| [Kafka Connect](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/kafka_connect.md) | Keep tabs on Kafka Connect metrics for efficient data streaming and integration. |
362
| [Kafka ZooKeeper](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/kafka_zookeeper.md) | Monitor Kafka ZooKeeper metrics for optimized distributed coordination and management. |
363
| [mosquitto](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mosquitto.md) | Keep an eye on Mosquitto MQTT broker metrics for efficient IoT message transport and performance. |
364
| [MQTT Blackbox](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mqtt_blackbox.md) | Track MQTT message transport performance using blackbox testing methods. |
@@ -415,7 +366,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
366
| [RabbitMQ](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/rabbitmq/integrations/rabbitmq.md) | This collector monitors RabbitMQ instances. |
367
| [Redis Queue](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/redis_queue.md) | Monitor Python RQ (Redis Queue) job queue metrics for efficient task management and performance. |
368
| [VerneMQ](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/vernemq/integrations/vernemq.md) | This collector monitors VerneMQ instances. |
418
-| [XMPP Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/xmpp_server.md) | Monitor XMPP (Extensible Messaging and Presence Protocol) server metrics for efficient messaging and communication management. |
369
370
### Provisioning Systems
371
@@ -441,27 +391,17 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
391
| Integration | Description |
392
|-------------|-------------|
393
| [8430FT modem](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/8430ft_modem.md) | Keep track of vital metrics from the MTS 8430FT modem for streamlined network performance and diagnostics. |
444
-| [Andrews & Arnold line status](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/andrews_&_arnold_line_status.md) | Track Andrews & Arnold Ltd (AAISP) metrics for improved network performance and diagnostics. |
445
-| [Aruba devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aruba_devices.md) | Monitor Aruba Networks devices performance metrics for comprehensive network management and analysis. |
394
| [Bird Routing Daemon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/bird_routing_daemon.md) | Keep an eye on Bird Routing Daemon metrics for optimized network routing and management. |
447
-| [Checkpoint device](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/checkpoint_device.md) | Track Check Point firewall and security metrics for enhanced network protection and management. |
448
-| [Citrix NetScaler](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/citrix_netscaler.md) | Keep tabs on NetScaler performance metrics for efficient application delivery and load balancing. |
449
-| [DDWRT Routers](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ddwrt_routers.md) | Keep tabs on DD-WRT router metrics for efficient network management and performance. |
395
| [Freifunk network](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/freifunk_network.md) | Keep tabs on Freifunk community network metrics for optimized network performance and management. |
396
| [FRRouting](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/frrouting.md) | Monitor Free Range Routing (FRR) metrics for optimized network routing and management. |
452
-| [Hitron CGN series CPE](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hitron_cgn_series_cpe.md) | Monitor Hitron CGNV4 gateway metrics for efficient network management and performance. |
397
| [Hitron CODA Cable Modem](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hitron_coda_cable_modem.md) | Track Hitron CODA cable modem metrics for optimized internet connectivity and performance. |
454
-| [Huawei devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/huawei_devices.md) | Keep tabs on Huawei HiLink device metrics for optimized connectivity and performance. |
398
| [Keepalived](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/keepalived.md) | Track Keepalived metrics for efficient high-availability and load balancing management. |
456
-| [NetFlow](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/netflow.md) | Track NetFlow network traffic metrics for efficient network monitoring and performance. |
457
-| [NetMeter](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/netmeter.md) | Monitor NetMeter network traffic metrics for efficient network management and performance. |
399
| [Open vSwitch](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/open_vswitch.md) | Keep an eye on Open vSwitch software-defined networking metrics for efficient network virtualization and performance. |
400
| [OpenROADM devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openroadm_devices.md) | Monitor OpenROADM optical transport network metrics using the NETCONF protocol for efficient network management and performance. |
401
| [Optical modules](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/ethtool/integrations/optical_modules.md) | This collector monitors optical transceiver modules' diagnostic parameters (temperature, voltage, laser bias current, transmit/receive power levels) from network interfaces equipped with modules that support Digital Diagnostic Monitoring (DDM). |
402
| [RIPE Atlas](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ripe_atlas.md) | Keep tabs on RIPE Atlas Internet measurement platform metrics for efficient network monitoring and performance. |
403
| [SONiC NOS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sonic_nos.md) | Keep tabs on Software for Open Networking in the Cloud (SONiC) metrics for efficient network switch management and performance. |
404
| [Starlink (SpaceX)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/starlink_spacex.md) | Monitor SpaceX Starlink satellite internet metrics for efficient internet service management and performance. |
464
-| [Traceroute](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/traceroute.md) | Export traceroute metrics for efficient network path analysis and performance monitoring. |
405
| [Ubiquiti UFiber OLT](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ubiquiti_ufiber_olt.md) | Track Ubiquiti UFiber GPON (Gigabit Passive Optical Network) device metrics for efficient fiber-optic network management and performance. |
406
407
### Synthetic Checks
@@ -475,7 +415,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
415
| [IOPing](https://github.com/netdata/netdata/blob/master/src/collectors/ioping.plugin/integrations/ioping.md) | Monitor IOPing metrics for efficient disk I/O latency tracking. |
416
| [Monit](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/monit/integrations/monit.md) | This collector monitors status of Monit's service checks. |
417
| [Ping](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/ping/integrations/ping.md) | This module measures round-trip time and packet loss by sending ping messages to network hosts. |
478
-| [Pingdom](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/pingdom.md) | Monitor Pingdom website monitoring service metrics for efficient website performance management and diagnostics. |
418
| [Site 24x7](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/site_24x7.md) | Monitor Site24x7 website and infrastructure monitoring metrics for efficient performance tracking and management. |
419
| [TCP/UDP Endpoints](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/portcheck/integrations/tcp-udp_endpoints.md) | Collector for monitoring service availability and response time. |
420
| [Uptimerobot](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/uptimerobot.md) | Monitor UptimeRobot website uptime monitoring metrics for efficient website availability tracking and management. |
@@ -495,7 +434,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
434
| Integration | Description |
435
|-------------|-------------|
436
| [APC UPS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/apcupsd/integrations/apc_ups.md) | This collector monitors Uninterruptible Power Supplies by polling the Apcupsd daemon. |
498
-| [Eaton UPS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/eaton_ups.md) | Monitor Eaton uninterruptible power supply (UPS) metrics for efficient power management and monitoring. |
437
| [UPS (NUT)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/upsd/integrations/ups_nut.md) | This collector monitors Uninterruptible Power Supplies by polling the UPS daemon using the NUT network protocol. |
438
439
### Logs Servers
@@ -514,15 +452,12 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
452
453
| Integration | Description |
454
|-------------|-------------|
517
-| [Certificate Transparency](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/certificate_transparency.md) | Track certificate transparency log metrics for enhanced SSL/TLS certificate management and security. |
455
| [ClamAV daemon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/clamav_daemon.md) | Track ClamAV antivirus metrics for enhanced threat detection and management. |
456
| [Clamscan results](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/clamscan_results.md) | Monitor ClamAV scanning performance metrics for efficient malware detection and analysis. |
457
| [Crowdsec](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/crowdsec.md) | Monitor Crowdsec security metrics for efficient threat detection and response. |
458
| [Honeypot](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/honeypot.md) | Monitor honeypot metrics for efficient threat detection and management. |
459
| [Lynis audit reports](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/lynis_audit_reports.md) | Track Lynis security auditing tool metrics for efficient system security and compliance management. |
523
-| [OpenVAS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openvas.md) | Monitor OpenVAS vulnerability scanner metrics for efficient security assessment and management. |
460
| [Rspamd](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/rspamd/integrations/rspamd.md) | This collector monitors the activity and performance of Rspamd servers. |
525
-| [SSL Certificate](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ssl_certificate.md) | Track SSL/TLS certificate metrics for efficient web security and certificate management. |
461
| [Suricata](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/suricata.md) | Keep an eye on Suricata network intrusion detection and prevention system (IDS/IPS) metrics for efficient network security and performance. |
462
| [Vault PKI](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/vault_pki.md) | Monitor HashiCorp Vault Public Key Infrastructure (PKI) metrics for efficient certificate management and security. |
463
@@ -534,9 +469,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
469
| [Dynatrace](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dynatrace.md) | Monitor Dynatrace APM metrics for comprehensive application performance management. |
470
| [Grafana](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/grafana.md) | Keep tabs on Grafana dashboard and visualization metrics for optimized monitoring and data analysis. |
471
| [Hubble](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hubble.md) | Monitor Hubble network observability metrics for efficient network visibility and management. |
537
-| [Naemon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/naemon.md) | Monitor Naemon or Nagios network monitoring metrics for efficient IT infrastructure management and performance. |
472
| [Nagios](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nagios.md) | Keep tabs on Nagios network monitoring metrics for efficient IT infrastructure management and performance. |
539
-| [New Relic](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/new_relic.md) | Monitor New Relic application performance management metrics for efficient application monitoring and performance. |
473
474
### Gaming
475
@@ -544,7 +477,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
477
|-------------|-------------|
478
| [BungeeCord](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/bungeecord.md) | Track BungeeCord proxy server metrics for efficient load balancing and performance management. |
479
| [Minecraft](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/minecraft.md) | Track Minecraft server metrics for efficient game server management and performance. |
547
-| [OpenRCT2](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openrct2.md) | Track OpenRCT2 game metrics for efficient game server management and performance. |
480
| [SpigotMC](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/spigotmc/integrations/spigotmc.md) | This collector monitors SpigotMC server server performance, in the form of ticks per second average, memory utilization, and active users. |
481
| [Steam](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/steam.md) | Gain insights into Steam A2S-supported game servers for performance and availability through real-time metric monitoring. |
482
@@ -552,24 +484,17 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
484
485
| Integration | Description |
486
|-------------|-------------|
555
-| [Airthings Waveplus air sensor](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/airthings_waveplus_air_sensor.md) | Track Waveplus radon sensor metrics for efficient indoor air quality monitoring and management. |
556
-| [Bobcat Miner 300](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/bobcat_miner_300.md) | Monitor Bobcat equipment metrics for optimized performance and maintenance management. |
487
| [Christ Elektronik CLM5IP power panel](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/christ_elektronik_clm5ip_power_panel.md) | Monitor Christ Elektronik CLM5IP device metrics for efficient performance and diagnostics. |
488
| [CraftBeerPi](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/craftbeerpi.md) | Keep an eye on CraftBeerPi homebrewing metrics for optimized brewing process management. |
489
| [Dutch Electricity Smart Meter](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dutch_electricity_smart_meter.md) | Keep tabs on Dutch smart meter P1 port metrics for efficient energy management and monitoring. |
490
| [Elgato Key Light devices.](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/elgato_key_light_devices..md) | Keep tabs on Elgato Key Light metrics for optimized lighting control and management. |
491
| [Energomera smart power meters](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/energomera_smart_power_meters.md) | Track Energomera electricity meter metrics for efficient energy management and monitoring. |
562
-| [Helium hotspot](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/helium_hotspot.md) | Track Helium hotspot metrics for optimized LoRaWAN network management and performance. |
492
| [Homebridge](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/homebridge.md) | Monitor Homebridge smart home metrics for efficient home automation management and performance. |
493
| [Homey](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/homey.md) | Track Homey smart home controller metrics for efficient home automation and performance. |
565
-| [iqAir AirVisual air quality monitors](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/iqair_airvisual_air_quality_monitors.md) | Monitor air quality data from IQAir devices for efficient environmental monitoring and analysis. |
494
| [Jarvis Standing Desk](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/jarvis_standing_desk.md) | Track Jarvis standing desk usage metrics for efficient workspace ergonomics and management. |
495
| [Modbus protocol](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/modbus_protocol.md) | Track Modbus RTU protocol metrics for efficient industrial automation and control performance. |
568
-| [Monnit Sensors MQTT](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/monnit_sensors_mqtt.md) | Track Monnit sensor data via MQTT for efficient IoT device monitoring and management. |
569
-| [MP707 USB thermometer](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mp707_usb_thermometer.md) | Track MP707 power strip metrics for efficient energy management and monitoring. |
496
| [Nature Remo E lite devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nature_remo_e_lite_devices.md) | Monitor Nature Remo E series smart home device metrics for efficient home automation and energy management. |
497
| [Netatmo sensors](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/netatmo_sensors.md) | Keep an eye on Netatmo smart home device metrics for efficient home automation and energy management. |
572
-| [OpenHAB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openhab.md) | Track openHAB smart home automation system metrics for efficient home automation and energy management. |
498
| [Personal Weather Station](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/personal_weather_station.md) | Track personal weather station metrics for efficient weather monitoring and management. |
499
| [Philips Hue](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/philips_hue.md) | Keep an eye on Philips Hue smart lighting metrics for efficient home automation and energy management. |
500
| [Pimoroni Enviro+](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/pimoroni_enviro+.md) | Track Pimoroni Enviro+ air quality and environmental metrics for efficient environmental monitoring and analysis. |
@@ -581,14 +506,11 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
506
| [SMA Inverters](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sma_inverters.md) | Monitor SMA solar inverter metrics for efficient solar energy management and monitoring. |
507
| [Smart meters SML](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/smart_meters_sml.md) | Monitor Smart Message Language (SML) metrics for efficient smart metering and energy management. |
508
| [Solar logging stick](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/solar_logging_stick.md) | Monitor solar energy metrics using a solar logging stick for efficient solar energy management and monitoring. |
584
-| [SolarEdge inverters](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/solaredge_inverters.md) | Track SolarEdge solar inverter metrics for efficient solar energy management and monitoring. |
509
| [Solis Ginlong 5G inverters](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/solis_ginlong_5g_inverters.md) | Monitor Solis solar inverter metrics for efficient solar energy management and monitoring. |
510
| [Sunspec Solar Energy](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sunspec_solar_energy.md) | Monitor SunSpec Alliance solar energy metrics for efficient solar energy management and monitoring. |
511
| [Tado smart heating solution](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tado_smart_heating_solution.md) | Monitor Tado smart thermostat metrics for efficient home heating and cooling management. |
588
-| [Tesla Powerwall](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tesla_powerwall.md) | Monitor Tesla Powerwall metrics for efficient home energy storage and management. |
512
| [Tesla vehicle](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tesla_vehicle.md) | Track Tesla vehicle metrics for efficient electric vehicle management and monitoring. |
513
| [Tesla Wall Connector](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tesla_wall_connector.md) | Monitor Tesla Wall Connector charging station metrics for efficient electric vehicle charging management. |
591
-| [TP-Link P110](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tp-link_p110.md) | Track TP-Link P110 smart plug metrics for efficient energy management and monitoring. |
514
| [Xiaomi Mi Flora](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/xiaomi_mi_flora.md) | Keep tabs on MiFlora plant monitor metrics for efficient plant care and growth management. |
515
516
### Media Services
@@ -599,9 +521,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
521
| [Icecast](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/icecast/integrations/icecast.md) | This collector monitors Icecast listener counts. |
522
| [OBS Studio](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/obs_studio.md) | Track OBS Studio live streaming and recording software metrics for efficient video production and performance. |
523
| [SABnzbd](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sabnzbd.md) | Monitor SABnzbd Usenet client metrics for efficient file downloads and resource management. |
602
-| [Stream](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/stream.md) | Monitor streaming metrics for efficient media streaming and performance. |
524
| [Twitch](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/twitch.md) | Track Twitch streaming platform metrics for efficient live streaming management and performance. |
604
-| [Zulip](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/zulip.md) | Monitor Zulip open-source group chat application metrics for efficient team communication management and performance. |
525
526
### Authentication and Authorization
527
@@ -609,19 +529,14 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
529
|-------------|-------------|
530
| [Fail2ban](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/fail2ban/integrations/fail2ban.md) | This collector tracks two main metrics for each jail: currently banned IPs and active failure incidents. |
531
| [FreeRADIUS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/freeradius/integrations/freeradius.md) | This collector monitors FreeRADIUS servers. |
612
-| [HashiCorp Vault secrets](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hashicorp_vault_secrets.md) | Track HashiCorp Vault security assessment metrics for efficient secrets management and security. |
613
-| [LDAP](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ldap.md) | Keep an eye on Lightweight Directory Access Protocol (LDAP) metrics for efficient directory service management and performance. |
532
| [OpenLDAP](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/openldap/integrations/openldap.md) | This collector monitors OpenLDAP metrics about connections, operations, referrals and more. |
615
-| [OpenLDAP (community)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openldap_community.md) | Monitor OpenLDAP directory service metrics for efficient directory management and performance. |
533
| [RADIUS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/radius.md) | Keep tabs on RADIUS (Remote Authentication Dial-In User Service) protocol metrics for efficient authentication and access management. |
617
-| [SSH](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ssh.md) | Monitor SSH server metrics for efficient secure shell server management and performance. |
534
| [TACACS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tacacs.md) | Track Terminal Access Controller Access-Control System (TACACS) protocol metrics for efficient network authentication and authorization management. |
535
536
### DNS and DHCP Servers
537
538
| Integration | Description |
539
|-------------|-------------|
624
-| [Akamai Edge DNS Traffic](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/akamai_edge_dns_traffic.md) | Track and analyze Akamai Edge DNS traffic for enhanced performance and security. |
540
| [CoreDNS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/coredns/integrations/coredns.md) | This collector monitors CoreDNS instances. |
541
| [DNS query](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/dnsquery/integrations/dns_query.md) | This module monitors DNS query round-trip time (RTT). |
542
| [DNSBL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dnsbl.md) | Monitor DNSBL metrics for efficient domain reputation and security management. |
@@ -644,7 +559,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
559
| [Dovecot](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/dovecot/integrations/dovecot.md) | This collector monitors Dovecot metrics about sessions, logins, commands, page faults and more. |
560
| [Exim](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/exim/integrations/exim.md) | This collector monitors Exim mail queue. |
561
| [Halon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/halon.md) | Monitor Halon email security and delivery metrics for optimized email management and protection. |
647
-| [Maildir](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/maildir.md) | Track mail server metrics for optimized email management and performance. |
562
| [Postfix](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/postfix/integrations/postfix.md) | This collector retrieves statistics about the Postfix mail queue using the [postqueue](https://www.postfix.org/postqueue.1.html) command-line tool. |
563
564
### Processes and System Services
@@ -661,24 +575,16 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
575
| Integration | Description |
576
|-------------|-------------|
577
| [Adaptec RAID](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/adaptecraid/integrations/adaptec_raid.md) | Monitors the health of Adaptec Hardware RAID by tracking the status of logical and physical devices in your storage system. |
664
-| [Altaro Backup](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/altaro_backup.md) | Track Altaro Backup performance metrics to ensure smooth data protection and recovery operations. |
665
-| [Borg backup](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/borg_backup.md) | Track Borg backup performance metrics for efficient data protection and recovery. |
578
| [Ceph](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/ceph/integrations/ceph.md) | This collector monitors the overall health status and performance of your Ceph clusters. |
667
-| [CVMFS clients](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/cvmfs_clients.md) | Track CernVM File System metrics for optimized distributed file system performance and management. |
668
-| [Dell EMC Isilon cluster](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_isilon_cluster.md) | Track Dell EMC Isilon scale-out NAS metrics for efficient storage management and performance. |
579
| [Dell EMC ScaleIO](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/scaleio/integrations/dell_emc_scaleio.md) | This collector monitors ScaleIO (VxFlex OS) instances via VxFlex OS Gateway API. |
670
-| [Dell EMC XtremIO cluster](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_xtremio_cluster.md) | Keep an eye on Dell/EMC XtremIO storage metrics for optimized data management and performance. |
671
-| [Dell PowerMax](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_powermax.md) | Monitor Dell EMC PowerMax storage array metrics for efficient storage management and performance. |
580
| [DMCache devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/dmcache/integrations/dmcache_devices.md) | This collector monitors DMCache, providing insights into capacity usage, efficiency, and activity. |
581
| [EOS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/eos.md) | Monitor CERN EOS metrics for efficient storage management. |
582
| [Generic storage enclosure tool](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/generic_storage_enclosure_tool.md) | Monitor storage enclosure metrics for efficient storage device management and performance. |
583
| [Hadoop Distributed File System (HDFS)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/hdfs/integrations/hadoop_distributed_file_system_hdfs.md) | This collector monitors HDFS nodes. |
676
-| [HDSentinel](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hdsentinel.md) | Monitor Hard Disk Sentinel metrics for efficient storage device health management and diagnostics. |
584
| [HPE Smart Arrays](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/hpssa/integrations/hpe_smart_arrays.md) | Monitors the health of HPE Smart Arrays by tracking the status of controllers, arrays, logical and physical drives in your storage system. |
585
| [IBM Spectrum](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_spectrum.md) | Monitor IBM Spectrum storage metrics for efficient data management and performance. |
586
| [IBM Spectrum Virtualize](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_spectrum_virtualize.md) | Monitor IBM Spectrum Virtualize metrics for efficient storage virtualization and performance. |
587
| [IPFS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/ipfs/integrations/ipfs.md) | This collector monitors IPFS daemon health and network activity. |
681
-| [Lagerist Disk latency](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/lagerist_disk_latency.md) | Track disk latency metrics for efficient storage performance and diagnostics. |
588
| [LVM logical volumes](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/lvm/integrations/lvm_logical_volumes.md) | This collector monitors the health of LVM logical volumes. |
589
| [MegaCLI MegaRAID](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/megacli/integrations/megacli_megaraid.md) | Monitors the health of MegaCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system. |
590
| [MogileFS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mogilefs.md) | Monitor MogileFS distributed file system metrics for efficient storage management and performance. |
@@ -686,7 +592,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
592
| [NetApp Solidfire](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/netapp_solidfire.md) | Track NetApp Solidfire storage system metrics for efficient data storage management and performance. |
593
| [NVMe devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/nvme/integrations/nvme_devices.md) | This collector monitors the health of NVMe devices. |
594
| [Samba](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/samba/integrations/samba.md) | This collector monitors Samba syscalls and SMB2 calls. |
689
-| [Starwind VSAN VSphere Edition](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/starwind_vsan_vsphere_edition.md) | Keep tabs on StarWind Virtual SAN metrics for efficient storage virtualization and performance. |
595
| [StoreCLI RAID](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/storcli/integrations/storecli_raid.md) | Monitors the health of StoreCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system. |
596
| [Storidge](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/storidge.md) | Keep an eye on Storidge storage metrics for efficient storage management and performance. |
597
| [Synology ActiveBackup](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/synology_activebackup.md) | Track Synology Active Backup metrics for efficient backup and data protection management. |
@@ -704,7 +609,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
609
610
| Integration | Description |
611
|-------------|-------------|
707
-| [GTP](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/gtp.md) | Keep an eye on GTP (GPRS Tunneling Protocol) metrics for optimized mobile data communication and performance. |
612
| [Kannel](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/kannel.md) | Keep tabs on Kannel SMS gateway and WAP gateway metrics for efficient mobile communication and performance. |
613
| [OpenSIPS](https://github.com/netdata/netdata/blob/master/src/collectors/charts.d.plugin/opensips/integrations/opensips.md) | Examine OpenSIPS metrics for insights into SIP server operations. |
614
@@ -717,7 +621,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
621
| [OpenVPN](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/openvpn/integrations/openvpn.md) | This collector monitors OpenVPN servers. |
622
| [OpenVPN status log](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/openvpn_status_log/integrations/openvpn_status_log.md) | This collector monitors OpenVPN server. |
623
| [SoftEther VPN Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/softether_vpn_server.md) | Monitor SoftEther VPN Server metrics for efficient virtual private network (VPN) management and performance. |
720
-| [Speedify CLI](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/speedify_cli.md) | Track Speedify VPN metrics for efficient virtual private network (VPN) management and performance. |
624
| [strongSwan](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/strongswan.md) | Track strongSwan VPN and IPSec metrics using the vici interface for efficient virtual private network (VPN) management and performance. |
625
| [Tor](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/tor/integrations/tor.md) | Tracks Tor's download and upload traffic, as well as its uptime. |
626
| [WireGuard](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/wireguard/integrations/wireguard.md) | This collector monitors WireGuard VPN devices and peers traffic. |
@@ -727,12 +630,8 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
630
| Integration | Description |
631
|-------------|-------------|
632
| [Chia](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/chia.md) | Track Chia blockchain metrics for optimized farming and resource allocation. |
730
-| [Crypto exchanges](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/crypto_exchanges.md) | Track cryptocurrency market metrics for informed investment and trading decisions. |
633
| [Cryptowatch](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/cryptowatch.md) | Keep tabs on Cryptowatch market data metrics for comprehensive cryptocurrency market analysis. |
634
| [Go-ethereum](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/geth/integrations/go-ethereum.md) | This collector monitors Go-ethereum instances. |
733
-| [Helium miner (validator)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/helium_miner_validator.md) | Monitor Helium miner and validator metrics for efficient blockchain performance and management. |
734
-| [IOTA full node](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/iota_full_node.md) | Keep an eye on IOTA cryptocurrency network metrics for efficient blockchain performance and management. |
735
-| [Sia](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sia.md) | Track Sia decentralized storage platform metrics for efficient storage management and performance. |
635
636
### Distributed Computing Systems
637
@@ -744,17 +643,11 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
643
644
| Integration | Description |
645
|-------------|-------------|
747
-| [Custom Exporter](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/custom_exporter.md) | Create and monitor custom metrics tailored to your specific use case and requirements. |
748
-| [Excel spreadsheet](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/excel_spreadsheet.md) | Export Prometheus metrics to Excel for versatile data analysis and reporting. |
749
-| [Generic Command Line Output](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/generic_command_line_output.md) | Track custom command line output metrics for tailored monitoring and management. |
750
-| [JetBrains Floating License Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/jetbrains_floating_license_server.md) | Monitor JetBrains floating license server metrics for efficient software licensing management. |
646
| [OpenWeatherMap](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openweathermap.md) | Track OpenWeatherMap weather data and air pollution metrics for efficient environmental monitoring and analysis. |
647
| [Pandas](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/integrations/pandas.md) | [Pandas](https://pandas.pydata.org/) is a de-facto standard in reading and processing most types of structured data in Python. |
648
| [Prometheus endpoint](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/prometheus_endpoint.md) | This generic Prometheus collector gathers metrics from any [`Prometheus`](https://prometheus.io/) endpoints. |
754
-| [Shell command](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/shell_command.md) | Track custom command output metrics for tailored monitoring and management. |
649
| [SNMP devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md) | This collector discovers and monitors any SNMP-enabled network device. |
650
| [Tankerkoenig API](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tankerkoenig_api.md) | Track Tankerknig API fuel price metrics for efficient fuel price monitoring and management. |
757
-| [TwinCAT ADS Web Service](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/twincat_ads_web_service.md) | Monitor TwinCAT ADS (Automation Device Specification) Web Service metrics for efficient industrial automation and control. |
651
652
### System Clock and NTP
653
src/go/plugin/go.d/collector/prometheus/integrations/airthings_waveplus_air_sensor.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/airthings_waveplus_air_sensor.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Airthings Waveplus air sensor"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# Airthings Waveplus air sensor
12
-
13
-
14
-<img src="https://netdata.cloud/img/airthings.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
-Track Waveplus radon sensor metrics for efficient indoor air quality monitoring and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Waveplus Radon Sensor Exporter](https://github.com/jeremybz/waveplus_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Waveplus Radon Sensor Exporter](https://github.com/jeremybz/waveplus_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/akamai_edge_dns_traffic.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/akamai_edge_dns_traffic.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Akamai Edge DNS Traffic"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/DNS and DHCP Servers"
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
-# Akamai Edge DNS Traffic
12
-
13
-
14
-<img src="https://netdata.cloud/img/akamai.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
-Track and analyze Akamai Edge DNS traffic for enhanced performance and security.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Akamai Edge DNS Traffic Exporter](https://github.com/akamai/akamai-edgedns-traffic-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Akamai Edge DNS Traffic Exporter](https://github.com/akamai/akamai-edgedns-traffic-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/akamai_global_traffic_management.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/akamai_global_traffic_management.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Akamai Global Traffic Management"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
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
-# Akamai Global Traffic Management
12
-
13
-
14
-<img src="https://netdata.cloud/img/akamai.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 vital metrics of Akamai Global Traffic Management (GTM) for optimized load balancing and failover.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Akamai Global Traffic Management Metrics Exporter](https://github.com/akamai/akamai-gtm-metrics-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Akamai Global Traffic Management Metrics Exporter](https://github.com/akamai/akamai-gtm-metrics-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/akami_cloudmonitor.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/akami_cloudmonitor.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Akami Cloudmonitor"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'scalability']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Akami Cloudmonitor
13
-
14
-
15
-<img src="https://netdata.cloud/img/akamai.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor Akamai cloudmonitor provider metrics for comprehensive cloud performance management.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Cloudmonitor exporter](https://github.com/ExpressenAB/cloudmonitor_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Cloudmonitor exporter](https://github.com/ExpressenAB/cloudmonitor_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/alibaba_cloud.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/alibaba_cloud.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Alibaba Cloud"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'scalability']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Alibaba Cloud
13
-
14
-
15
-<img src="https://netdata.cloud/img/alibaba-cloud.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor Alibaba Cloud services and resources for efficient management and cost optimization.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Alibaba Cloud Exporter](https://github.com/aylei/aliyun-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Alibaba Cloud Exporter](https://github.com/aylei/aliyun-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/altaro_backup.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/altaro_backup.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Altaro Backup"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# Altaro Backup
12
-
13
-
14
-<img src="https://netdata.cloud/img/altaro.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
-Track Altaro Backup performance metrics to ensure smooth data protection and recovery operations.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Altaro Backup Exporter](https://github.com/raph2i/altaro_backup_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Altaro Backup Exporter](https://github.com/raph2i/altaro_backup_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/andrews_&_arnold_line_status.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/andrews_&_arnold_line_status.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Andrews & Arnold line status"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
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
-# Andrews & Arnold line status
12
-
13
-
14
-<img src="https://netdata.cloud/img/andrewsarnold.jpg" 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
-Track Andrews & Arnold Ltd (AAISP) metrics for improved network performance and diagnostics.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Andrews & Arnold line status exporter](https://github.com/daveio/aaisp-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Andrews & Arnold line status exporter](https://github.com/daveio/aaisp-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/apache_airflow.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/apache_airflow.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Apache Airflow"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/APM"
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
-# Apache Airflow
12
-
13
-
14
-<img src="https://netdata.cloud/img/airflow.png" 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 Apache Airflow metrics to optimize task scheduling and workflow management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Airflow exporter](https://github.com/shalb/airflow-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Airflow exporter](https://github.com/shalb/airflow-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/apache_flink.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/apache_flink.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Apache Flink"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/APM"
7
-most_popular: False
8
-keywords: ['web server', 'http', 'https']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Apache Flink
13
-
14
-
15
-<img src="https://netdata.cloud/img/apache_flink.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep an eye on Apache Flink metrics for efficient stream processing and application management.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Apache Flink Metrics Reporter](https://github.com/matsumana/flink_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Apache Flink Metrics Reporter](https://github.com/matsumana/flink_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/apple_time_machine.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/apple_time_machine.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Apple Time Machine"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/macOS Systems"
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
-# Apple Time Machine
12
-
13
-
14
-<img src="https://netdata.cloud/img/apple.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
-Track Apple Time Machine backup metrics for efficient data protection and recovery.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Apple Time Machine Exporter](https://github.com/znerol/prometheus-timemachine-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Apple Time Machine Exporter](https://github.com/znerol/prometheus-timemachine-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/arm_hwcpipe.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/arm_hwcpipe.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "ARM HWCPipe"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
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
-# ARM HWCPipe
12
-
13
-
14
-<img src="https://netdata.cloud/img/arm.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
-Keep track of ARM running Android devices and get metrics for efficient performance optimization.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [ARM HWCPipe Exporter](https://github.com/ylz-at/arm-hwcpipe-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [ARM HWCPipe Exporter](https://github.com/ylz-at/arm-hwcpipe-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/aruba_devices.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/aruba_devices.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Aruba devices"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-keywords: ['network monitoring', 'network performance', 'aruba devices']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Aruba devices
13
-
14
-
15
-<img src="https://netdata.cloud/img/aruba.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor Aruba Networks devices performance metrics for comprehensive network management and analysis.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Aruba Exporter](https://github.com/slashdoom/aruba_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Aruba Exporter](https://github.com/slashdoom/aruba_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/arvancloud_cdn.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/arvancloud_cdn.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "ArvanCloud CDN"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'scalability']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# ArvanCloud CDN
13
-
14
-
15
-<img src="https://netdata.cloud/img/arvancloud.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Track and analyze ArvanCloud CDN and cloud services performance metrics for optimized delivery and management.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [ArvanCloud exporter](https://github.com/arvancloud/ar-prometheus-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [ArvanCloud exporter](https://github.com/arvancloud/ar-prometheus-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/audisto.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/audisto.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Audisto"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/APM"
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
-# Audisto
12
-
13
-
14
-<img src="https://netdata.cloud/img/audisto.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 Audisto SEO and website metrics for improved search performance and optimization.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Audisto exporter](https://github.com/ZeitOnline/audisto_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Audisto exporter](https://github.com/ZeitOnline/audisto_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/aws_ec2_spot_instance.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_ec2_spot_instance.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "AWS EC2 Spot Instance"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'aws services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# AWS EC2 Spot Instance
13
-
14
-
15
-<img src="https://netdata.cloud/img/aws-ec2.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor AWS EC2 Spot instances'' performance metrics for efficient resource allocation and cost optimization.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [AWS EC2 Spot Exporter](https://github.com/patcadelina/ec2-spot-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [AWS EC2 Spot Exporter](https://github.com/patcadelina/ec2-spot-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/aws_ecs.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_ecs.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "AWS ECS"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'aws services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# AWS ECS
13
-
14
-
15
-<img src="https://netdata.cloud/img/amazon-ecs.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep an eye on AWS ECS services and resources for optimized container management and orchestration.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [AWS ECS exporter](https://github.com/bevers222/ecs-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [AWS ECS exporter](https://github.com/bevers222/ecs-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/aws_health_events.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_health_events.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "AWS Health events"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'aws services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# AWS Health events
13
-
14
-
15
-<img src="https://netdata.cloud/img/aws.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Track AWS service health metrics for proactive incident management and resolution.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [AWS Health Exporter](https://github.com/vladvasiliu/aws-health-exporter-rs).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [AWS Health Exporter](https://github.com/vladvasiliu/aws-health-exporter-rs) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/aws_instance_health.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_instance_health.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "AWS instance health"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'aws services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# AWS instance health
13
-
14
-
15
-<img src="https://netdata.cloud/img/aws.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor the health of AWS instances for improved performance and availability.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [AWS instance health exporter](https://github.com/bobtfish/aws-instance-health-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [AWS instance health exporter](https://github.com/bobtfish/aws-instance-health-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/aws_s3_buckets.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_s3_buckets.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "AWS S3 buckets"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'aws services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# AWS S3 buckets
13
-
14
-
15
-<img src="https://netdata.cloud/img/aws-s3.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor AWS S3 storage metrics for optimized performance, data management, and cost efficiency.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [AWS S3 Exporter](https://github.com/ribbybibby/s3_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [AWS S3 Exporter](https://github.com/ribbybibby/s3_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/aws_sqs.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/aws_sqs.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "AWS SQS"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'aws services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# AWS SQS
13
-
14
-
15
-<img src="https://netdata.cloud/img/aws-sqs.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Track AWS SQS messaging metrics for efficient message processing and queue management.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [AWS SQS Exporter](https://github.com/jmal98/sqs-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [AWS SQS Exporter](https://github.com/jmal98/sqs-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/azure_ad_app_passwords.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_ad_app_passwords.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Azure AD App passwords"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'azure services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Azure AD App passwords
13
-
14
-
15
-<img src="https://netdata.cloud/img/azure.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Safeguard and track Azure App secrets for enhanced security and access management.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Azure App Secrets monitor](https://github.com/vladvasiliu/azure-app-secrets-monitor).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Azure App Secrets monitor](https://github.com/vladvasiliu/azure-app-secrets-monitor) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/azure_application.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_application.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Azure application"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'azure services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Azure application
13
-
14
-
15
-<img src="https://netdata.cloud/img/azure.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Track Azure Monitor metrics for comprehensive resource management and performance optimization.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Azure Monitor exporter](https://github.com/RobustPerception/azure_metrics_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Azure Monitor exporter](https://github.com/RobustPerception/azure_metrics_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/azure_elastic_pool_sql.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_elastic_pool_sql.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Azure Elastic Pool SQL"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['database', 'relational db', 'data querying']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Azure Elastic Pool SQL
13
-
14
-
15
-<img src="https://netdata.cloud/img/azure-elastic-sql.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor Azure Elastic SQL performance metrics for efficient database management and query optimization.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Azure Elastic SQL Exporter](https://github.com/benclapp/azure_elastic_sql_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Azure Elastic SQL Exporter](https://github.com/benclapp/azure_elastic_sql_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/azure_resources.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_resources.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Azure Resources"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'azure services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Azure Resources
13
-
14
-
15
-<img src="https://netdata.cloud/img/azure.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep tabs on Azure resources vital metrics for efficient cloud management and cost optimization.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Azure Resources Exporter](https://github.com/FXinnovation/azure_metrics_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Azure Resources Exporter](https://github.com/FXinnovation/azure_metrics_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/azure_service_bus.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_service_bus.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Azure Service Bus"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'azure services']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Azure Service Bus
13
-
14
-
15
-<img src="https://netdata.cloud/img/azure-service-bus.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor Azure Service Bus messaging metrics for optimized communication and integration.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Azure Service Bus Exporter](https://github.com/marcinbudny/servicebus_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Azure Service Bus Exporter](https://github.com/marcinbudny/servicebus_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/azure_sql.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/azure_sql.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Azure SQL"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
7
-most_popular: False
8
-keywords: ['database', 'relational db', 'data querying']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Azure SQL
13
-
14
-
15
-<img src="https://netdata.cloud/img/azure-sql.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Track Azure SQL performance metrics for efficient database management and query performance.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Azure SQL exporter](https://github.com/iamseth/azure_sql_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Azure SQL exporter](https://github.com/iamseth/azure_sql_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/bigquery.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/bigquery.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "BigQuery"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
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
-# BigQuery
12
-
13
-
14
-<img src="https://netdata.cloud/img/bigquery.png" 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 Google BigQuery metrics for optimized data processing and analysis.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [BigQuery Exporter](https://github.com/m-lab/prometheus-bigquery-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [BigQuery Exporter](https://github.com/m-lab/prometheus-bigquery-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/bobcat_miner_300.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/bobcat_miner_300.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Bobcat Miner 300"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# Bobcat Miner 300
12
-
13
-
14
-<img src="https://netdata.cloud/img/bobcat.jpg" 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 Bobcat equipment metrics for optimized performance and maintenance management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Bobcat Exporter](https://github.com/pperzyna/bobcat_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Bobcat Exporter](https://github.com/pperzyna/bobcat_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/borg_backup.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/borg_backup.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Borg backup"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# Borg backup
12
-
13
-
14
-<img src="https://netdata.cloud/img/borg.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
-Track Borg backup performance metrics for efficient data protection and recovery.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Borg backup exporter](https://github.com/k0ral/borg-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Borg backup exporter](https://github.com/k0ral/borg-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/bpftrace_variables.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/bpftrace_variables.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "bpftrace variables"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/APM"
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
-# bpftrace variables
12
-
13
-
14
-<img src="https://netdata.cloud/img/bpftrace.png" 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
-Track bpftrace metrics for advanced performance analysis and troubleshooting.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [bpftrace exporter](https://github.com/andreasgerstmayr/bpftrace_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [bpftrace exporter](https://github.com/andreasgerstmayr/bpftrace_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/cadvisor.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/cadvisor.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "cAdvisor"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Containers and VMs"
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
-# cAdvisor
12
-
13
-
14
-<img src="https://netdata.cloud/img/cadvisor.png" 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 container resource usage and performance metrics with cAdvisor for efficient container management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [cAdvisor](https://github.com/google/cadvisor).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [cAdvisor](https://github.com/google/cadvisor) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/certificate_transparency.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/certificate_transparency.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Certificate Transparency"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Security Systems"
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
-# Certificate Transparency
12
-
13
-
14
-<img src="https://netdata.cloud/img/ct.png" 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
-Track certificate transparency log metrics for enhanced
25
-SSL/TLS certificate management and security.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [ct-exporter](https://github.com/Hsn723/ct-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [ct-exporter](https://github.com/Hsn723/ct-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/checkpoint_device.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/checkpoint_device.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Checkpoint device"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
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
-# Checkpoint device
12
-
13
-
14
-<img src="https://netdata.cloud/img/checkpoint.png" 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
-Track Check Point firewall and security metrics for enhanced network protection and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Checkpoint exporter](https://github.com/RespiroConsulting/CheckPointExporter).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Checkpoint exporter](https://github.com/RespiroConsulting/CheckPointExporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/citrix_netscaler.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/citrix_netscaler.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Citrix NetScaler"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-keywords: ['network monitoring', 'network performance', 'traffic analysis']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Citrix NetScaler
13
-
14
-
15
-<img src="https://netdata.cloud/img/citrix.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep tabs on NetScaler performance metrics for efficient application delivery and load balancing.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Citrix NetScaler Exporter](https://github.com/rokett/Citrix-NetScaler-Exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Citrix NetScaler Exporter](https://github.com/rokett/Citrix-NetScaler-Exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/cloudflare_pcap.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/cloudflare_pcap.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Cloudflare PCAP"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Web Servers and Web Proxies"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'scalability']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Cloudflare PCAP
13
-
14
-
15
-<img src="https://netdata.cloud/img/cloudflare.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep tabs on Cloudflare CDN and security metrics for optimized content delivery and protection.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Cloudflare exporter](https://github.com/wehkamp/docker-prometheus-cloudflare-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Cloudflare exporter](https://github.com/wehkamp/docker-prometheus-cloudflare-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/crypto_exchanges.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/crypto_exchanges.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Crypto exchanges"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Blockchain Servers"
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
-# Crypto exchanges
12
-
13
-
14
-<img src="https://netdata.cloud/img/crypto.png" 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
-Track cryptocurrency market metrics for informed investment and trading decisions.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Crypto exporter](https://github.com/ix-ai/crypto-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Crypto exporter](https://github.com/ix-ai/crypto-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/custom_exporter.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/custom_exporter.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Custom Exporter"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Generic Collecting Metrics"
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
-# Custom Exporter
12
-
13
-
14
-<img src="https://netdata.cloud/img/customdata.png" 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
-Create and monitor custom metrics tailored to your specific use case and requirements.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Custom Exporter](https://github.com/orange-cloudfoundry/custom_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Custom Exporter](https://github.com/orange-cloudfoundry/custom_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/cvmfs_clients.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/cvmfs_clients.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "CVMFS clients"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# CVMFS clients
12
-
13
-
14
-<img src="https://netdata.cloud/img/cvmfs.png" 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
-Track CernVM File System metrics for optimized distributed file system performance and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [CVMFS exporter](https://github.com/guilbaults/cvmfs-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [CVMFS exporter](https://github.com/guilbaults/cvmfs-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/ddwrt_routers.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/ddwrt_routers.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "DDWRT Routers"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
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
-# DDWRT Routers
12
-
13
-
14
-<img src="https://netdata.cloud/img/ddwrt.png" 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
-Keep tabs on DD-WRT router metrics for efficient network management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [ddwrt-collector](https://github.com/camelusferus/ddwrt_collector).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [ddwrt-collector](https://github.com/camelusferus/ddwrt_collector) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_ecs_cluster.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_ecs_cluster.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Dell EMC ECS cluster"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
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
-# Dell EMC ECS cluster
12
-
13
-
14
-<img src="https://netdata.cloud/img/dell.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 Dell EMC ECS object storage metrics for optimized storage management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Dell EMC ECS Exporter](https://github.com/paychex/prometheus-emcecs-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Dell EMC ECS Exporter](https://github.com/paychex/prometheus-emcecs-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_isilon_cluster.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_isilon_cluster.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Dell EMC Isilon cluster"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# Dell EMC Isilon cluster
12
-
13
-
14
-<img src="https://netdata.cloud/img/dell.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
-Track Dell EMC Isilon scale-out NAS metrics for efficient storage management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Dell EMC Isilon Exporter](https://github.com/paychex/prometheus-isilon-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Dell EMC Isilon Exporter](https://github.com/paychex/prometheus-isilon-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_xtremio_cluster.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_emc_xtremio_cluster.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Dell EMC XtremIO cluster"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# Dell EMC XtremIO cluster
12
-
13
-
14
-<img src="https://netdata.cloud/img/dell.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
-Keep an eye on Dell/EMC XtremIO storage metrics for optimized data management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Dell/EMC XtremIO Exporter](https://github.com/cthiel42/prometheus-xtremio-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Dell/EMC XtremIO Exporter](https://github.com/cthiel42/prometheus-xtremio-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/dell_powermax.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/dell_powermax.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Dell PowerMax"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# Dell PowerMax
12
-
13
-
14
-<img src="https://netdata.cloud/img/powermax.png" 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 Dell EMC PowerMax storage array metrics for efficient storage management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [PowerMax Exporter](https://github.com/kckecheng/powermax_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [PowerMax Exporter](https://github.com/kckecheng/powermax_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/dependency-track.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/dependency-track.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Dependency-Track"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/APM"
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
-# Dependency-Track
12
-
13
-
14
-<img src="https://netdata.cloud/img/dependency-track.png" 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 Dependency-Track metrics for efficient vulnerability management and software supply chain analysis.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Dependency-Track Exporter](https://github.com/jetstack/dependency-track-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Dependency-Track Exporter](https://github.com/jetstack/dependency-track-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/digitalocean.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/digitalocean.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "DigitalOcean"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
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
-# DigitalOcean
12
-
13
-
14
-<img src="https://netdata.cloud/img/digitalocean.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
-Track DigitalOcean cloud provider metrics for optimized resource management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [DigitalOcean Exporter](https://github.com/metalmatze/digitalocean_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [DigitalOcean Exporter](https://github.com/metalmatze/digitalocean_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/eaton_ups.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/eaton_ups.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Eaton UPS"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/UPS"
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
-# Eaton UPS
12
-
13
-
14
-<img src="https://netdata.cloud/img/eaton.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 Eaton uninterruptible power supply (UPS) metrics for efficient power management and monitoring.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Prometheus Eaton UPS Exporter](https://github.com/psyinfra/prometheus-eaton-ups-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Prometheus Eaton UPS Exporter](https://github.com/psyinfra/prometheus-eaton-ups-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/excel_spreadsheet.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/excel_spreadsheet.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Excel spreadsheet"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Generic Collecting Metrics"
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
-# Excel spreadsheet
12
-
13
-
14
-<img src="https://netdata.cloud/img/excel.png" 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
-Export Prometheus metrics to Excel for versatile data analysis and reporting.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Excel Exporter](https://github.com/MarcusCalidus/excel-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Excel Exporter](https://github.com/MarcusCalidus/excel-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/gcp_quota.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/gcp_quota.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "GCP Quota"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
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
-# GCP Quota
12
-
13
-
14
-<img src="https://netdata.cloud/img/gcp.png" 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 Google Cloud Platform quota metrics for optimized resource usage and cost management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [GCP Quota Exporter](https://github.com/mintel/gcp-quota-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [GCP Quota Exporter](https://github.com/mintel/gcp-quota-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/generic_command_line_output.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/generic_command_line_output.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Generic Command Line Output"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Generic Collecting Metrics"
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
-# Generic Command Line Output
12
-
13
-
14
-<img src="https://netdata.cloud/img/cli.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
-Track custom command line output metrics for tailored monitoring and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Generic Command Line Output Exporter](https://github.com/MarioMartReq/generic-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Generic Command Line Output Exporter](https://github.com/MarioMartReq/generic-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/gtp.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/gtp.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "GTP"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Telephony Servers"
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
-# GTP
12
-
13
-
14
-<img src="https://netdata.cloud/img/gtpu.png" 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
-Keep an eye on GTP (GPRS Tunneling Protocol) metrics for optimized mobile data communication and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [GTP Exporter](https://github.com/wmnsk/gtp_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [GTP Exporter](https://github.com/wmnsk/gtp_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/hashicorp_vault_secrets.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/hashicorp_vault_secrets.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "HashiCorp Vault secrets"
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
-# HashiCorp Vault secrets
12
-
13
-
14
-<img src="https://netdata.cloud/img/vault.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
-Track HashiCorp Vault security assessment metrics for efficient secrets management and security.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Vault Assessment Prometheus Exporter](https://github.com/tomtom-international/vault-assessment-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Vault Assessment Prometheus Exporter](https://github.com/tomtom-international/vault-assessment-prometheus-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/hasura_graphql_server.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/hasura_graphql_server.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Hasura GraphQL Server"
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
-# Hasura GraphQL Server
12
-
13
-
14
-<img src="https://netdata.cloud/img/hasura.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
-Keep tabs on Hasura GraphQL engine metrics for optimized
25
-API performance and management.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Hasura Exporter](https://github.com/zolamk/hasura-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Hasura Exporter](https://github.com/zolamk/hasura-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/hdsentinel.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/hdsentinel.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "HDSentinel"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# HDSentinel
12
-
13
-
14
-<img src="https://netdata.cloud/img/harddisk.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 Hard Disk Sentinel metrics for efficient storage device health management and diagnostics.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [HDSentinel Exporter](https://github.com/qusielle/hdsentinel-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [HDSentinel Exporter](https://github.com/qusielle/hdsentinel-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/helium_hotspot.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/helium_hotspot.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Helium hotspot"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# Helium hotspot
12
-
13
-
14
-<img src="https://netdata.cloud/img/helium.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
-Track Helium hotspot metrics for optimized LoRaWAN network management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Helium hotspot exporter](https://github.com/tedder/helium_hotspot_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Helium hotspot exporter](https://github.com/tedder/helium_hotspot_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/helium_miner_validator.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/helium_miner_validator.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Helium miner (validator)"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Blockchain Servers"
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
-# Helium miner (validator)
12
-
13
-
14
-<img src="https://netdata.cloud/img/helium.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 Helium miner and validator metrics for efficient blockchain performance and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Helium miner (validator) exporter](https://github.com/tedder/miner_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Helium miner (validator) exporter](https://github.com/tedder/miner_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/hhvm.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/hhvm.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "HHVM"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Web Servers and Web Proxies"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# HHVM
12
-
13
-
14
-<img src="https://netdata.cloud/img/hhvm.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 HipHop Virtual Machine metrics for efficient
25
-PHP execution and performance.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [HHVM Exporter](https://github.com/wikimedia/operations-software-hhvm_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [HHVM Exporter](https://github.com/wikimedia/operations-software-hhvm_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/hitron_cgn_series_cpe.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/hitron_cgn_series_cpe.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Hitron CGN series CPE"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
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
-# Hitron CGN series CPE
12
-
13
-
14
-<img src="https://netdata.cloud/img/hitron.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 Hitron CGNV4 gateway metrics for efficient network management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Hitron CGNV4 exporter](https://github.com/yrro/hitron-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Hitron CGNV4 exporter](https://github.com/yrro/hitron-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/hp_ilo.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/hp_ilo.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "HP iLO"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
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
-# HP iLO
12
-
13
-
14
-<img src="https://netdata.cloud/img/hp.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 HP Integrated Lights Out (iLO) metrics for efficient server management and diagnostics.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [HP iLO Metrics Exporter](https://github.com/infinityworks/hpilo-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [HP iLO Metrics Exporter](https://github.com/infinityworks/hpilo-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/huawei_devices.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/huawei_devices.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Huawei devices"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
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
-# Huawei devices
12
-
13
-
14
-<img src="https://netdata.cloud/img/huawei.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
-Keep tabs on Huawei HiLink device metrics for optimized connectivity and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Huawei Hilink exporter](https://github.com/eliecharra/hilink-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Huawei Hilink exporter](https://github.com/eliecharra/hilink-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/iota_full_node.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/iota_full_node.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "IOTA full node"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Blockchain Servers"
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
-# IOTA full node
12
-
13
-
14
-<img src="https://netdata.cloud/img/iota.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
-Keep an eye on IOTA cryptocurrency network metrics for efficient blockchain performance and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [IOTA Exporter](https://github.com/crholliday/iota-prom-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [IOTA Exporter](https://github.com/crholliday/iota-prom-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/ipmi_by_soundcloud.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/ipmi_by_soundcloud.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "IPMI (By SoundCloud)"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'scalability']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# IPMI (By SoundCloud)
13
-
14
-
15
-<img src="https://netdata.cloud/img/soundcloud.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor IPMI metrics externally for efficient server hardware management and monitoring.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [SoundCloud IPMI Exporter (querying IPMI externally, blackbox-exporter style)](https://github.com/prometheus-community/ipmi_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [SoundCloud IPMI Exporter (querying IPMI externally, blackbox-exporter style)](https://github.com/prometheus-community/ipmi_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/iqair_airvisual_air_quality_monitors.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/iqair_airvisual_air_quality_monitors.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "iqAir AirVisual air quality monitors"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# iqAir AirVisual air quality monitors
12
-
13
-
14
-<img src="https://netdata.cloud/img/iqair.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 air quality data from IQAir devices for efficient environmental monitoring and analysis.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [IQair Exporter](https://github.com/Packetslave/iqair_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [IQair Exporter](https://github.com/Packetslave/iqair_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/jetbrains_floating_license_server.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/jetbrains_floating_license_server.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "JetBrains Floating License Server"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Generic Collecting Metrics"
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
-# JetBrains Floating License Server
12
-
13
-
14
-<img src="https://netdata.cloud/img/jetbrains.png" 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 JetBrains floating license server metrics for efficient software licensing management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [JetBrains Floating License Server Export](https://github.com/mkreu/jetbrains-fls-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [JetBrains Floating License Server Export](https://github.com/mkreu/jetbrains-fls-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/jolokia.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/jolokia.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "jolokia"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/APM"
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
-# jolokia
12
-
13
-
14
-<img src="https://netdata.cloud/img/jolokia.png" 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 Jolokia JVM metrics for optimized Java application performance and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [jolokia_exporter](https://github.com/aklinkert/jolokia_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [jolokia_exporter](https://github.com/aklinkert/jolokia_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/kafka_connect.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/kafka_connect.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Kafka Connect"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Message Brokers"
7
-most_popular: False
8
-keywords: ['big data', 'stream processing', 'message broker']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Kafka Connect
13
-
14
-
15
-<img src="https://netdata.cloud/img/kafka.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep tabs on Kafka Connect metrics for efficient data streaming and integration.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Kafka Connect exporter](https://github.com/findelabs/kafka-connect-exporter-rs).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Kafka Connect exporter](https://github.com/findelabs/kafka-connect-exporter-rs) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/kubernetes_cluster_cloud_cost.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/kubernetes_cluster_cloud_cost.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Kubernetes Cluster Cloud Cost"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Kubernetes"
7
-most_popular: False
8
-keywords: ['cloud services', 'cloud computing', 'scalability']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Kubernetes Cluster Cloud Cost
13
-
14
-
15
-<img src="https://netdata.cloud/img/kubernetes.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep an eye on Kubernetes cloud cost metrics for efficient cloud resource management and budgeting.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Kubernetes Cloud Cost Exporter](https://github.com/agilestacks/korral).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Kubernetes Cloud Cost Exporter](https://github.com/agilestacks/korral) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/lagerist_disk_latency.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/lagerist_disk_latency.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Lagerist Disk latency"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# Lagerist Disk latency
12
-
13
-
14
-<img src="https://netdata.cloud/img/linux.png" 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
-Track disk latency metrics for efficient storage performance and diagnostics.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Lagerist Disk latency exporter](https://github.com/Svedrin/lagerist).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Lagerist Disk latency exporter](https://github.com/Svedrin/lagerist) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/ldap.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/ldap.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "LDAP"
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
-# LDAP
12
-
13
-
14
-<img src="https://netdata.cloud/img/ldap.png" 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
-Keep an eye on Lightweight Directory Access Protocol (LDAP) metrics for efficient directory service management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [LDAP Exporter](https://github.com/titisan/ldap_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [LDAP Exporter](https://github.com/titisan/ldap_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/machbase.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/machbase.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Machbase"
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
-# Machbase
12
-
13
-
14
-<img src="https://netdata.cloud/img/machbase.png" 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 Machbase time-series database metrics for efficient data storage and query performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Machbase Exporter](https://github.com/MACHBASE/prometheus-machbase-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Machbase Exporter](https://github.com/MACHBASE/prometheus-machbase-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/maildir.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/maildir.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Maildir"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Mail Servers"
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
-# Maildir
12
-
13
-
14
-<img src="https://netdata.cloud/img/mailserver.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
-Track mail server metrics for optimized email management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [mailexporter](https://github.com/cherti/mailexporter).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [mailexporter](https://github.com/cherti/mailexporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/memcached_community.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/memcached_community.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Memcached (community)"
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
-# Memcached (community)
12
-
13
-
14
-<img src="https://netdata.cloud/img/memcached.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 Memcached in-memory key-value store metrics for efficient caching performance and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Memcached exporter](https://github.com/prometheus/memcached_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Memcached exporter](https://github.com/prometheus/memcached_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/monnit_sensors_mqtt.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/monnit_sensors_mqtt.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Monnit Sensors MQTT"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# Monnit Sensors MQTT
12
-
13
-
14
-<img src="https://netdata.cloud/img/monnit.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
-Track Monnit sensor data via MQTT for efficient IoT device monitoring and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Monnit Sensors MQTT Exporter WIP](https://github.com/braxton9460/monnit-mqtt-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Monnit Sensors MQTT Exporter WIP](https://github.com/braxton9460/monnit-mqtt-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/mp707_usb_thermometer.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/mp707_usb_thermometer.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "MP707 USB thermometer"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# MP707 USB thermometer
12
-
13
-
14
-<img src="https://netdata.cloud/img/thermometer.png" 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
-Track MP707 power strip metrics for efficient energy management and monitoring.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [MP707 exporter](https://github.com/nradchenko/mp707_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [MP707 exporter](https://github.com/nradchenko/mp707_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/naemon.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/naemon.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Naemon"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Observability"
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
-# Naemon
12
-
13
-
14
-<img src="https://netdata.cloud/img/naemon.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 Naemon or Nagios network monitoring metrics for efficient IT infrastructure management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Naemon / Nagios Exporter](https://github.com/Griesbacher/Iapetos).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Naemon / Nagios Exporter](https://github.com/Griesbacher/Iapetos) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/netflow.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/netflow.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "NetFlow"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-keywords: ['network monitoring', 'network performance', 'traffic analysis']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# NetFlow
13
-
14
-
15
-<img src="https://netdata.cloud/img/netflow.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Track NetFlow network traffic metrics for efficient network monitoring and performance.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [netflow exporter](https://github.com/paihu/netflow_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [netflow exporter](https://github.com/paihu/netflow_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/netmeter.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/netmeter.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "NetMeter"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-keywords: ['network monitoring', 'network performance', 'traffic analysis']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# NetMeter
13
-
14
-
15
-<img src="https://netdata.cloud/img/netmeter.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor NetMeter network traffic metrics for efficient network management and performance.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [NetMeter Exporter](https://github.com/ssbostan/netmeter-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [NetMeter Exporter](https://github.com/ssbostan/netmeter-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/new_relic.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/new_relic.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "New Relic"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Observability"
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
-# New Relic
12
-
13
-
14
-<img src="https://netdata.cloud/img/newrelic.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 New Relic application performance management metrics for efficient application monitoring and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [New Relic exporter](https://github.com/jfindley/newrelic_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [New Relic exporter](https://github.com/jfindley/newrelic_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/nftables.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/nftables.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "nftables"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Linux Systems/Firewall"
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
-# nftables
12
-
13
-
14
-<img src="https://netdata.cloud/img/nftables.png" 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 nftables firewall metrics for efficient network security and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [nftables_exporter](https://github.com/Sheridan/nftables_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [nftables_exporter](https://github.com/Sheridan/nftables_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/nsx-t.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/nsx-t.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "NSX-T"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Containers and VMs"
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
-# NSX-T
12
-
13
-
14
-<img src="https://netdata.cloud/img/vmware-nsx.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
-Track VMware NSX-T software-defined networking metrics for efficient network virtualization and security management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [NSX-T Exporter](https://github.com/jk8s/nsxt_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [NSX-T Exporter](https://github.com/jk8s/nsxt_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/nvml.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/nvml.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "NVML"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
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
-# NVML
12
-
13
-
14
-<img src="https://netdata.cloud/img/nvidia.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
-Keep an eye on NVIDIA Management Library (NVML) GPU metrics for efficient GPU performance and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [NVML exporter](https://github.com/oko/nvml-exporter-rs).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [NVML exporter](https://github.com/oko/nvml-exporter-rs) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/odbc.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/odbc.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "ODBC"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Databases"
7
-most_popular: False
8
-keywords: ['database', 'dbms', 'data storage']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# ODBC
13
-
14
-
15
-<img src="https://netdata.cloud/img/odbc.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Keep tabs on Open Database Connectivity (ODBC) metrics for efficient database connection and performance.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [ODBC Exporter](https://github.com/MACHBASE/prometheus-odbc-exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [ODBC Exporter](https://github.com/MACHBASE/prometheus-odbc-exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/openhab.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/openhab.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "OpenHAB"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# OpenHAB
12
-
13
-
14
-<img src="https://netdata.cloud/img/openhab.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
-Track openHAB smart home automation system metrics for efficient home automation and energy management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [OpenHAB exporter](https://github.com/pdreker/openhab_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [OpenHAB exporter](https://github.com/pdreker/openhab_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/openldap_community.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/openldap_community.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "OpenLDAP (community)"
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
-# OpenLDAP (community)
12
-
13
-
14
-<img src="https://netdata.cloud/img/openldap.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 OpenLDAP directory service metrics for efficient directory management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [OpenLDAP Metrics Exporter](https://github.com/tomcz/openldap_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [OpenLDAP Metrics Exporter](https://github.com/tomcz/openldap_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/openrct2.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/openrct2.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "OpenRCT2"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Gaming"
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
-# OpenRCT2
12
-
13
-
14
-<img src="https://netdata.cloud/img/openRCT2.png" 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
-Track OpenRCT2 game metrics for efficient game server management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [OpenRCT2 Prometheus Exporter](https://github.com/terinjokes/openrct2-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [OpenRCT2 Prometheus Exporter](https://github.com/terinjokes/openrct2-prometheus-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/openstack.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/openstack.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "OpenStack"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Cloud Provider Managed"
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
-# OpenStack
12
-
13
-
14
-<img src="https://netdata.cloud/img/openstack.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
-Track OpenStack cloud computing platform metrics for efficient infrastructure management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Openstack exporter](https://github.com/CanonicalLtd/prometheus-openstack-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Openstack exporter](https://github.com/CanonicalLtd/prometheus-openstack-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/openvas.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/openvas.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "OpenVAS"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Security Systems"
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
-# OpenVAS
12
-
13
-
14
-<img src="https://netdata.cloud/img/openVAS.png" 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 OpenVAS vulnerability scanner metrics for efficient security assessment and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [OpenVAS exporter](https://github.com/ModeClearCode/openvas_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [OpenVAS exporter](https://github.com/ModeClearCode/openvas_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/openweathermap.md
+2
-2
@@ -24,7 +24,7 @@ Module: prometheus
24
Track OpenWeatherMap weather data and air pollution metrics for efficient environmental monitoring and analysis.
25
26
27
-Metrics are gathered by periodically sending HTTP requests to [OpenWeatherMap Exporter](https://github.com/Tenzer/openweathermap-exporter).
27
+Metrics are gathered by periodically sending HTTP requests to [OpenWeatherMap Exporter](https://github.com/billykwooten/openweather-exporter).
28
29
30
This collector is supported on all platforms.
@@ -97,7 +97,7 @@ UI configuration requires paid Netdata Cloud plan.
97
98
#### Install Exporter
99
100
-Install [OpenWeatherMap Exporter](https://github.com/Tenzer/openweathermap-exporter) by following the instructions mentioned in the exporter README.
100
+Install [OpenWeatherMap Exporter](https://github.com/billykwooten/openweather-exporter) by following the instructions mentioned in the exporter README.
101
102
103
src/go/plugin/go.d/collector/prometheus/integrations/oracle_db_community.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/oracle_db_community.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Oracle DB (community)"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Databases"
7
-most_popular: False
8
-keywords: ['oracle', 'database', 'dbms', 'data storage']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Oracle DB (community)
13
-
14
-
15
-<img src="https://netdata.cloud/img/oracle.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Track Oracle Database metrics for efficient database management and performance.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Oracle DB Exporter](https://github.com/iamseth/oracledb_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
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
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
88
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Oracle DB Exporter](https://github.com/iamseth/oracledb_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
143
-
144
-##### selector
145
-
146
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147
-
148
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150
-- Option syntax:
151
-
152
-```yaml
153
-selector:
154
- allow:
155
- - pattern1
156
- - pattern2
157
- deny:
158
- - pattern3
159
- - pattern4
160
-```
161
-
162
-
163
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/otrs.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/otrs.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "OTRS"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Incident Management"
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
-# OTRS
12
-
13
-
14
-<img src="https://netdata.cloud/img/otrs.png" 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 OTRS (Open-Source Ticket Request System) metrics for efficient helpdesk management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [OTRS Exporter](https://github.com/JulianDroste/otrs_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [OTRS Exporter](https://github.com/JulianDroste/otrs_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/pingdom.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/pingdom.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Pingdom"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Synthetic Checks"
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
-# Pingdom
12
-
13
-
14
-<img src="https://netdata.cloud/img/solarwinds.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 Pingdom website monitoring service metrics for efficient website performance management and diagnostics.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Pingdom Exporter](https://github.com/veepee-oss/pingdom_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Pingdom Exporter](https://github.com/veepee-oss/pingdom_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/rancher.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/rancher.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Rancher"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Kubernetes"
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
-# Rancher
12
-
13
-
14
-<img src="https://netdata.cloud/img/rancher.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
-Track Rancher container orchestration platform metrics for efficient container management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Rancher Exporter](https://github.com/infinityworksltd/prometheus-rancher-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Rancher Exporter](https://github.com/infinityworksltd/prometheus-rancher-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/sentry.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/sentry.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Sentry"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/APM"
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
-# Sentry
12
-
13
-
14
-<img src="https://netdata.cloud/img/sentry.png" 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
-Track Sentry error tracking and monitoring platform metrics for efficient application performance and error management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Sentry Exporter](https://github.com/snakecharmer/sentry_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Sentry Exporter](https://github.com/snakecharmer/sentry_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/servertech.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/servertech.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "ServerTech"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
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
-# ServerTech
12
-
13
-
14
-<img src="https://netdata.cloud/img/servertech.png" 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
-Keep an eye on Server Technology power distribution unit (PDU) metrics for efficient power management and monitoring.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [ServerTech Exporter](https://github.com/tynany/servertech_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [ServerTech Exporter](https://github.com/tynany/servertech_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/shell_command.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/shell_command.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Shell command"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Generic Collecting Metrics"
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
-# Shell command
12
-
13
-
14
-<img src="https://netdata.cloud/img/crunner.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
-Track custom command output metrics for tailored monitoring and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Command runner exporter](https://github.com/tomwilkie/prom-run).
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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Command runner exporter](https://github.com/tomwilkie/prom-run) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/sia.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/sia.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Sia"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Blockchain Servers"
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
-# Sia
12
-
13
-
14
-<img src="https://netdata.cloud/img/sia.png" 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
-Track Sia decentralized storage platform metrics for efficient storage management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Sia Exporter](https://github.com/tbenz9/sia_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Sia Exporter](https://github.com/tbenz9/sia_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/slurm.md
+2
-2
@@ -24,7 +24,7 @@ Module: prometheus
24
Track Slurm workload manager metrics for efficient high-performance computing (HPC) and cluster management.
25
26
27
-Metrics are gathered by periodically sending HTTP requests to [slurm exporter](https://github.com/vpenso/prometheus-slurm-exporter).
27
+Metrics are gathered by periodically sending HTTP requests to [slurm exporter](https://github.com/SckyzO/slurm_exporter).
28
29
30
This collector is supported on all platforms.
@@ -97,7 +97,7 @@ UI configuration requires paid Netdata Cloud plan.
97
98
#### Install Exporter
99
100
-Install [slurm exporter](https://github.com/vpenso/prometheus-slurm-exporter) by following the instructions mentioned in the exporter README.
100
+Install [slurm exporter](https://github.com/SckyzO/slurm_exporter) by following the instructions mentioned in the exporter README.
101
102
103
src/go/plugin/go.d/collector/prometheus/integrations/solaredge_inverters.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/solaredge_inverters.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "SolarEdge inverters"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# SolarEdge inverters
12
-
13
-
14
-<img src="https://netdata.cloud/img/solaredge.png" 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
-Track SolarEdge solar inverter metrics for efficient solar energy management and monitoring.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [SolarEdge Exporter](https://github.com/dave92082/SolarEdge-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [SolarEdge Exporter](https://github.com/dave92082/SolarEdge-Exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/speedify_cli.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/speedify_cli.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Speedify CLI"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/VPNs"
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
-# Speedify CLI
12
-
13
-
14
-<img src="https://netdata.cloud/img/speedify.png" 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
-Track Speedify VPN metrics for efficient virtual private network (VPN) management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Speedify Exporter](https://github.com/willshen/speedify_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Speedify Exporter](https://github.com/willshen/speedify_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/ssh.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/ssh.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "SSH"
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
-# SSH
12
-
13
-
14
-<img src="https://netdata.cloud/img/ssh.png" 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 SSH server metrics for efficient secure shell server management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [SSH Exporter](https://github.com/Nordstrom/ssh_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [SSH Exporter](https://github.com/Nordstrom/ssh_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/ssl_certificate.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/ssl_certificate.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "SSL Certificate"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Security Systems"
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
-# SSL Certificate
12
-
13
-
14
-<img src="https://netdata.cloud/img/ssl.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
-Track SSL/TLS certificate metrics for efficient web security and certificate management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [SSL Certificate exporter](https://github.com/ribbybibby/ssl_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [SSL Certificate exporter](https://github.com/ribbybibby/ssl_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/starwind_vsan_vsphere_edition.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/starwind_vsan_vsphere_edition.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Starwind VSAN VSphere Edition"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
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
-# Starwind VSAN VSphere Edition
12
-
13
-
14
-<img src="https://netdata.cloud/img/starwind.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
-Keep tabs on StarWind Virtual SAN metrics for efficient storage virtualization and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Starwind vSAN Exporter](https://github.com/evoicefire/starwind-vsan-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Starwind vSAN Exporter](https://github.com/evoicefire/starwind-vsan-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/stream.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/stream.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Stream"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Media Services"
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
-# Stream
12
-
13
-
14
-<img src="https://netdata.cloud/img/stream.png" 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 streaming metrics for efficient media streaming and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Stream exporter](https://github.com/carlpett/stream_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Stream exporter](https://github.com/carlpett/stream_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/t-rex_nvidia_gpu_miner.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/t-rex_nvidia_gpu_miner.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "T-Rex NVIDIA GPU Miner"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Hardware Devices and Sensors"
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
-# T-Rex NVIDIA GPU Miner
12
-
13
-
14
-<img src="https://netdata.cloud/img/trex.png" 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 T-Rex NVIDIA GPU miner metrics for efficient cryptocurrency mining and GPU performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [T-Rex NVIDIA GPU Miner Exporter](https://github.com/dennisstritzke/trex_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [T-Rex NVIDIA GPU Miner Exporter](https://github.com/dennisstritzke/trex_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/tesla_powerwall.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/tesla_powerwall.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Tesla Powerwall"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# Tesla Powerwall
12
-
13
-
14
-<img src="https://netdata.cloud/img/tesla.png" 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 Tesla Powerwall metrics for efficient home energy storage and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Tesla Powerwall Exporter](https://github.com/foogod/powerwall_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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Tesla Powerwall Exporter](https://github.com/foogod/powerwall_exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/tp-link_p110.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/tp-link_p110.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "TP-Link P110"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/IoT Devices"
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
-# TP-Link P110
12
-
13
-
14
-<img src="https://netdata.cloud/img/tplink.png" 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
-Track TP-Link P110 smart plug metrics for efficient energy management and monitoring.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [TP-Link P110 Exporter](https://github.com/ijohanne/prometheus-tplink-p110-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [TP-Link P110 Exporter](https://github.com/ijohanne/prometheus-tplink-p110-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/traceroute.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/traceroute.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Traceroute"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
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
-# Traceroute
12
-
13
-
14
-<img src="https://netdata.cloud/img/traceroute.png" 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
-Export traceroute metrics for efficient network path analysis and performance monitoring.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [traceroute exporter](https://github.com/jeanfabrice/prometheus-tcptraceroute-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [traceroute exporter](https://github.com/jeanfabrice/prometheus-tcptraceroute-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/twincat_ads_web_service.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/twincat_ads_web_service.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "TwinCAT ADS Web Service"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Generic Collecting Metrics"
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
-# TwinCAT ADS Web Service
12
-
13
-
14
-<img src="https://netdata.cloud/img/twincat.png" 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 TwinCAT ADS (Automation Device Specification) Web Service metrics for efficient industrial automation and control.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [TwinCAT ADS Web Service exporter](https://github.com/MarcusCalidus/twincat-ads-webservice-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [TwinCAT ADS Web Service exporter](https://github.com/MarcusCalidus/twincat-ads-webservice-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/xmpp_server.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/xmpp_server.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "XMPP Server"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Message Brokers"
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
-# XMPP Server
12
-
13
-
14
-<img src="https://netdata.cloud/img/xmpp.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 XMPP (Extensible Messaging and Presence Protocol) server metrics for efficient messaging and communication management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [XMPP Server Exporter](https://github.com/horazont/xmpp-blackbox-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [XMPP Server Exporter](https://github.com/horazont/xmpp-blackbox-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/zulip.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/zulip.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Zulip"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Media Services"
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
-# Zulip
12
-
13
-
14
-<img src="https://netdata.cloud/img/zulip.png" 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 Zulip open-source group chat application metrics for efficient team communication management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Zulip Exporter](https://github.com/brokenpip3/zulip-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
-
41
-
42
-#### Limits
43
-
44
-The default configuration for this integration does not impose any limits on data collection.
45
-
46
-#### Performance Impact
47
-
48
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
-
50
-## Metrics
51
-
52
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53
-
54
-| Metric | Chart | Dimension(s) | Algorithm |
55
-|---------------------------|-------------------------------------------|----------------------|-------------|
56
-| Gauge | for each label set | one, the metric name | absolute |
57
-| Counter | for each label set | one, the metric name | incremental |
58
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59
-| Summary (sum and count) | for each label set | the metric name | incremental |
60
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61
-| Histogram (sum and count) | for each label set | the metric name | incremental |
62
-
63
-Untyped metrics (have no '# TYPE') processing:
64
-
65
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66
-- As Counter if it has suffix '_total'.
67
-- As Summary if it has 'quantile' label.
68
-- As Histogram if it has 'le' label.
69
-
70
-**The rest are ignored**.
71
-
72
-
73
-
74
-## Alerts
75
-
76
-There are no alerts configured by default for this integration.
77
-
78
-
79
-## Setup
80
-
81
-
82
-You can configure the **prometheus** collector in two ways:
83
-
84
-| Method | Best for | How to |
85
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86
-| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87
-| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88
-
89
-:::important
90
-
91
-UI configuration requires paid Netdata Cloud plan.
92
-
93
-:::
94
-
95
-
96
-### Prerequisites
97
-
98
-#### Install Exporter
99
-
100
-Install [Zulip Exporter](https://github.com/brokenpip3/zulip-exporter) by following the instructions mentioned in the exporter README.
101
-
102
-
103
-
104
-### Configuration
105
-
106
-#### Options
107
-
108
-The following options can be defined globally: update_every, autodetection_retry.
109
-
110
-
111
-<details open><summary>Config options</summary>
112
-
113
-
114
-
115
-| Group | Option | Description | Default | Required |
116
-|:------|:-----|:------------|:--------|:---------:|
117
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119
-| **Target** | url | Target endpoint URL. | | yes |
120
-| | timeout | HTTP request timeout (seconds). | 10 | no |
121
-| **Filters** | selector | Time series selector (filter). | | no |
122
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
125
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127
-| | password | Password for Basic HTTP authentication. | | no |
128
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
133
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136
-| **Request** | method | HTTP method to use. | GET | no |
137
-| | body | Request body (e.g., for POST/PUT). | | no |
138
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
139
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141
-| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142
-
143
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-