Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding some notes #166

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

adding some notes #166

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0efe6db
adding some notes
subrama6 Jun 13, 2022
5b9801a
responding to PR feedback
subrama6 Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@ 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
- If PagerDuty Agent loses connectivity for whatever reason,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be good to state that regardless of if the agent loses network connectivity then the events are added to the local queue. Then we can state that if the agent loses network connectivity events in the queue will fail to send, are retried and stored according to the agent's retry logic. Depending on how long the network issues persist they may be pushed out automatically, if the event is still being retried.

On another note, events that are rate limited will be retried in perpetuity until the event is successfully delivered, or the event receives a 5XX error code in which case the retry logic kicks in.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For prolonged network outages events can be manually retried https://support.pagerduty.com/docs/pagerduty-agent-integration-guide#manage-the-queue

- There is no hard limit on the number of events stored in the queue
- Once connectivity is regained, queued events will be pushed out automatically

- If the agent runs up against the API Rate Limit, the rate limited events will be added to the queue of failed events, which will automatically be retried later


## Developing

Expand Down