Skip to content

Commit ca6f35a

Browse files
authored
Add alert examples to monitoring.md (#469)
Cherry-picking so we can link monitoring.md from an amp.dev blog post prior to the scheduled release of the master branch.
1 parent 7d23ba9 commit ca6f35a

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

monitoring.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ recommend you do:
2222
[grafana](https://prometheus.io/docs/visualization/grafana/).
2323
1. Setup [alerts](https://prometheus.io/docs/alerting/latest/overview/) that
2424
will notify you of abnormal behavior (e.g. latencies growing beyond 60
25-
seconds).
25+
seconds - see more [examples](#example-alerts) below).
2626

2727
The sections below walk you through the available metrics, explain how to
2828
manually check them via command line, and how to interpret the results. All the
@@ -226,3 +226,17 @@ the `amppackager` server binary. Every request to `/metrics` is served with the
226226
stats accumulated since the server's been up, up to the time of the request, but
227227
not including the request itself.
228228

229+
## Example alerts
230+
231+
Below are a few examples of indicators of possibly abnormal behavior of
232+
`amppackager` and/or the underlying AMP document server. Feel free to adjust the
233+
numbers and check these manually, or setup automatic alerts in Prometheus:
234+
235+
* Non-200 responses count going beyond 1% of all requests.
236+
* Latencies 90 percentile going beyond 60 seconds (of either server).
237+
* Document size 90 percentile going beyond 3.5MB.
238+
* Unsigned documents count going beyond 1% of all documents.
239+
240+
When designing the alerts for your setup, pay special attention to
241+
[requirements](README.md#limitations) that `amppackager` imposes on the AMP
242+
documents you serve.

0 commit comments

Comments
 (0)