Metrics and diagnostics service

[dmitrii-ubskii]

Usage and product changes

We introduce a metrics and diagnostics service. The web endpoint is bound at port 4104 by default and exposes metrics formatted for prometheus (http://localhost:4104/metrics?format=prometheus) or as JSON (http://localhost:4104/metrics?format=JSON).

Example metrics:

# TypeDB version: TypeDB Core 2.26.6
# Time zone: Europe/London
# Java version: Azul Systems, Inc. 11.0.15
# Platform: Mac OS X aarch64 13.6.3

# TYPE typedb_attempted_requests_total counter
typedb_attempted_requests_total{kind="CONNECTION_OPEN"} 625
typedb_attempted_requests_total{kind="SERVERS_ALL"} 625
typedb_attempted_requests_total{kind="USER_MANAGEMENT"} 0
typedb_attempted_requests_total{kind="USER"} 0
typedb_attempted_requests_total{kind="DATABASE_MANAGEMENT"} 2606
typedb_attempted_requests_total{kind="DATABASE"} 252
typedb_attempted_requests_total{kind="SESSION"} 1207
typedb_attempted_requests_total{kind="TRANSACTION"} 2835

# TYPE typedb_successful_requests_total counter
typedb_successful_requests_total{kind="CONNECTION_OPEN"} 625
typedb_successful_requests_total{kind="SERVERS_ALL"} 625
typedb_successful_requests_total{kind="USER_MANAGEMENT"} 0
typedb_successful_requests_total{kind="USER"} 0
typedb_successful_requests_total{kind="DATABASE_MANAGEMENT"} 2606
typedb_successful_requests_total{kind="DATABASE"} 252
typedb_successful_requests_total{kind="SESSION"} 1207
typedb_successful_requests_total{kind="TRANSACTION"} 2755

# TYPE typedb_current_count gauge
typedb_current_count{kind="DATABASES"} 2
typedb_current_count{kind="SESSIONS"} 1
typedb_current_count{kind="TRANSACTIONS"} 1
typedb_current_count{kind="USERS"} 0

# TYPE typedb_error_total counter
typedb_error_total{code="TXN23"} 2
typedb_error_total{code="QRY22"} 4
typedb_error_total{code="TXN19"} 2
typedb_error_total{code="THR10"} 19

We also extract the metrics reporter into a separate module within the diagnostics package and redirect it to the dedicated diagnostics service.

[vaticle-bot]

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.

---

Trivial Change

• [ ] This change is trivial and does not require a code or architecture review.

Code

• [x] Packages, classes, and methods have a single domain of responsibility.
• [x] Packages, classes, and methods are grouped into cohesive and consistent domain model.
• [x] The code is canonical and the minimum required to achieve the goal.
• [x] Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
• [x] Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
• [x] The code is algorithmically efficient and scalable for the whole application.

Architecture

• [x] Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
• [x] Any required build and release automations are updated and/or implemented.
• [x] Any new components follows a consistent style with respect to the pre-existing codebase.
• [x] The architecture intuitively reflects the application domain, and is easy to understand.
• [x] The architecture has a well-defined hierarchy of encapsulated components.
• [x] The architecture is extensible and scalable.