The Ergo Framework is an implementation of ideas, technologies, and design patterns from the Erlang world in the Go programming language. It is based on the actor model, network transparency, and a set of ready-to-use components for development. This significantly simplifies the creation of complex and distributed solutions while maintaining a high level of reliability and performance.
Actor Model: isolated processes communicate through message passing, handling messages sequentially in their own mailbox with four priority queues. Processes support both asynchronous messaging and synchronous request-response patterns, enabling flexible communication while maintaining the actor model guarantees.
Network Transparency: actors interact the same way whether local or remote. The framework uses custom serialization and protocol for efficient distributed communication with connection pooling, compression, and type caching, making network location transparent to application code.
Supervision Trees: hierarchical fault recovery where supervisors monitor child processes and apply restart strategies when failures occur. Supports multiple supervision types (One For One, All For One, Rest For One, Simple One For One) and restart strategies (Transient, Temporary, Permanent) for building self-healing systems.
Meta Processes: bridge blocking I/O with the actor model through dedicated meta processes that handle TCP, UDP, Port, and Web protocols. Meta processes run blocking operations without affecting regular actor message processing.
Distributed Systems: service discovery through embedded or external registrars (etcd, Saturn), distributed publish/subscribe events with token-based authorization and buffering, remote process spawning with factory-based permissions, and remote application orchestration across nodes.
Ready-to-use Components: core framework includes Actor, Supervisor, Pool, and WebWorker actors plus TCP, UDP, Port, and Web meta processes. Extra library provides Leader, Metrics actors, WebSocket, SSE meta processes, Observer application, Colored and Rotate loggers, Erlang protocol support.
Flexibility: customize network stack components, certificate management, compression and message priorities, logging, distributed events, and meta processes. Framework supports mTLS, NAT traversal, important delivery for guaranteed messaging, and Cron-based scheduling.
Examples demonstrating the framework's capabilities are available in the examples repository.
On a 64-core processor, Ergo Framework demonstrates a performance of over 21 million messages per second locally and nearly 5 million messages per second over the network.
Available benchmarks can be found in the benchmarks repository.
Messaging performance (local, network)
Memory consumption per process (demonstrates framework memory footprint)
Serialization performance comparison: EDF vs Protobuf vs Gob
Distributed Pub/Sub (event delivery to 1,000,000 subscribers across 10 nodes)
To inspect the node, network stack, running applications, and processes, you can use the observer tool
To install the Observer tool, you need to have the Go compiler version 1.20 or higher. Run the following command:
$ go install ergo.tools/observer@latest
You can also embed the Observer application into your node. To see it in action, see the demo example. For more information, visit the Observer documentation.
For a quick start, use the ergo tool — a command-line utility designed to simplify the process of generating boilerplate code for your project based on the Ergo Framework. With this tool, you can rapidly create a complete project structure, including applications, actors, supervisors, network components, and more. It offers a set of arguments that allow you to customize the project according to specific requirements, ensuring it is ready for immediate development.
To install use the following command:
$ go install ergo.tools/ergo@latest
Now, you can create your project with just one command. Here is example:
Supervision tree
mynode
├─ myapp
│ │
│ └─ mysup
│ │
│ └─ myactor
├─ myweb
└─ myactor2
To generate project for this design use the following command:
$ ergo -init MyNode \
-with-app MyApp \
-with-sup MyApp:MySup \
-with-actor MySup:MyActor \
-with-web MyWeb \
-with-actor MyActor2 \
-with-observer
as a result you will get generated project:
mynode
├── apps
│ └── myapp
│ ├── myactor.go
│ ├── myapp.go
│ └── mysup.go
├── cmd
│ ├── myactor2.go
│ ├── mynode.go
│ ├── myweb.go
│ └── myweb_worker.go
├── go.mod
├── go.sum
└── README.md
to try it:
$ cd mynode
$ go run ./cmd
Since we included Observer application, open http://localhost:9911 to inspect your node and running processes.
Starting from version 3.0.0, support for the Erlang network stack has been moved to a separate module. Version 3.0 was distributed under the BSL 1.1 license, but starting from version 3.1 it is available under the MIT license. Detailed information is available in the Erlang protocol documentation.
Fully detailed changelog see in the ChangeLog file.
gen.CertAuthManager interface for mutual TLS with CA pool management (ClientCAs, RootCAs, ClientAuth, ServerName). See Mutual TLS documentationRouteHost and RoutePort options in gen.AcceptorOptions for nodes behind NAT or load balancers. See Behind the NAT documentationInitTimeout option in gen.ProcessOptions limits ProcessInit duration for both local and remote spawn. Remote spawn and application processes limited to max 15 seconds. See Process documentationgen.Ref methods for request timeout tracking. See Generic Types:Deadline - returns deadline timestamp stored in referenceIsAlive - checks if reference is still valid (deadline not exceeded)gen.Node methods. See Node documentation:ProcessPID / ProcessName - resolve process PID by name and vice versaCall, CallWithTimeout, CallWithPriority, CallImportant, CallPID, CallProcessID, CallAlias - synchronous requests from Node interfaceInspect / InspectMeta - inspect processes and meta processesMakeRefWithDeadline - create reference with embedded deadlinegen.RemoteNode.ApplicationInfo - query application information from remote nodes. See Remote Start Application documentationgen.Process methods. See Process documentation:SendWithPriorityAfter - delayed send with prioritySendExitAfter / SendExitMetaAfter - delayed exit signalsSendResponseImportant / SendResponseErrorImportant - important delivery for responsesgen.Meta methods. See Meta Process documentation:SendResponse / SendResponseError - respond to requests from meta processSendPriority / SetSendPriority - message priority controlCompression / SetCompression - compression settingsEnvDefault - get environment variable with default valuegen.ApplicationSpec / gen.ApplicationInfo fields:Tags - labels for instance selection (blue/green, canary, maintenance). See Tags for Instance SelectionMap - logical role to process name mapping. See Process Role MappingRemoteNode.Spawn / RemoteNode.SpawnRegisternode/tm/) - improved architecture for process, event, and node target management with comprehensive test coveragegen.Process methods now available during initialization:Link*, Unlink*, Monitor*, Demonitor*Call*, Inspect, InspectMetaRegisterName, UnregisterName, RegisterEvent, UnregisterEventSendResponse*, SendResponseError*CreateAlias, DeleteAliasShutdownTimeout option in gen.NodeOptions (default 3 minutes). During graceful shutdown, pending processes are logged every 5 seconds with state and queue info. After timeout, node force exits with error code 1. See Node documentation--tags pprof) - each process goroutine is labeled with its PID, each meta process with its Alias, making it easy to identify stuck processes in pprof outputdocs/) and available at docs.ergo.servicesDebugging - build tags, pprof integration, troubleshooting stuck processes
Extra Library - Actors (https://github.com/ergo-services/actor):
Introduced Metrics actor - Prometheus metrics exporter that collects node/network telemetry via HTTP endpoint. Features: automatic collection of node metrics (uptime, processes, memory), network metrics per remote node, extensible for custom metrics. See documentation
Extra Library - Meta Processes (https://github.com/ergo-services/meta):