Skip to content

Commit

Permalink
improve prometheus exporter docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sni committed Nov 14, 2023
1 parent cea1994 commit beef79d
Showing 5 changed files with 102 additions and 20 deletions.
22 changes: 4 additions & 18 deletions docs/prometheus/_index.md
Original file line number Diff line number Diff line change
@@ -19,29 +19,15 @@ There are several prometheus integrations in SNClient+.

## Windows Exporter

When SNClient+ on windows there is a builtin windows exporter which can be
enabled by:
When running SNClient+ on windows there is a builtin windows exporter.

[/modules]
WindowsExporterServer = enabled

[/settings/WindowsExporter/server]
; adjust further settings here

You can then scrape windows metrics from `http://<ip>:8443/node/metrics`.
[Read more about the windows exporter](windows).

## Node Exporter

When SNClient+ on linux there is a builtin node exporter which can be
enabled by:

[/modules]
NodeExporterServer = enabled

[/settings/NodeExporter/server]
; adjust further settings here
When running SNClient+ on linux there is a builtin node exporter.

You can then scrape windows metrics from `http://<ip>:8443/node/metrics`.
[Read more about the windows exporter](linux).

## Managed Exporters

2 changes: 1 addition & 1 deletion docs/prometheus/exporter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExporterExporter
linkTitle: ExpExp
weight: 400
weight: 360
tags:
- prometheus
- exporter
49 changes: 49 additions & 0 deletions docs/prometheus/linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Linux
linkTitle: Linux
weight: 340
tags:
- prometheus
- linux
- node_exporter
- exporter
---

## Node Exporter

When running SNClient+ on linux there is a builtin node exporter which can be
enabled by:

[/modules]
NodeExporterServer = enabled

[/settings/NodeExporter/server]
; use same port as the web server
port = ${/settings/WEB/server/port}

; disable password protection
password =

You can then scrape linux metrics from `http://<ip>:8443/node/metrics`.

The node exporter will run as user `nobody` unless you set `agent user` otherwise.

The prometheus scrape config might look like this:

- job_name: 'linux'
# Override the global default and scrape targets from this job every 5 seconds.
scrape_interval: 5s

# metrics_path defaults to '/metrics', but here we use the snclient-prefix
metrics_path: /node/metrics

# scheme defaults to 'http'.
scheme: https
tls_config:
insecure_skip_verify: true

static_configs:
- targets: ['<ip>:8443']

SNClient will monitor the node exporter memory usage and restart the exporter if
it exceeds the `agent max memory`. The default is 256MB.
2 changes: 1 addition & 1 deletion docs/prometheus/managed.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ManagedExporter
linkTitle: Managed
weight: 400
weight: 350
tags:
- prometheus
- exporter
47 changes: 47 additions & 0 deletions docs/prometheus/windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Windows
linkTitle: Windows
weight: 330
tags:
- prometheus
- windows
- exporter
- windows_exporter
---

## Windows Exporter

When running SNClient+ on windows there is a builtin windows exporter which can be
enabled by:

[/modules]
WindowsExporterServer = enabled

[/settings/WindowsExporter/server]
; use same port as the web server
port = ${/settings/WEB/server/port}

; disable password protection
password =

You can then scrape windows metrics from `http://<ip>:8443/node/metrics`.

The prometheus scrape config might look like this:

- job_name: 'windows'
# Override the global default and scrape targets from this job every 5 seconds.
scrape_interval: 5s

# metrics_path defaults to '/metrics', but here we use the snclient-prefix
metrics_path: /node/metrics

# scheme defaults to 'http'.
scheme: https
tls_config:
insecure_skip_verify: true

static_configs:
- targets: ['<ip>:8443']

SNClient will monitor the windows exporter memory usage and restart the exporter if
it exceeds the `agent max memory`. The default is 256MB.

0 comments on commit beef79d

Please sign in to comment.