Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Update github template for customer issues to include troubleshooting steps #35974

Open
caugustus-sourcegraph opened this issue May 24, 2022 · 9 comments
Assignees
Labels
team/delivery Delivery team

Comments

@caugustus-sourcegraph
Copy link
Contributor

caugustus-sourcegraph commented May 24, 2022

Determine a small set of troubleshooting data that should be gathered for a customer escalation (cpu/memory usage, error logs, etc.). These should apply to both docker-compose and kubernetes deployments and be non-burdensome for the customer to gather.

Work with the CS team to confirm this information is achievable and add it to the github template used for customer escalations.

Potentially helpful / relevant: sourcegraph/src-cli#731

Problem

There is no standard approach to gathering resource information or troubleshooting data during customer escalations. Long-term, we hope to automate the collection of this information, but in the meantime we want to provide a small set of standard information gathered before an issue is escalated.

/cc @sourcegraph/delivery

@kevinwojo
Copy link
Contributor

Took a brief look at what would be needed to semi-automatically pull Grafana dashboards as images, we would need to deploy another container called "renderer" alongside Grafana and make some API calls.

https://grafana.com/grafana/plugins/grafana-image-renderer/#run-in-docker

Additionally, I think we would need to name our dashboards in a predictable manner ... it's not clear to me how the path to a panel is determined or if naming is consistent across deployments: https://community.grafana.com/t/getting-a-rendered-panel-via-api/1559

@kevinwojo
Copy link
Contributor

Looking at the src debug command, it appears that it iterates through a listing of pods or containers (depending on deployment) and creates a zip archive of log files. This would be very helpful, but may be tricky to write in ticket template format.

@kevinwojo
Copy link
Contributor

Another resource we have: the support command generator: https://sourcegraph.github.io/support-generator/

@caugustus-sourcegraph
Copy link
Contributor Author

@kevinwojo kevinwojo self-assigned this Jun 9, 2022
@malomarrec
Copy link
Contributor

Hey @benvenker, it looks like this issue was created by someone outside Sourcegraph. Assigning you to triage it! Please answer and route to the right team by adding their team label.

@malomarrec
Copy link
Contributor

Hey @benvenker, just a reminder to triage this issue and remove the triage-bot/needs-triage label when you're done!

3 similar comments
@malomarrec
Copy link
Contributor

Hey @benvenker, just a reminder to triage this issue and remove the triage-bot/needs-triage label when you're done!

@malomarrec
Copy link
Contributor

Hey @benvenker, just a reminder to triage this issue and remove the triage-bot/needs-triage label when you're done!

@malomarrec
Copy link
Contributor

Hey @benvenker, just a reminder to triage this issue and remove the triage-bot/needs-triage label when you're done!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
team/delivery Delivery team
Projects
None yet
Development

No branches or pull requests

3 participants