diff options
author | 2023-02-17 12:02:29 +0100 | |
---|---|---|
committer | 2023-02-17 12:02:29 +0100 | |
commit | 68e6d08c768b789987a753d42f66caf73ce10ee1 (patch) | |
tree | 1c9eb6da6c326266d653de80684c3aec58922638 /docs/configuration/observability.md | |
parent | [bugfix] Set 'discoverable' properly on API accounts (#1511) (diff) | |
download | gotosocial-68e6d08c768b789987a753d42f66caf73ce10ee1.tar.xz |
[feature] Add a request ID and include it in logs (#1476)
This adds a lightweight form of tracing to GTS. Each incoming request is
assigned a Request ID which we then pass on and log in all our log
lines. Any function that gets called downstream from an HTTP handler
should now emit a requestID=value pair whenever it logs something.
Co-authored-by: kim <grufwub@gmail.com>
Diffstat (limited to 'docs/configuration/observability.md')
-rw-r--r-- | docs/configuration/observability.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/configuration/observability.md b/docs/configuration/observability.md new file mode 100644 index 000000000..0d5f9e864 --- /dev/null +++ b/docs/configuration/observability.md @@ -0,0 +1,16 @@ +# Observability + +These settings let you tune and configure certain observability related behaviours. + +## Settings + +```yaml +################################## +##### OBSERVABILITY SETTINGS ##### +################################## + +# String. Header name to use to extract a request or trace ID from. Typically set by a +# loadbalancer or proxy. +# Default: "X-Request-Id" +request-id-header: "X-Request-Id" +``` |