Closed Bug 1353549 Opened 7 years ago Closed 7 years ago

document antenna troubleshooting [antenna]

Categories

(Socorro :: Antenna, task)

Product:
Socorro
Component:
Antenna
Type:
task
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: willkg, Assigned: willkg)

References

Details

We need to document how to troubleshoot Antenna. This includes the following:

1. Where are the relevant data used for troubleshooting? (datadog dashboards, grephost logs, cloudwatch, and so on)

2. How to diagnose various bad scenarios?


Documentation should either live in the Mana page with the rest of the Socorro docs or they should be nearby.

Further, we should add a troubleshooting section to the Antenna docs.
Why documenting this in both Mana and the Antenna docs? They're actually two different sets of things for two different groups. 

Documentation in Mana is for diagnosing problems in Antenna in -stage and -prod.

Documentation in the Antenna docs is for developers who are making changes in their local environment.
I added docs to Antenna in this PR: https://github.com/mozilla/antenna/pull/197

I'm going to coordinate with Miles about adding docs to the Ops pages in Mana. Those docs would target them, so we only want to document what's helpful for them.
Miles: The troubleshooting docs are here: http://antenna.readthedocs.io/en/latest/deploy.html#troubleshooting

Does that help you and your team at all? Are there things that doesn't cover that we should cover in Ops-centric docs in Mana?
Flags: needinfo?(miles)
That's lovely. The sort of thing I would cover in the ops-centric manapage are the specific AWS deployment architecture details, and I will get to that soon.
Flags: needinfo?(miles)
Ok. Given that, I'm going to call this done and if there's troubleshooting we want to write and/or copy over, we can do that in the future. Or you can do it. Or you can tell me to do it. Or some other option like that.

Marking as FIXED.
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Switching Antenna bugs to Antenna component.
Component: General → Antenna
You need to log in before you can comment on or make changes to this bug.