Merge pull request #1234 from FoalTS/add-logger

Add Foal logger and request ID
FoalTS · Oct 24, 2023 · a5e36dd · a5e36dd
2 parents 55dcf87 + 40ab005
commit a5e36dd
Show file tree

Hide file tree

Showing 91 changed files with 1,685 additions and 410 deletions.
diff --git a/docs/blog/assets/version-4.1-is-here/banner.png b/docs/blog/assets/version-4.1-is-here/banner.png
diff --git a/docs/blog/version-4.1-release-notes.md b/docs/blog/version-4.1-release-notes.md
@@ -0,0 +1,49 @@
+---
+title: Version 4.1 release notes
+author: Loïc Poullain
+author_title: Creator of FoalTS. Software engineer.
+author_url: https://loicpoullain.com
+author_image_url: https://avatars1.githubusercontent.com/u/13604533?v=4
+image: blog/twitter-banners/version-4.1-release-notes.png
+tags: [release]
+---
+
+![Banner](./assets/version-4.1-is-here/banner.png)
+
+Version 4.1 of [Foal](https://foalts.org/) is out!
+
+<!--truncate-->
+
+## Better logging
+
+Foal now features a true logging system. Full documentation can be found [here](../docs/common/logging).
+
+### New recommended configuration
+
+It is recommended to switch to this configuration to take full advantage of the new logging system.
+
+*config/default.json*
+```json
+{
+  "settings": {
+    "loggerFormat": "foal"
+  }
+}
+```
+
+*config/development.json*
+```json
+{
+  "settings": {
+    "logger": {
+      "format": "dev"
+    }
+  }
+}
+```
+
+## Request IDs
+
+On each request, a request ID is now generated randomly. It can be read through `ctx.request.id`.
+
+If the `X-Request-ID` header exists in the request, then the header value is used as the request identifier.
diff --git a/docs/docs/common/images/dev-format.png b/docs/docs/common/images/dev-format.png
diff --git a/docs/docs/common/images/json-format.png b/docs/docs/common/images/json-format.png
diff --git a/docs/docs/common/images/raw-format.png b/docs/docs/common/images/raw-format.png