You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,19 @@ The module takes care of configuration-driven:
22
22
* Telemetry and instrumentation
23
23
24
24
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.
26
40
27
-
This needs lots more documentation... Just a start.
0 commit comments