Skip to content

Commit 3d9b9e3

Browse files
committed
fix(docs): add more to the readme
1 parent fcc1045 commit 3d9b9e3

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,19 @@ The module takes care of configuration-driven:
2222
* Telemetry and instrumentation
2323

2424
services built with this module use Typescript with Node 18, which involves transpilation.
25-
This module takes that into account across the development and production experience.
25+
This module takes that into account across the development and production experience. It does
26+
not currently use ESM for the most part, because between OpenTelemetry, Jest, eslint and the
27+
package ecosystem, that is currently a pipe dream, or at least something that requires incredibly
28+
precise configuration, which is not the intent.
29+
30+
This module has the following core functionality:
31+
32+
1. Loads multilevel environment aware configuration, merging configuration information as appropriate to yield a single hierarchical configuration store. We use [confit](https://github.com/krakenjs/confit).
33+
2. Engage OpenTelemetry for tracing and metrics monitoring (via Prometheus-format metrics) and wire this into JSON-based pino logging.
34+
3. Setup an Express@5 application with common service hosting options such as body parsing, error handling and graceful shutdown.
35+
4. Find and load route handlers and static content serving, if desired.
36+
5. Validate and load OpenAPI 3 specifications and wire up methods to path-based route handlers including support for authentication.
37+
6. Launch a second express app to serve health checks and metrics
38+
7. Setup infrastructure for interservice calls with tracing.
39+
8. Provide a central service runner that handles loading your service and getting to a running state in both development and production environments.
2640

27-
This needs lots more documentation... Just a start.

0 commit comments

Comments
 (0)