Improve wording in messages

This commit is contained in:
SebastianStork 2026-03-13 17:39:38 +01:00
parent e69e9c8491
commit e2f312b2c5
Signed by: SebastianStork
SSH key fingerprint: SHA256:tRrGdjYOwgHxpSc/wTOZQZEjxcb15P0tyXRsbAfd+2Q
9 changed files with 31 additions and 27 deletions

View file

@ -1,5 +1,6 @@
{
config,
self,
lib,
allHosts,
...
@ -38,7 +39,7 @@ in
|> lib.filter (name: name != "system")
|> lib.map (name: {
assertion = cfg.collect.metrics.${name} -> config.services.${name}.enable;
message = "Alloy cannot collect `${name}` metrics without the `${name}` service";
message = self.lib.mkInvalidConfigMessage "Alloy metric collection for `${name}`" "the `${name}` service is not enabled";
});
services.alloy = {

View file

@ -91,11 +91,11 @@ in
|> lib.concatMap (vHost: [
{
assertion = (vHost.port == null) || (vHost.files == null);
message = "Caddy virtual host `${vHost.domain}` cannot set both `port` and `files`";
message = self.lib.mkInvalidConfigMessage "Caddy virtual host `${vHost.domain}`" "`port` and `files` cannot be set at the same time";
}
{
assertion = (vHost.port != null) || (vHost.files != null) || (vHost.extraConfig != null);
message = "Caddy virtual host `${vHost.domain}` must set at least one of `port`, `files` or `extraConfig`";
message = self.lib.mkInvalidConfigMessage "Caddy virtual host `${vHost.domain}`" "one of `port`, `files` or `extraConfig` must be set";
}
]);

View file

@ -62,7 +62,7 @@ in
config = lib.mkIf cfg.enable {
assertions = lib.singleton {
assertion = netCfg.overlay.isLighthouse -> cfg.advertise.address != null;
message = "`${netCfg.hostName}` is a Nebula lighthouse, but `underlay.isPublic` or `overlay.advertise.address` are not set. Lighthouses must be publicly reachable.";
message = self.lib.mkInvalidConfigMessage "Nebula lighthouse `${netCfg.hostName}`" "`underlay.isPublic` must be enabled or `services.nebula.advertise.address` must be set so the host is publicly reachable";
};
sops.secrets."nebula/host-key" = lib.mkIf (cfg.privateKeyFile == null) {

View file

@ -96,10 +96,10 @@ in
expr = ''absent_over_time(up{instance="${hostName}", job="node"}[2m])'';
labels.severity = "critical";
annotations = {
summary = "${hostName} is DOWN";
summary_resolved = "${hostName} is up again";
description = "No metrics received for over 2 minutes.";
description_resolved = "Metrics are being received again.";
summary = "Host ${hostName} is down";
summary_resolved = "Host ${hostName} is up again";
description = "Prometheus has not received node metrics from ${hostName} for 2 minutes.";
description_resolved = "Prometheus is receiving node metrics from ${hostName} again.";
};
})
)
@ -109,20 +109,20 @@ in
expr = ''up{job=~"prometheus|alertmanager"} == 0'';
for = "2m";
annotations = {
summary = "{{ $labels.job | title }} on {{ $labels.instance }} is DOWN";
summary_resolved = "{{ $labels.job | title }} on {{ $labels.instance }} is up again";
description = "Unresponsive for over 2 minutes.";
description_resolved = "Responding normally.";
summary = "Service {{ $labels.job | title }} on {{ $labels.instance }} is down";
summary_resolved = "Service {{ $labels.job | title }} on {{ $labels.instance }} is up again";
description = "Prometheus has not received scrape data for 2 minutes.";
description_resolved = "Prometheus is receiving scrape data again.";
};
}
{
alert = "CominDeploymentFailed";
expr = ''comin_deployment_info{status!="done"}'';
annotations = {
summary = "{{ $labels.instance }} deployment failed";
summary_resolved = "{{ $labels.instance }} deployment recovered";
description = "Deployment is not reaching \"done\" status.";
description_resolved = "Deployment completed successfully.";
summary = "Deployment on {{ $labels.instance }} failed";
summary_resolved = "Deployment on {{ $labels.instance }} succeeded again";
description = "Comin reports a deployment status other than \"done\".";
description_resolved = "Comin reports the deployment status as \"done\" again.";
};
}
{
@ -130,10 +130,10 @@ in
expr = "count(count by (commit_id) (comin_deployment_info)) > 1";
for = "10m";
annotations = {
summary = "Hosts are running different commits";
summary_resolved = "All hosts are running the same commit again";
description = "Possibly a failed deployment or incompatible configurations.";
description_resolved = "All hosts are in sync.";
summary = "Deployment commits are out of sync";
summary_resolved = "Deployment commits are in sync again";
description = "Comin reports different deployed commits across hosts.";
description_resolved = "Comin reports the same deployed commit across all hosts again.";
};
}
];

View file

@ -26,7 +26,7 @@ in
systemd.services = {
"healthcheck-ping@" = {
description = "Pings healthcheck (%i)";
description = "Ping Healthchecks for %i";
serviceConfig.Type = "oneshot";
scriptArgs = "%i";
script = ''