zhenyi

Distributed real-time applications (Actor engine)

Built on zhenyi-base (MIT); zhenyi is licensed under AGPL-3.0 + commercial dual license · long-lived connections · low latency

中文 · Documentation index · Xinchuang · Actions · zhenyi-base

Introduction

zhenyi builds on zhenyi-base with an Actor runtime, unified gateway (TCP/WebSocket/KCP), cross-process bus & discovery, metrics and tracing for long-lived connections and real-time backends. For the module map and architecture, see the documentation index (large tables are maintained there, not here). Under same-host benchmarking on 2 vCPU / 4 GiB, two measured profiles are validated: ~40k QPS over a 7-day steady run (P99 ~1-2ms) and ~166k QPS in a 1-hour high-pressure run; see the benchmark report.

Highlights

• Actor runtime: service-level Actors, MPSC mailbox, Tick/RPC, goroutine pool; optional circuit breaking and rate limiting.
• Unified gateway: zgate supports TCP / WebSocket / KCP, optional HTTP, TLS / GM-TLS, application-layer payload encryption.
• Distributed: Etcd discovery, NATS cross-process bus, remote routing (including RendezvousHash).
• Observability: Prometheus, health probes, tracing, monitoring snapshots; see Monitoring overview.
• Continuous profiling (optional): zpyroscope, decoupled from zmetrics; see Monitoring overview section 4.
• Performance: message pooling, refcounting and zero-copy-oriented hot paths (verify against source and benchmarks).
• Xinchuang / domestic IT: build and run notes in Xinchuang.

Quick start

go test ./... -count=1
go run ./examples/im_single_demo
# Second terminal: go run ./examples/im_single_client

The single-process demo does not require Etcd/NATS; multi-process examples (e.g. im_multi_demo) need Etcd + NATS → Examples overview (including --reactor / --sharedSendWorker and mmo_web_demo).

Documentation

License & compliance

AGPL-3.0 + commercial dual license. Open-source use must follow LICENSE. For commercial use, closed distribution, or network services to third parties, read COMMERCIAL_LICENSE_EN.md first.
Commercial contact: 1093993119@qq.com

Development & CI

make test           # unit tests
make release-check  # pre-release: doc links + tests, etc.

For more Make targets and benchmarks, see each Makefile and Examples.

This README is only an entry point; per-package docs live under each directory (README.md / README_EN.md), with a single hub at DOCS_INDEX_EN.
Some documentation may be drafted with AI assistance and reviewed by maintainers. The repo runs CI (tests, race, coverage, go vet, doc link checks, etc.—see .github/workflows). Legal terms: LICENSE. If docs and behavior disagree, defer to reproducible source and tests. Issues and PRs welcome.