Fix: prometheus: alerts: use "troubleshooting" instead of "playbook" annotation (#102) (48390666) · Commits · The Tor Project / Onion Services / Onionprobe

configs/prometheus/prometheus-rules.yml

+6 −6

Original line number	Diff line number	Diff line
		@@ -29,7 +29,7 @@ groups:
		Onionprobe is unreachable
		description: >
		Unable to determine Onionprobe state
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onionprobe-not-responding'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onionprobe-not-responding'

		- name: Onion Services
		rules:
		@@ -43,7 +43,7 @@ groups:
		Onion Service unreachable: {{ $labels.address }}
		description: >
		Onionprobe was unable to connect to the Onion Service: {{ $labels.address }}
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-unreachable'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-unreachable'

		- alert: Onion Service descriptor unreachable
		expr: onion_service_descriptor_reachable != 1
		@@ -56,7 +56,7 @@ groups:
		description: >
		The Onion Service descriptor for {{ $labels.address}} has become
		unreachable from Onionprobe.
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-descriptor-unreachable'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-descriptor-unreachable'

		- alert: Invalid TLS certificate for the Onion Service
		expr: onion_service_valid_certificate != 1
		@@ -67,7 +67,7 @@ groups:
		Invalid TLS certificate for the Onion Service: {{ $labels.address }}
		description: >
		The TLS certificate for the Onion Service {{ $labels.address }} is invalid
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#invalid-tls-certificate-for-the-onion-service'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#invalid-tls-certificate-for-the-onion-service'

		- alert: Expiring TLS certificate for the Onion Service
		expr: onion_service_certificate_expiry_seconds < 86400 * 7
		@@ -79,7 +79,7 @@ groups:
		description: >
		The TLS certificate for the Onion Service {{ $labels.address }} will
		expie in less than a week.
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#expiring-tls-certificate-for-the-onion-service'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#expiring-tls-certificate-for-the-onion-service'

		- alert: Unexpected HTTP status code
		expr: onion_service_unexpected_status_code == 1
		@@ -92,4 +92,4 @@ groups:
		description: >
		Onionprobe got an unexpected HTTP status code when trying to connect
		to {{ $labels.address }}
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#unexpected-http-status-code'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#unexpected-http-status-code'

configs/prometheus/prometheus-tests.yml

+6 −6

Original line number	Diff line number	Diff line
		@@ -85,7 +85,7 @@ tests:
		Onionprobe is unreachable
		description: >
		Unable to determine Onionprobe state
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onionprobe-not-responding'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onionprobe-not-responding'
		- eval_time: 19m
		alertname: Onionprobe not responding
		exp_alerts: []
		@@ -119,7 +119,7 @@ tests:
		description: >
		Onionprobe was unable to connect to the Onion Service:
		testn5cs76tk2hk3mwoqkugkwwcljp4c6gpzoclwou7mmobiqabn5wid.onion
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-unreachable'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-unreachable'

		# Descriptor reachability tests
		- interval: 1m
		@@ -148,7 +148,7 @@ tests:
		The Onion Service descriptor for
		testn5cs76tk2hk3mwoqkugkwwcljp4c6gpzoclwou7mmobiqabn5wid.onion
		has become unreachable from Onionprobe.
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-descriptor-unreachable'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#onion-service-descriptor-unreachable'

		# Invalid certificate tests
		- interval: 1m
		@@ -177,7 +177,7 @@ tests:
		The TLS certificate for the Onion Service
		testn5cs76tk2hk3mwoqkugkwwcljp4c6gpzoclwou7mmobiqabn5wid.onion
		is invalid
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#invalid-tls-certificate-for-the-onion-service'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#invalid-tls-certificate-for-the-onion-service'

		# Certificate expiration tests
		- interval: 1m
		@@ -212,7 +212,7 @@ tests:
		The TLS certificate for the Onion Service
		testn5cs76tk2hk3mwoqkugkwwcljp4c6gpzoclwou7mmobiqabn5wid.onion
		will expie in less than a week.
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#expiring-tls-certificate-for-the-onion-service'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#expiring-tls-certificate-for-the-onion-service'

		# Status code tests
		- interval: 1m
		@@ -243,4 +243,4 @@ tests:
		description: >
		Onionprobe got an unexpected HTTP status code when trying to
		connect to testn5cs76tk2hk3mwoqkugkwwcljp4c6gpzoclwou7mmobiqabn5wid.onion
		playbook: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#unexpected-http-status-code'
		troubleshooting: 'https://onionservices.torproject.org/apps/web/onionprobe/troubleshooting/#unexpected-http-status-code'