Improve logging of "Internal API unreachable" / "api/v4/internal/authorized_keys" events
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
What is the GitLab engineering productivity problem to solve?
GitLab Shell usually logs gl_project_path
. However, in case of Internal API unreachable
events for requests to api/v4/internal/authorized_keys
that field is not logged (and nothing else, which a customer could easily provide).
See these examples in our GitLab.com logs: No ID-able information, except for the key
parameter. Using the first part of the key, up to the first +
for example seems to be helpful for finding specific events, though.
Supporting customers who report such problems or Permission denied (publickey)
errors would get easier, if Gitaly/GitLab-Shell logs contained more details about those requests.
Problem identification checklist
-
The root cause of the problem is identified. -
The surface of the problem is as small as possible.
What are the potential solutions?
-
Add relevant fields to the
Internal API unreachable
event log -
And/or add details to the
connection: initServerConn: failed to initialize SSH connection
error -
All potential solutions are listed. -
A solution has been chosen for the first iteration: PUT THE CHOSEN SOLUTION HERE
Verify that the solution has improved the situation
-
The solution improved the situation. - If yes, check this box and close the issue. Well done!
🎉 - Otherwise, create a new "Productivity Improvement" issue. You can re-use the description from this issue, but another solution should be chosen this time.
- If yes, check this box and close the issue. Well done!