From 4684e118182a9c3c1cb21f0ed1cbd75ae4f5001c Mon Sep 17 00:00:00 2001 From: "backport-actions-token[bot]" <87506591+backport-actions-token[bot]@users.noreply.github.com> Date: Fri, 13 Aug 2021 14:09:50 -0700 Subject: [PATCH] docs: clarify custom request header limitations (#2471) (#2472) Signed-off-by: Bobby DeSimone Co-authored-by: bobby <1544881+desimone@users.noreply.github.com> --- docs/reference/readme.md | 9 +++++++-- docs/reference/settings.yaml | 5 +++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/reference/readme.md b/docs/reference/readme.md index 8c030a172..ef695e273 100644 --- a/docs/reference/readme.md +++ b/docs/reference/readme.md @@ -555,14 +555,14 @@ head -c32 /dev/urandom | base64 ### Tracing Tracing tracks the progression of a single user request as it is handled by Pomerium. -Each unit work is called a Span in a trace. Spans include metadata about the work, including the time spent in the step (latency), status, time events, attributes, links. You can use tracing to debug errors and latency issues in your applications, including in downstream connections. +Each unit of work is called a Span in a trace. Spans include metadata about the work, including the time spent in the step (latency), status, time events, attributes, links. You can use tracing to debug errors and latency issues in your applications, including in downstream connections. #### Shared Tracing Settings Config Key | Description | Required :------------------ | :----------------------------------------------------------------------------------- | -------- tracing_provider | The name of the tracing provider. (e.g. jaeger, zipkin) | ✅ -tracing_sample_rate | Percentage of requests to sample in decimal notation. Default is `0.0001`, or `.01%` | ❌ +tracing_sample_rate | Percentage of requests to sample in decimal notation. Default is `0.0001`, or .01% | ❌ #### Datadog @@ -1362,6 +1362,11 @@ Set Request Headers allows you to set static values for given request headers. T Authorization: Basic cm9vdDpodW50ZXI0Mg== X-Your-favorite-authenticating-Proxy: "Pomerium" ``` +:::warning + +Neither :-prefixed pseudo-headers nor the Host: header may be modified via this mechanism. Those headers may instead be modified via mechanisms such as prefix_rewrite, regex_rewrite, and host_rewrite. + +::: ### Remove Request Headers diff --git a/docs/reference/settings.yaml b/docs/reference/settings.yaml index 78d17c350..439b12f4a 100644 --- a/docs/reference/settings.yaml +++ b/docs/reference/settings.yaml @@ -1493,6 +1493,11 @@ settings: Authorization: Basic cm9vdDpodW50ZXI0Mg== X-Your-favorite-authenticating-Proxy: "Pomerium" ``` + :::warning + + Neither :-prefixed pseudo-headers nor the Host: header may be modified via this mechanism. Those headers may instead be modified via mechanisms such as prefix_rewrite, regex_rewrite, and host_rewrite. + + ::: - name: "Remove Request Headers" keys: ["remove_request_headers"] attributes: |