Clarify the difference between auth header and per-RPC auth (open-tel…

…emetry#2590) Closes open-telemetry#2508 by clarifying how the PerRPCAuth option differs from an `authorization` header sent when a connection is first established. Signed-off-by: Juraci Paixão Kröhling <[email protected]>
mantian2020 · Mar 5, 2021 · 03802c2 · 03802c2
1 parent 1f9a07f
commit 03802c2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/config/configgrpc/README.md b/config/configgrpc/README.md
@@ -25,6 +25,9 @@ README](../configtls/README.md).
   - `timeout`
 - [`read_buffer_size`](https://godoc.org/google.golang.org/grpc#ReadBufferSize)
 - [`write_buffer_size`](https://godoc.org/google.golang.org/grpc#WriteBufferSize)
+- [`per_rpc_auth`](https://pkg.go.dev/google.golang.org/grpc#PerRPCCredentials): the credentials to send for every RPC. Note that this isn't about sending the headers only during the initial connection as an `authorization` header under the `headers` would do: this is sent for every RPC performed during an established connection.
+  - `auth_type`: the authentication type, currently only `bearer` is supported
+  - `bearer_token`: the bearer token to use for each RPC call.
 
 Example: