Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ experimental:
plugins:
traefik-middleware-request-logger:
moduleName: "github.com/cookielab/traefik-middleware-request-logger"
version: "v0.0.7"
version: "v0.0.9"
```

Add plugin into traefik via dynamic configuration (kubernetes)

```yml
apiVersion: traefik.containo.us/v1alpha1
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
name: my-traefik-middleware-request-logger
Expand All @@ -32,8 +32,13 @@ spec:
- 200
```


Configuration:
When logging to stdout or stderr only the LogTarget value can be `stdout` or `stderr`.
When logging to url the LogTarget value must be `url` and the LogTargetUrl must be a valid url.


Example `stdout`:

```yml
---
Expand All @@ -46,8 +51,25 @@ StatusCodes: # log only these status codes
- 200
SkipHeaders:
- Authorization
LogTarget: stdout # or "stderr" or "url"
LogTargetUrl: https://consumer.logs.example.com/input
LogTarget: stdout # or "stderr"
```


Example `url`:
Note: `LogTarget` value must be `url` in and the `LogTargetUrl` must be a valid url.

```yml
---
ContentTypes: # log only these content types
- application/json
Limits:
MaxBodySize: 1048576 # max size of request/response body
RequestIDHeaderName: X-Request-ID # save uniq request id into this header
StatusCodes: # log only these status codes
- 200
SkipHeaders:
- Authorization
LogTarget: url
LogTargetUrl: https://consumer.logs.example.com/input
```
Conditions use "AND" (all conditions must be true). When request or response size exeed limit, the info string is present.