Commit b990f975 authored by Igor's avatar Igor Committed by Evan Read

Document Gitaly passing CORRELATION_ID to git processes

parent b51b1083
...@@ -1072,6 +1072,24 @@ You can run a gRPC trace with: ...@@ -1072,6 +1072,24 @@ You can run a gRPC trace with:
sudo GRPC_TRACE=all GRPC_VERBOSITY=DEBUG gitlab-rake gitlab:gitaly:check sudo GRPC_TRACE=all GRPC_VERBOSITY=DEBUG gitlab-rake gitlab:gitaly:check
``` ```
### Correlating Git processes with RPCs
Sometimes you need to find out which Gitaly RPC created a particular Git process.
One method for doing this is via `DEBUG` logging. However, this needs to be enabled
ahead of time and the logs produced are quite verbose.
A lightweight method for doing this correlation is by inspecting the environment
of the Git process (using its `PID`) and looking at the `CORRELATION_ID` variable:
```shell
PID=<Git process ID>
sudo cat /proc/$PID/environ | tr '\0' '\n' | grep ^CORRELATION_ID=
```
Please note that this method is not reliable for `git cat-file` processes because Gitaly
internally pools and re-uses those across RPCs.
### Observing `gitaly-ruby` traffic ### Observing `gitaly-ruby` traffic
[`gitaly-ruby`](#gitaly-ruby) is an internal implementation detail of Gitaly, [`gitaly-ruby`](#gitaly-ruby) is an internal implementation detail of Gitaly,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment