Skip to content

docs(architecture): correct database and add three opening details #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
catinspace-au merged 1 commit into from
Nov 14, 2026
Merged

docs(architecture): correct database and add three opening details #218

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/architecture/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@ HyperDX is DFE's **visualisation and search layer**: engineers use it to search
logs, view traces, build dashboards and replay sessions. Detection, alerting and
response are the DFE platform's job, not HyperDX's.

Three things make our deployment different from stock HyperDX, and everything
Five things make our deployment different from stock HyperDX, and everything
else follows from them:

- **Authentication is external.** Envoy terminates OIDC and passes identity
headers; HyperDX never sees a password.
- **Authorization is the DFE engine's.** It is the policy decision point, and
- Authentication is external: Envoy terminates OIDC and passes identity
headers, and HyperDX never sees a password.
- Authorization is the DFE engine's: it is the policy decision point, and
ClickHouse GRANTs enforce data access.
- **MongoDB is replaced** by FerretDB over PostgreSQL.
- MongoDB is replaced by DocumentDB, PostgreSQL with the DocumentDB
extensions and its Mongo wire-protocol gateway in one container
([ADR 0006](../decisions/0006-documentdb-replaces-ferretdb.md)).
- The DFE 2.1 discovery tool's enhancements are ported in.
- Rules are generated from the query you are iterating in front of you.
- JSON is native throughout, the ClickHouse JSON type included.

What we changed to achieve that, and how we keep it working across upstream
releases, is [the fork documentation](../fork/README.md).
Expand Down
Loading