From da853736d886c60ecabaa47ae2b5fd090ae41d51 Mon Sep 17 00:00:00 2001
From: riskpoint-per <peres.nimarico@rpgroup.com>
Date: Mon, 23 Jun 2025 00:04:59 +0100
Subject: [PATCH] update readme

---
 readme.md | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

diff --git a/readme.md b/readme.md
index 84ff410..6541544 100644
--- a/readme.md
+++ b/readme.md
@@ -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
@@ -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
 ---
@@ -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.