@ogcio/fastify-logging-wrapper 5.1.2 → 5.2.2

package/README.md

@@ -5,20 +5,24 @@ This logging wrapper goal is to standardize the records written by our Fastify s
 ## How to
 
 To use this package three steps are needed:
+
 - install the package with
-```
+
+```bash
 npm i @ogcio/fastify-logging-wrapper
 ```
 
 - use the `getLoggingConfiguration()` method to get the configuration for the `fastify` server
-```
+
+```typescript
 const server = fastify({
     ...getLoggingConfiguration()
 });
 ```
 
 - after the server is initialized, invoke the `initializeLoggingHooks(server)` to setup the needed `fastify` hooks
-```
+
+```typescript
 initializeLoggingHooks(server);
 ```
 
@@ -29,15 +33,21 @@ That's it! Just log as you usually do!
 We will have 3 mandatory log entries that will be written for each request the service manages.
 
 Those 3 records are:
+
 - **New Request**, written when a request is received
+
 ```
 {"level":30,"level_name":"INFO","hostname":"hostname","request_id":"q9Y6NwwbRimle4TxcXRPkQ-0000000000","timestamp":1713868947766,"request":{"scheme":"http","method":"GET","path":"/ping","hostname":"localhost:80","query_params":{},"headers":{"user-agent":"lightMyRequest","host":"localhost:80"},"client_ip":"127.0.0.1","user_agent":"lightMyRequest"},"message":"NEW_REQUEST"}
 ```
+
 - **Response**, containing most of the response data
+
 ```
 {"level":30,"level_name":"INFO","hostname":"hostname","request_id":"q9Y6NwwbRimle4TxcXRPkQ-0000000000","timestamp":1713868947769,"request":{"scheme":"http","method":"GET","path":"/ping","hostname":"localhost:80","query_params":{}},"response":{"status_code":200,"headers":{"content-type":"application/json; charset=utf-8","content-length":"17"}},"message":"RESPONSE"}
 ```
+
 - **API Track**, it contains data about the lifecycle of the request, including errors, if any
+
 ```
 {"level":30,"level_name":"INFO","hostname":"hostname","request_id":"5c_RLAnSS4y9-Q5STsJyiQ-0000000008","timestamp":1713869128434,"request":{"scheme":"http","method":"GET","path":"/this-path-must-not-exist","hostname":"localhost:80","query_params":{"status_code":"404","error_message":"Not Found"}},"response":{"status_code":404,"headers":{"content-type":"application/json; charset=utf-8","content-length":"107"}},"error":{"class":"REQUEST_ERROR","message":"Not Found","code":"FST_ERR_NOT_FOUND"},"message":"API_TRACK"}
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ogcio/fastify-logging-wrapper",
-    "version": "5.1.2",
+    "version": "5.2.2",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "type": "module",
@@ -18,9 +18,9 @@
     "description": "Enable standardized log entries for each request in fastify",
     "dependencies": {
         "@fastify/error": "^4.0.0",
-        "@fastify/sensible": "^6.0.1",
-        "@ogcio/shared-errors": "^1.0.0",
-        "fastify": "^5.1.0",
+        "@fastify/sensible": "^6.0.2",
+        "@ogcio/shared-errors": "^1.1.0",
+        "fastify": "^5.2.1",
         "hyperid": "^3.3.0"
     },
     "devDependencies": {

package/tsconfig.json

@@ -9,4 +9,4 @@
     "references": [
       { "path": "../shared-errors" }
     ]
-  }
+  }