From 6a49a53bc380b0503aa5abf8d2b937e7cf2e9b02 Mon Sep 17 00:00:00 2001 From: Frederik Ring Date: Fri, 26 Jan 2024 21:23:22 +0100 Subject: [PATCH] Document services stats --- docs/how-tos/set-up-notifications.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/how-tos/set-up-notifications.md b/docs/how-tos/set-up-notifications.md index 4a3e979..23d2aaf 100644 --- a/docs/how-tos/set-up-notifications.md +++ b/docs/how-tos/set-up-notifications.md @@ -89,6 +89,11 @@ Here is a list of all data passed to the template: * `ToStop`: number of containers matched by the stop rule * `Stopped`: number of containers successfully stopped * `StopErrors`: number of containers that were unable to be stopped (equal to `ToStop - Stopped`) + * `Services`: object containing stats about the docker services (only populated when Docker is running in Swarm mode) + * `All`: total number of services + * `ToScaleDown`: number of containers matched by the scale down rule + * `ScaledDwon`: number of containers successfully scaled down + * `ScaleDownErrors`: number of containers that were unable to be stopped (equal to `ToScaleDown - ScaledDowm`) * `BackupFile`: object containing information about the backup file * `Name`: name of the backup file (e.g. `backup-2022-02-11T01-00-00.tar.gz`) * `FullPath`: full path of the backup file (e.g. `/archive/backup-2022-02-11T01-00-00.tar.gz`)