Fix lint warnings on alerts mixin

Closes #1446

Author: JamesGuthrie

deploy/helm-chart/templates/prometheus-rule.yaml

@@ -26,8 +26,8 @@ spec:
       labels:
         severity: critical
       annotations:
-        summary: Promscale is down
-        description: No Promscale instance was found.
+        summary: Promscale is down.
+        description: "{{ $labels.instance }} of job {{ $labels.job }} is down."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleDown.md
   - name: promscale-ingest
     rules:
@@ -45,7 +45,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: High error rate in Promscale ingestion
+        summary: High error rate in Promscale ingestion.
         description: "Promscale ingestion is having a {{ $value | humanizePercentage }} error rate."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighErrorRate.md
     - alert: PromscaleIngestHighErrorRate
@@ -62,7 +62,7 @@ spec:
       labels:
         severity: critical
       annotations:
-        summary: High error rate in Promscale ingestion
+        summary: High error rate in Promscale ingestion.
         description: "Promscale ingestion is having a {{ $value | humanizePercentage }} error rate."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighErrorRate.md
     - alert: PromscaleIngestHighLatency
@@ -83,7 +83,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: Slow Promscale ingestion
+        summary: Slow Promscale ingestion.
         description: "Slowest 10% of ingestion batch took more than {{ $value }} seconds to ingest."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighLatency.md
     - alert: PromscaleIngestHighLatency
@@ -104,7 +104,7 @@ spec:
       labels:
         severity: critical
       annotations:
-        summary: Slow Promscale ingestion
+        summary: Slow Promscale ingestion.
         description: "Slowest 10% of ingestion batch took more than {{ $value }} seconds to ingest."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighLatency.md
   - name: promscale-query
@@ -123,7 +123,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: High error rate in querying Promscale
+        summary: High error rate in querying Promscale.
         description: "Evaluating queries via Promscale has {{ $value | humanizePercentage }} error rate."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighErrorRate.md
     - alert: PromscaleQueryHighErrorRate
@@ -140,7 +140,7 @@ spec:
       labels:
         severity: critical
       annotations:
-        summary: High error rate in querying Promscale
+        summary: High error rate in querying Promscale.
         description: "Evaluating queries via Promscale had {{ $value | humanizePercentage }} error rate."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighErrorRate.md
     - alert: PromscaleQueryHighLatency
@@ -161,7 +161,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: Slow Promscale querying
+        summary: Slow Promscale querying.
         description: "Slowest 10% of the queries took more than {{ $value }} seconds to evaluate."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighLatency.md
     - alert: PromscaleQueryHighLatency
@@ -182,7 +182,7 @@ spec:
       labels:
         severity: critical
       annotations:
-        summary: Slow Promscale querying
+        summary: Slow Promscale querying.
         description: "Slowest 10% of the queries took {{ $value }} seconds to evaluate."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighLatency.md
   - name: promscale-cache
@@ -201,7 +201,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: High cache eviction in Promscale
+        summary: High cache eviction in Promscale.
         description: "Promscale {{ $labels.name }} is evicting at {{ $value }} entries a second."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleCacheHighNumberOfEvictions.md
     - alert: PromscaleCacheTooSmall
@@ -218,7 +218,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: High cache eviction in Promscale
+        summary: High cache eviction in Promscale.
         description: "Promscale {{ $labels.name }} has a hit ratio of {{ $value | humanizePercentage }}."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleCacheTooSmall.md
   - name: promscale-database-connection
@@ -238,7 +238,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: Promscale experiences a high error rate when connecting to the database
+        summary: Promscale experiences a high error rate when connecting to the database.
         description: "Promscale connection with the database has an error of {{ $value | humanizePercentage }}."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleDBHighErrorRate.md
     - alert: PromscaleStorageHighLatency
@@ -257,7 +257,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: Slow database response
+        summary: Slow database response.
         description: "Slowest 10% of database requests are taking more than {{ $value }} seconds to respond."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleStorageHighLatency.md
   - name: promscale-database
@@ -276,7 +276,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: Promscale database is unhealthy
+        summary: Promscale database is unhealthy.
         description: "Promscale connection with the database has an error of {{ $value | humanizePercentage }}."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleStorageUnhealthy.md
     - alert: PromscaleMaintenanceJobRunningTooLong
@@ -297,16 +297,16 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: Promscale maintenance jobs taking too long to complete
+        summary: Promscale maintenance jobs taking too long to complete.
         description: "Promscale Database is taking {{ $value }} seconds to respond to Promscale's requests."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleMaintenanceJobRunningTooLong.md
     - alert: PromscaleMaintenanceJobFailures
       expr: promscale_sql_database_worker_maintenance_job_failed == 1
       labels:
         severity: warning
       annotations:
-        summary: Promscale maintenance job failed
-        description: "Promscale maintenance job failed to successfully execute."
+        summary: Promscale maintenance job failed.
+        description: "Maintenance job for Promscale instance {{ $labels.instance }} failed to successfully execute."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleMaintenanceJobFailures.md
     - alert: PromscaleCompressionLow
       expr: |
@@ -322,7 +322,7 @@ spec:
       labels:
         severity: warning
       annotations:
-        summary: High uncompressed data
+        summary: High uncompressed data.
         description: "High uncompressed data in Promscale, on average, {{ $value }} uncompressed chunks per metric."
         runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleCompressionLow.md
 `}}

docs/mixin/alerts/alerts.yaml

@@ -8,8 +8,8 @@ groups:
     labels:
       severity: critical
     annotations:
-      summary: Promscale is down
-      description: No Promscale instance was found.
+      summary: Promscale is down.
+      description: "{{ $labels.instance }} of job {{ $labels.job }} is down."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleDown.md
 - name: promscale-ingest
   rules:
@@ -27,7 +27,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: High error rate in Promscale ingestion
+      summary: High error rate in Promscale ingestion.
       description: "Promscale ingestion is having a {{ $value | humanizePercentage }} error rate."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighErrorRate.md
   - alert: PromscaleIngestHighErrorRate
@@ -44,7 +44,7 @@ groups:
     labels:
       severity: critical
     annotations:
-      summary: High error rate in Promscale ingestion
+      summary: High error rate in Promscale ingestion.
       description: "Promscale ingestion is having a {{ $value | humanizePercentage }} error rate."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighErrorRate.md
   - alert: PromscaleIngestHighLatency
@@ -65,7 +65,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: Slow Promscale ingestion
+      summary: Slow Promscale ingestion.
       description: "Slowest 10% of ingestion batch took more than {{ $value }} seconds to ingest."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighLatency.md
   - alert: PromscaleIngestHighLatency
@@ -86,7 +86,7 @@ groups:
     labels:
       severity: critical
     annotations:
-      summary: Slow Promscale ingestion
+      summary: Slow Promscale ingestion.
       description: "Slowest 10% of ingestion batch took more than {{ $value }} seconds to ingest."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleIngestHighLatency.md
 - name: promscale-query
@@ -105,7 +105,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: High error rate in querying Promscale
+      summary: High error rate in querying Promscale.
       description: "Evaluating queries via Promscale has {{ $value | humanizePercentage }} error rate."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighErrorRate.md
   - alert: PromscaleQueryHighErrorRate
@@ -122,7 +122,7 @@ groups:
     labels:
       severity: critical
     annotations:
-      summary: High error rate in querying Promscale
+      summary: High error rate in querying Promscale.
       description: "Evaluating queries via Promscale had {{ $value | humanizePercentage }} error rate."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighErrorRate.md
   - alert: PromscaleQueryHighLatency
@@ -143,7 +143,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: Slow Promscale querying
+      summary: Slow Promscale querying.
       description: "Slowest 10% of the queries took more than {{ $value }} seconds to evaluate."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighLatency.md
   - alert: PromscaleQueryHighLatency
@@ -164,7 +164,7 @@ groups:
     labels:
       severity: critical
     annotations:
-      summary: Slow Promscale querying
+      summary: Slow Promscale querying.
       description: "Slowest 10% of the queries took {{ $value }} seconds to evaluate."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleQueryHighLatency.md
 - name: promscale-cache
@@ -183,7 +183,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: High cache eviction in Promscale
+      summary: High cache eviction in Promscale.
       description: "Promscale {{ $labels.name }} is evicting at {{ $value }} entries a second."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleCacheHighNumberOfEvictions.md
   - alert: PromscaleCacheTooSmall
@@ -200,7 +200,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: High cache eviction in Promscale
+      summary: High cache eviction in Promscale.
       description: "Promscale {{ $labels.name }} has a hit ratio of {{ $value | humanizePercentage }}."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleCacheTooSmall.md
 - name: promscale-database-connection
@@ -220,7 +220,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: Promscale experiences a high error rate when connecting to the database
+      summary: Promscale experiences a high error rate when connecting to the database.
       description: "Promscale connection with the database has an error of {{ $value | humanizePercentage }}."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleDBHighErrorRate.md
   - alert: PromscaleStorageHighLatency
@@ -239,7 +239,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: Slow database response
+      summary: Slow database response.
       description: "Slowest 10% of database requests are taking more than {{ $value }} seconds to respond."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleStorageHighLatency.md
 - name: promscale-database
@@ -258,7 +258,7 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: Promscale database is unhealthy
+      summary: Promscale database is unhealthy.
       description: "Promscale connection with the database has an error of {{ $value | humanizePercentage }}."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleStorageUnhealthy.md
   - alert: PromscaleMaintenanceJobRunningTooLong
@@ -279,16 +279,16 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: Promscale maintenance jobs taking too long to complete
+      summary: Promscale maintenance jobs taking too long to complete.
       description: "Promscale Database is taking {{ $value }} seconds to respond to Promscale's requests."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleMaintenanceJobRunningTooLong.md
   - alert: PromscaleMaintenanceJobFailures
     expr: promscale_sql_database_worker_maintenance_job_failed == 1
     labels:
       severity: warning
     annotations:
-      summary: Promscale maintenance job failed
-      description: "Promscale maintenance job failed to successfully execute."
+      summary: Promscale maintenance job failed.
+      description: "Maintenance job for Promscale instance {{ $labels.instance }} failed to successfully execute."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleMaintenanceJobFailures.md
   - alert: PromscaleCompressionLow
     expr: |
@@ -304,6 +304,6 @@ groups:
     labels:
       severity: warning
     annotations:
-      summary: High uncompressed data
+      summary: High uncompressed data.
       description: "High uncompressed data in Promscale, on average, {{ $value }} uncompressed chunks per metric."
       runbook_url: https://github.com/timescale/promscale/blob/master/docs/runbooks/PromscaleCompressionLow.md