Skip to content

Commit

Permalink
Update docs with new debug info
Browse files Browse the repository at this point in the history
  • Loading branch information
spartan0x117 committed Nov 27, 2023
1 parent 0b5aa72 commit c2bac75
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/sources/flow/reference/components/module.http.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ arguments | [arguments][] | Arguments to pass to the module. | no
fallback_cache | [fallback_cache][] | A local cache that is used as a fallback if the remote endpoint is unavailable or returns an error. | no

[arguments]: #arguments-block
[fallback_cache]: #fallback_cache-(experimental)
[fallback_cache]: #fallback_cache-experimental

### arguments block

Expand Down Expand Up @@ -113,7 +113,9 @@ unhealthy, and the health includes the error from loading the module.

## Debug information

`module.http` does not expose any component-specific debug information.
`module.http` exposes the following debug information:

* (Relevant only when [fallback_cache][] is enabled) The total number of fallbacks to the local cache and the total number of failed fallbacks.

## Debug metrics

Expand Down
6 changes: 4 additions & 2 deletions docs/sources/flow/reference/components/remote.http.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ basic_auth` refers to an `basic_auth` block defined inside a `client` block.
[authorization]: #authorization-block
[oauth2]: #oauth2-block
[tls_config]: #tls_config-block
[fallback_cache]: #fallback_cache-(experimental)
[fallback_cache]: #fallback_cache-experimental

### client block

Expand Down Expand Up @@ -133,7 +133,9 @@ request of the specified URL succeeds.

## Debug information

`remote.http` does not expose any component-specific debug information.
`remote.http` exposes the following debug information:

* (Relevant only when [fallback_cache][] is enabled) The total number of fallbacks to the local cache and the total number of failed fallbacks.

## Debug metrics

Expand Down

0 comments on commit c2bac75

Please sign in to comment.