Commit 8d599bd
Antonio Mika
·
2026-10-25 16:35:27 -0400 EDT
parent bd8701e
feat(caddy): require a token for metrics routes
5 files changed,
+90,
-0
+20,
-0
| ... | ... | @@ -8,8 +8,24 @@ | |
| 8 | 8 | } | |
| 9 | 9 | } | |
| 10 | 10 | ||
| 11 | + | # Metrics routes need ?x-authorization={$METRICS_TOKEN}. An unset token matches | |
| 12 | + | # nothing. | |
| 13 | + | (metrics_token) { | |
| 14 | + | expression `{http.request.uri.query.x-authorization} == "{$METRICS_TOKEN}" && "{$METRICS_TOKEN}" != ""` | |
| 15 | + | } | |
| 16 | + | ||
| 17 | + | # Apps serve metrics on /_metrics, which only the token-checked routes reach. | |
| 18 | + | # Scrapes stay out of the access logs so the token does too. | |
| 19 | + | (block_app_metrics) { | |
| 20 | + | @appmetrics path /_metrics /_metrics/* | |
| 21 | + | respond @appmetrics 404 | |
| 22 | + | @metricsroutes path /_caddy/metrics /_ssh/metrics /_web/metrics /_imgproxy/metrics /_app/metrics | |
| 23 | + | log_skip @metricsroutes | |
| 24 | + | } | |
| 25 | + | ||
| 11 | 26 | # custom domains | |
| 12 | 27 | :443 { | |
| 28 | + | import block_app_metrics | |
| 13 | 29 | reverse_proxy web:3000 | |
| 14 | 30 | log { | |
| 15 | 31 | format append { |
| ... | ... | @@ -24,6 +40,7 @@ | |
| 24 | 40 | ||
| 25 | 41 | # subdomains and root app domain | |
| 26 | 42 | *.{$APP_DOMAIN}, {$APP_DOMAIN} { | |
| 43 | + | import block_app_metrics | |
| 27 | 44 | reverse_proxy web:3000 | |
| 28 | 45 | log { | |
| 29 | 46 | format append { |
| ... | ... | @@ -61,6 +78,7 @@ | |
| 61 | 78 | @caddymetrics { | |
| 62 | 79 | host {$APP_DOMAIN} | |
| 63 | 80 | path /_caddy/metrics | |
| 81 | + | import metrics_token | |
| 64 | 82 | } | |
| 65 | 83 | ||
| 66 | 84 | metrics @caddymetrics { |
| ... | ... | @@ -70,6 +88,7 @@ | |
| 70 | 88 | @sshmetrics { | |
| 71 | 89 | host {$APP_DOMAIN} | |
| 72 | 90 | path /_ssh/metrics | |
| 91 | + | import metrics_token | |
| 73 | 92 | } | |
| 74 | 93 | ||
| 75 | 94 | handle @sshmetrics { |
| ... | ... | @@ -80,6 +99,7 @@ | |
| 80 | 99 | @webmetrics { | |
| 81 | 100 | host {$APP_DOMAIN} | |
| 82 | 101 | path /_web/metrics | |
| 102 | + | import metrics_token | |
| 83 | 103 | } | |
| 84 | 104 | ||
| 85 | 105 | handle @webmetrics { |
+19,
-0
| ... | ... | @@ -4,7 +4,23 @@ | |
| 4 | 4 | } | |
| 5 | 5 | } | |
| 6 | 6 | ||
| 7 | + | # Metrics routes need ?x-authorization={$METRICS_TOKEN}. An unset token matches | |
| 8 | + | # nothing. | |
| 9 | + | (metrics_token) { | |
| 10 | + | expression `{http.request.uri.query.x-authorization} == "{$METRICS_TOKEN}" && "{$METRICS_TOKEN}" != ""` | |
| 11 | + | } | |
| 12 | + | ||
| 13 | + | # Apps serve metrics on /_metrics, which only the token-checked routes reach. | |
| 14 | + | # Scrapes stay out of the access logs so the token does too. | |
| 15 | + | (block_app_metrics) { | |
| 16 | + | @appmetrics path /_metrics /_metrics/* | |
| 17 | + | respond @appmetrics 404 | |
| 18 | + | @metricsroutes path /_caddy/metrics /_ssh/metrics /_web/metrics /_imgproxy/metrics /_app/metrics | |
| 19 | + | log_skip @metricsroutes | |
| 20 | + | } | |
| 21 | + | ||
| 7 | 22 | *.pico.sh, pico.sh { | |
| 23 | + | import block_app_metrics | |
| 8 | 24 | @auth { | |
| 9 | 25 | host auth.pico.sh | |
| 10 | 26 | } |
| ... | ... | @@ -16,6 +32,7 @@ | |
| 16 | 32 | @ircmetrics { | |
| 17 | 33 | host irc.pico.sh | |
| 18 | 34 | path /_app/metrics | |
| 35 | + | import metrics_token | |
| 19 | 36 | } | |
| 20 | 37 | ||
| 21 | 38 | @options { |
| ... | ... | @@ -26,6 +43,7 @@ | |
| 26 | 43 | @caddymetrics { | |
| 27 | 44 | host auth.pico.sh | |
| 28 | 45 | path /_caddy/metrics | |
| 46 | + | import metrics_token | |
| 29 | 47 | } | |
| 30 | 48 | ||
| 31 | 49 | metrics @caddymetrics { |
| ... | ... | @@ -35,6 +53,7 @@ | |
| 35 | 53 | @webmetrics { | |
| 36 | 54 | host auth.pico.sh | |
| 37 | 55 | path /_web/metrics | |
| 56 | + | import metrics_token | |
| 38 | 57 | } | |
| 39 | 58 | ||
| 40 | 59 | handle @webmetrics { |
+21,
-0
| ... | ... | @@ -14,8 +14,24 @@ | |
| 14 | 14 | } | |
| 15 | 15 | } | |
| 16 | 16 | ||
| 17 | + | # Metrics routes need ?x-authorization={$METRICS_TOKEN}. An unset token matches | |
| 18 | + | # nothing. | |
| 19 | + | (metrics_token) { | |
| 20 | + | expression `{http.request.uri.query.x-authorization} == "{$METRICS_TOKEN}" && "{$METRICS_TOKEN}" != ""` | |
| 21 | + | } | |
| 22 | + | ||
| 23 | + | # Apps serve metrics on /_metrics, which only the token-checked routes reach. | |
| 24 | + | # Scrapes stay out of the access logs so the token does too. | |
| 25 | + | (block_app_metrics) { | |
| 26 | + | @appmetrics path /_metrics /_metrics/* | |
| 27 | + | respond @appmetrics 404 | |
| 28 | + | @metricsroutes path /_caddy/metrics /_ssh/metrics /_web/metrics /_imgproxy/metrics /_app/metrics | |
| 29 | + | log_skip @metricsroutes | |
| 30 | + | } | |
| 31 | + | ||
| 17 | 32 | # custom domains | |
| 18 | 33 | :443 { | |
| 34 | + | import block_app_metrics | |
| 19 | 35 | reverse_proxy web:3000 | |
| 20 | 36 | log { | |
| 21 | 37 | format append { |
| ... | ... | @@ -30,6 +46,7 @@ | |
| 30 | 46 | ||
| 31 | 47 | # subdomains and root pgs domain | |
| 32 | 48 | *.{$APP_DOMAIN}, {$APP_DOMAIN} { | |
| 49 | + | import block_app_metrics | |
| 33 | 50 | reverse_proxy web:3000 | |
| 34 | 51 | log { | |
| 35 | 52 | format append { |
| ... | ... | @@ -65,6 +82,7 @@ | |
| 65 | 82 | @caddymetrics { | |
| 66 | 83 | host {$APP_DOMAIN} *.{$APP_DOMAIN} | |
| 67 | 84 | path /_caddy/metrics | |
| 85 | + | import metrics_token | |
| 68 | 86 | } | |
| 69 | 87 | ||
| 70 | 88 | metrics @caddymetrics { |
| ... | ... | @@ -74,6 +92,7 @@ | |
| 74 | 92 | @sshmetrics { | |
| 75 | 93 | host {$APP_DOMAIN} *.{$APP_DOMAIN} | |
| 76 | 94 | path /_ssh/metrics | |
| 95 | + | import metrics_token | |
| 77 | 96 | } | |
| 78 | 97 | ||
| 79 | 98 | handle @sshmetrics { |
| ... | ... | @@ -84,6 +103,7 @@ | |
| 84 | 103 | @webmetrics { | |
| 85 | 104 | host {$APP_DOMAIN} *.{$APP_DOMAIN} | |
| 86 | 105 | path /_web/metrics | |
| 106 | + | import metrics_token | |
| 87 | 107 | } | |
| 88 | 108 | ||
| 89 | 109 | handle @webmetrics { |
| ... | ... | @@ -96,6 +116,7 @@ | |
| 96 | 116 | @imgproxymetrics { | |
| 97 | 117 | host {$APP_DOMAIN} *.{$APP_DOMAIN} | |
| 98 | 118 | path /_imgproxy/metrics | |
| 119 | + | import metrics_token | |
| 99 | 120 | } | |
| 100 | 121 | ||
| 101 | 122 | handle @imgproxymetrics { |
+8,
-0
| ... | ... | @@ -4,6 +4,12 @@ | |
| 4 | 4 | } | |
| 5 | 5 | } | |
| 6 | 6 | ||
| 7 | + | # Metrics routes need ?x-authorization={$METRICS_TOKEN}. An unset token matches | |
| 8 | + | # nothing. | |
| 9 | + | (metrics_token) { | |
| 10 | + | expression `{http.request.uri.query.x-authorization} == "{$METRICS_TOKEN}" && "{$METRICS_TOKEN}" != ""` | |
| 11 | + | } | |
| 12 | + | ||
| 7 | 13 | {$APP_DOMAIN} { | |
| 8 | 14 | reverse_proxy https://pico-docs-prod.pgs.sh { | |
| 9 | 15 | header_up Host pico.sh |
| ... | ... | @@ -17,6 +23,7 @@ | |
| 17 | 23 | @caddymetrics { | |
| 18 | 24 | host {$APP_DOMAIN} | |
| 19 | 25 | path /_caddy/metrics | |
| 26 | + | import metrics_token | |
| 20 | 27 | } | |
| 21 | 28 | ||
| 22 | 29 | metrics @caddymetrics { |
| ... | ... | @@ -26,6 +33,7 @@ | |
| 26 | 33 | @sshmetrics { | |
| 27 | 34 | host {$APP_DOMAIN} | |
| 28 | 35 | path /_ssh/metrics | |
| 36 | + | import metrics_token | |
| 29 | 37 | } | |
| 30 | 38 | ||
| 31 | 39 | handle @sshmetrics { |
+22,
-0
| ... | ... | @@ -8,8 +8,24 @@ | |
| 8 | 8 | } | |
| 9 | 9 | } | |
| 10 | 10 | ||
| 11 | + | # Metrics routes need ?x-authorization={$METRICS_TOKEN}. An unset token matches | |
| 12 | + | # nothing. | |
| 13 | + | (metrics_token) { | |
| 14 | + | expression `{http.request.uri.query.x-authorization} == "{$METRICS_TOKEN}" && "{$METRICS_TOKEN}" != ""` | |
| 15 | + | } | |
| 16 | + | ||
| 17 | + | # Apps serve metrics on /_metrics, which only the token-checked routes reach. | |
| 18 | + | # Scrapes stay out of the access logs so the token does too. | |
| 19 | + | (block_app_metrics) { | |
| 20 | + | @appmetrics path /_metrics /_metrics/* | |
| 21 | + | respond @appmetrics 404 | |
| 22 | + | @metricsroutes path /_caddy/metrics /_ssh/metrics /_web/metrics /_imgproxy/metrics /_app/metrics | |
| 23 | + | log_skip @metricsroutes | |
| 24 | + | } | |
| 25 | + | ||
| 11 | 26 | # custom domains | |
| 12 | 27 | :443 { | |
| 28 | + | import block_app_metrics | |
| 13 | 29 | reverse_proxy web:3000 | |
| 14 | 30 | log { | |
| 15 | 31 | format append { |
| ... | ... | @@ -24,6 +40,7 @@ | |
| 24 | 40 | ||
| 25 | 41 | # subdomains and root app domain | |
| 26 | 42 | *.{$APP_DOMAIN}, {$APP_DOMAIN} { | |
| 43 | + | import block_app_metrics | |
| 27 | 44 | reverse_proxy web:3000 | |
| 28 | 45 | log { | |
| 29 | 46 | format append { |
| ... | ... | @@ -61,6 +78,7 @@ | |
| 61 | 78 | @caddymetrics { | |
| 62 | 79 | host {$APP_DOMAIN} | |
| 63 | 80 | path /_caddy/metrics | |
| 81 | + | import metrics_token | |
| 64 | 82 | } | |
| 65 | 83 | ||
| 66 | 84 | metrics @caddymetrics { |
| ... | ... | @@ -70,6 +88,7 @@ | |
| 70 | 88 | @sshmetrics { | |
| 71 | 89 | host {$APP_DOMAIN} | |
| 72 | 90 | path /_ssh/metrics | |
| 91 | + | import metrics_token | |
| 73 | 92 | } | |
| 74 | 93 | ||
| 75 | 94 | handle @sshmetrics { |
| ... | ... | @@ -80,6 +99,7 @@ | |
| 80 | 99 | @webmetrics { | |
| 81 | 100 | host {$APP_DOMAIN} | |
| 82 | 101 | path /_web/metrics | |
| 102 | + | import metrics_token | |
| 83 | 103 | } | |
| 84 | 104 | ||
| 85 | 105 | handle @webmetrics { |