Skip to content

Commit

Permalink
doc(main): Added documentation (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekkinox committed Jan 30, 2024
1 parent c3c7600 commit 040daa9
Show file tree
Hide file tree
Showing 7 changed files with 620 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/modules/fxhttpclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ modules:

## Logging

This module enables to log automatically the requests made by the [Client](https://pkg.go.dev/net/http#Client) and their responses:
This module enables to log automatically the HTTP requests made by the [Client](https://pkg.go.dev/net/http#Client) and their responses:

```yaml title="configs/config.yaml"
modules:
Expand All @@ -126,11 +126,11 @@ If `modules.http.client.log.response.level_from_response=true`, the response cod
- `400 <= code < 500`: log level `warn`
- `code >= 500`: log level `error`

The http client logging will be based on the [fxlog](fxlog.md) module configuration.
The HTTP client logging will be based on the [fxlog](fxlog.md) module configuration.

## Tracing

This module enables to trace automatically the requests made by the [Client](https://pkg.go.dev/net/http#Client):
This module enables to trace automatically HTTP the requests made by the [Client](https://pkg.go.dev/net/http#Client):

```yaml title="configs/config.yaml"
modules:
Expand All @@ -140,7 +140,7 @@ modules:
enabled: true # to trace http calls, disabled by default
```

The http client tracing will be based on the [fxtrace](fxtrace.md) module configuration.
The HTTP client tracing will be based on the [fxtrace](fxtrace.md) module configuration.

## Testing

Expand Down
Loading

0 comments on commit 040daa9

Please sign in to comment.