diff --git a/README.md b/README.md index 2f35025..bb94e0a 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,18 @@ The PagerDuty Agent is completely open-source which means that you can download the source code and customize it for your needs. The Agent requires Python 2.7 or higher. The instructions here assume that you're -on a Mac. +on a Mac +# Notes +Events are added to a local queue + +- If PagerDuty Agent loses connectivity for whatever reason + - Events in the queue will fail to send and be retried and stored according to the agent's retry logic + - There is no hard limit on the number of events stored in the queue + - Once connectivity is regained, queued events may be pushed out automatically + - In the case of prolonged outages, sends can be manually retried + > + + - If the agent runs up against the API Rate Limit, the rate limited events will be retried in perpetuty until they are either successfully delivered, or receive a `5xx` response, which will invoke the retry logic ## Developing