Beginner tutorial on using Sentry and Kibana to debug and follow issues.
Details
Details
- Reviewers
moranegg ardumont - Group Reviewers
Reviewers - Commits
- rDDOC49d06700b32a: Add a guide on debugging and monitoring issues
Diff Detail
Diff Detail
- Repository
- rDDOC Development documentation
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
Event Timeline
Comment Actions
Nice tutorial!
Very informative for me.
I have added a couple of stylish comments and a few questions for improvement.
| docs/issue-debugging-monitoring.md | ||
|---|---|---|
| 7 | As a developer, the tools used on the SWH infrastructure are Sentry and Kibana, which are specialized tools for debugging in production. | |
| 12 | "You will need" instead of "Your need" | |
| 21 | maybe an example for each in a list manner: can be filtered by: - project (e.g _______) - environment (e.g _______) - time range (e.g _______) | |
| 23 | A suggestion to a list view: On an issue view, you can access: - the particular issue (how is that shown- error message?) - execution trace - error point - contextual metadata (including....) - post mortem (including ...) | |
| 25 | Easier to read in a list: The metadata properties that are visible and helpful are: - first and last occurrence - corresponding component versions, - installed packages - server environment. I've added helpful in the text, might be interesting to know why this metadata is helpful | |
| 33 | Here you can find a step by step example of an issue investigation for the microservice Question: is "architectures" the name of the service? Before continuing with the origin of the issue, maybe a short description of what was supposed to happen and what did happen instead. | |
| 85 | You will need access to the SWH VPN and it is available without credentials. | |
| 107 | is that Lucene or KML? better to specify | |
| 125 | Do we have custom view to add as examples? | |