Skip to content
Snippets Groups Projects

doc: Debugging Gitaly

Merged Andras Horvath requested to merge ahorvath-debugdoc-20240628 into main

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
  • 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

Commits

  • doc: Debugging Gitaly

Edited by Andras Horvath

Merge request reports

Merge train pipeline #1370831706 passed

Merge train pipeline passed for c9b38662

Merged by Andras HorvathAndras Horvath 7 months ago (Jul 12, 2024 7:33am UTC)

Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Eric Ju
  • Eric Ju
  • cc @gl-gitaly, need your knowledge here :smile:

  • James Liu
  • added 1 commit

    Compare with previous version

  • 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 1 commit

    • ee35117d - doc: Add an introduction to Gitaly's monitoring dashboards and metrics

    Compare with previous version

  • Using combined codequality.json

    :warning:️ Pipeline Failure - Linting Errors

    One 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.

  • added 1 commit

    • b429e058 - doc: Fix vale linter warnings and errors

    Compare with previous version

  • added 1 commit

    • 48617070 - doc: Convert permanent links inside Gitaly debug guide to master links

    Compare with previous version

  • added 1 commit

    • 606018ed - Apply 2 suggestion(s) to 1 file(s)

    Compare with previous version

  • added 1 commit

    Compare with previous version

  • Andras Horvath requested review from @jcaigitlab

    requested review from @jcaigitlab

  • requested review from @echui-gitlab

  • Eric Ju
  • Eric Ju
  • added 1 commit

    Compare with previous version

  • Eric Ju added 1 commit

    added 1 commit

    • d0b5512e - Fix Gitaly Host details link

    Compare with previous version

  • Andras Horvath resolved all threads

    resolved all threads

  • added 1 commit

    Compare with previous version

  • John Cai approved this merge request

    approved this merge request

  • Emily Chui approved this merge request

    approved this merge request

  • Andras Horvath resolved all threads

    resolved all threads

  • John Cai resolved all threads

    resolved all threads

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading