Skip to content

Commit 23ce2ca

Browse files
committed
docs: document oauth2.user_agent for OAuth2 token requests
Signed-off-by: rja5 <rallen99@gmail.com>
1 parent d3d0a7a commit 23ce2ca

3 files changed

Lines changed: 3 additions & 0 deletions

File tree

administration/configuring-fluent-bit/yaml/pipeline-section.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ Output plugins that support outgoing `OAuth 2.0` authentication can expose the f
196196
| `oauth2.refresh_skew_seconds` | Seconds before expiry at which to refresh the access token. | `60` |
197197
| `oauth2.timeout` | Timeout for token requests. | `0s` |
198198
| `oauth2.connect_timeout` | Connect timeout for token requests. | `0s` |
199+
| `oauth2.user_agent` | Optional `User-Agent` header to include on OAuth 2.0 token requests. | _none_ |
199200

200201
### Example output configuration
201202

pipeline/outputs/http.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ The _HTTP_ output plugin lets you flush your records into an HTTP endpoint. It i
5050
| `oauth2.scope` | Optional `OAuth 2.0` scope. | _none_ |
5151
| `oauth2.timeout` | Timeout for `OAuth 2.0` token requests. Defaults to `http.response_timeout` when unset. | `0s` |
5252
| `oauth2.token_url` | `OAuth 2.0` token endpoint URL. | _none_ |
53+
| `oauth2.user_agent` | Optional `User-Agent` header value to include in `OAuth 2.0` token requests. If omitted, no `User-Agent` header is sent. | _none_ |
5354
| `port` | TCP port of the target HTTP Server. | `80` |
5455
| `proxy` | Specify an HTTP Proxy. The expected format of this value is `http://HOST:PORT`. HTTPS isn't supported. It's recommended to configure the [HTTP proxy environment variables](https://docs.fluentbit.io/manual/administration/http-proxy) instead as they support both HTTP and HTTPS. | _none_ |
5556
| `uri` | Specify an optional HTTP URI for the target web server. For example, `/somepath`. | _none_ |

pipeline/outputs/opentelemetry.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ Only HTTP endpoints are supported.
8888
| `oauth2.scope` | Optional `OAuth 2.0` scope. | _none_ |
8989
| `oauth2.timeout` | Timeout for `OAuth 2.0` token requests. | `0s` |
9090
| `oauth2.token_url` | `OAuth 2.0` token endpoint URL. | _none_ |
91+
| `oauth2.user_agent` | Optional `User-Agent` header value to include in `OAuth 2.0` token requests. If omitted, no `User-Agent` header is sent. | _none_ |
9192
| `port` | TCP port of the target HTTP server. | `80` |
9293
| `profiles_uri` | Specify an optional HTTP URI for the profiles OTel endpoint. | `/v1development/profiles` |
9394
| `proxy` | Specify an HTTP Proxy. The expected format of this value is `http://host:port`.| _none_ |

0 commit comments

Comments
 (0)