doc: Debugging Gitaly
Why is this change being made?
Primarily aimed at Create oncall training for Gitaly (gitlab-org/core-platform-section/discussions#178), also serve as a basis for debugging customer issues.
This is NOT oncall training, but a supporting document for that, as well as for customer issues or just simply debugging while developing.
The main goal is to bring everyone on the same page about what tools are available, and lower their barrier of entry. It's intended both for newcomers and as reference material in day-to-day.
Author and Reviewer Checklist
Please verify the check list and ensure to tick them off before the MR is merged.
-
Provided a concise title for this Merge Request (MR) -
Added a description to this MR explaining the reasons for the proposed change, per say why, not just what - Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
-
Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI) - If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
Maintained by
section on the page being edited - If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
- The when to get approval handbook section explains the workflow in more detail
- If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
-
For transparency, share this MR with the audience that will be impacted. -
Team: For changes that affect your direct team, share in your group Slack channel -
Department: If the update affects your department, share the MR in your department Slack channel -
Division: If the update affects your division, share the MR in your division Slack channel -
Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR - For high-priority company-wide announcements work with the internal communications team to post the update in #company-fyi and align on a plan to circulate in additional channels like the "While You Were Iterating" Newsletter
-
Commits
- doc: Debugging Gitaly
Merge request reports
Activity
added HandbookContent label
assigned to @andrashorvath
Using combined codequality.json
️ Pipeline Failure - Linting ErrorsOne of the linters has reported errors and as a result the pipeline has failed. Once the pipeline completes, you'll find the code quality report above which can link you to where the error is in your code. Additionally, below you'll find a table of the errors. The table has links to the lint rules so you can find more information on how to fix the issue(s).
Rule File Line Error MD032 content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 12 Lists should be surrounded by blank lines MD032 content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 16 Lists should be surrounded by blank lines handbook.RelativeLinks content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 12 Use a relative link instead of the full URL. handbook.RelativeLinks content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 13 Use a relative link instead of the full URL. handbook.RelativeLinks content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 16 Use a relative link instead of the full URL. handbook.RelativeLinks content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 17 Use a relative link instead of the full URL. If you need more help please reach out on Slack in #mr-buddies.
mentioned in issue gitlab-org/core-platform-section/discussions#178
Using combined codequality.json
️ Pipeline Failure - Linting ErrorsOne of the linters has reported errors and as a result the pipeline has failed. Once the pipeline completes, you'll find the code quality report above which can link you to where the error is in your code. Additionally, below you'll find a table of the errors. The table has links to the lint rules so you can find more information on how to fix the issue(s).
Rule File Line Error MD032 content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 12 Lists should be surrounded by blank lines MD032 content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 16 Lists should be surrounded by blank lines If you need more help please reach out on Slack in #mr-buddies.
Using combined codequality.json
️ Pipeline Failure - Linting ErrorsOne of the linters has reported errors and as a result the pipeline has failed. Once the pipeline completes, you'll find the code quality report above which can link you to where the error is in your code. Additionally, below you'll find a table of the errors. The table has links to the lint rules so you can find more information on how to fix the issue(s).
Rule File Line Error If you need more help please reach out on Slack in #mr-buddies.
added 1 commit
- 59103099 - Add links to Granfa, Kibana dashboards and tools gprcurl grpcui hyperfine
Using combined codequality.json
️ Pipeline Failure - Linting ErrorsOne of the linters has reported errors and as a result the pipeline has failed. Once the pipeline completes, you'll find the code quality report above which can link you to where the error is in your code. Additionally, below you'll find a table of the errors. The table has links to the lint rules so you can find more information on how to fix the issue(s).
If you need more help please reach out on Slack in #mr-buddies.
- Resolved by Quang-Minh Nguyen
- Resolved by Andras Horvath
- Resolved by Andras Horvath
cc @gl-gitaly, need your knowledge here
- Resolved by Andras Horvath
@gerardo we're collecting debug tools, any cool Gitaly-related stuff from Support?
- Resolved by Quang-Minh Nguyen
- Resolved by Quang-Minh Nguyen
- Resolved by Andras Horvath
When you are ready for this MR to be reviewed please tag
@gitlab-com/office-of-the-ceo
as it modifies a.gitlab/CODEOWNERS
that they maintain.This message was generated automatically. You're welcome to improve it.
added Office of the CEO label
added 1 commit
- ee35117d - doc: Add an introduction to Gitaly's monitoring dashboards and metrics
Using combined codequality.json
️ Pipeline Failure - Linting ErrorsOne of the linters has reported errors and as a result the pipeline has failed. Once the pipeline completes, you'll find the code quality report above which can link you to where the error is in your code. Additionally, below you'll find a table of the errors. The table has links to the lint rules so you can find more information on how to fix the issue(s).
Rule File Line Error handbook.RelativeLinks content/handbook/engineering/infrastructure/core-platform/systems/gitaly/debug.md 45 Use a relative link instead of the full URL. If you need more help please reach out on Slack in #mr-buddies.
- Resolved by Andras Horvath
- Resolved by Quang-Minh Nguyen
added 1 commit
- 48617070 - doc: Convert permanent links inside Gitaly debug guide to master links
- Resolved by Andras Horvath
- Resolved by Andras Horvath
requested review from @jcaigitlab
requested review from @echui-gitlab
- Resolved by Eric Ju
- Resolved by Eric Ju
- Resolved by John Cai
@jcaigitlab @echui-gitlab can this be merged now (and of course we can keep iterating)?
mentioned in merge request gitlab-org/gitaly!7070 (merged)