| Both sides previous revisionPrevious revision | |
| manuals:vps:metrics [2026/07/12 20:30] – Annotate vpsAdmin navigation paths and update interface labels aither | manuals:vps:metrics [2026/09/13 19:54] (current) – Document account security metrics and separate metrics versioning aither |
|---|
| ====== Metrics for Prometheus ====== | ====== Metrics for Prometheus ====== |
| vpsAdmin exports metrics for the monitoring system [[https://prometheus.io|Prometheus]]. | vpsAdmin exports metrics for the monitoring system [[https://prometheus.io|Prometheus]]. |
| You can add these metrics to your own monitoring setup, whether it’s running in your VPS or elsewhere. | You can add these metrics to your own monitoring setup, whether it runs in your VPS or elsewhere. |
| |
| The metrics include information about your VPS, such as CPU usage, memory usage, load average, data transfers, OOM reports, node statuses, and more. There are also metrics related to membership, including the date until your membership is paid. | The metrics include information about your VPS, such as CPU and memory usage, load average, data transfers, OOM reports, and node status. They also cover your membership, including the date until which it is paid. |
| |
| To set this up, go to <vpsadmin-nav id="member.metrics-access-tokens.open">**Edit profile** -> **Metrics access tokens**</vpsadmin-nav> in vpsAdmin and create an access token. You will be provided with a scrape URL, which you can add to your monitoring configuration. VPS statuses are updated every 2 minutes, so there’s no point in fetching the data more frequently. For a detailed overview of the available metrics, open the URL in your browser. | To set this up, go to <vpsadmin-nav id="member.metrics-access-tokens.open">**Edit profile** -> **Metrics access tokens**</vpsadmin-nav> in vpsAdmin and create an access token. vpsAdmin will show you a scrape URL to add to your monitoring configuration. VPS status is updated every two minutes, so there is no benefit in fetching the data more frequently. Open the scrape URL in your browser for a complete list of the available metrics. |
| |
| The metric ''vpsadmin_metrics_version'' (unless you’ve changed the prefix) indicates the version of the metrics. If we make backward-incompatible changes, the first number will increase, e.g., ''1.0 -> 2.0''. The number after the decimal point may increase when new metrics are added, but the meaning of the original metrics will remain unchanged. | ===== Account security ===== |
| | The metrics also describe the current authentication state of your account. The names below use the default ''vpsadmin_'' prefix: |
| | |
| | * ''vpsadmin_user_password_generation'' is the password version. It increases whenever your password changes, so you can use it to detect a change. |
| | * ''vpsadmin_user_password_reset_required'' is ''1'' when you must choose a new password and ''0'' otherwise. |
| | * ''vpsadmin_user_multi_factor_auth_enabled'' is ''1'' when multi-factor authentication is enabled for the account and ''0'' otherwise. |
| | * ''vpsadmin_user_multi_factor_auth_method_count{method="totp"}'' and ''vpsadmin_user_multi_factor_auth_method_count{method="webauthn"}'' show the number of enabled TOTP authenticators and passkeys. |
| | |
| | ===== Metrics versioning ===== |
| | The metric ''vpsadmin_metrics_version'' indicates the metrics version, unless you have changed the prefix. The current version is ''1.1''. The first number increases for a backward-incompatible change, for example ''1.0 -> 2.0''. The number after the decimal point may increase when metrics are added without changing the meaning of existing metrics. |
| | <page>manuals:vps:metrics</page> |
| |
