Microbus is a holistic open source framework for the development, testing, deployment and operation of microservices at scale. It combines best-in-class OSS, tooling and best practices into a dramatically-simplified engineering experience.
Build entire cloud-enabled, enterprise-class and web-scalable solutions comprising a multitude of microservices, all on your local development machine. Deploy to suit your needs, as a standalone executable or individual containers.
Start by defining the various properties of the microservice in a YAML file
general:
host: hello.world
configs:
signature: Greeting() (hello string)
default: Hello
validation: str ^[A-Z][a-z]*$
functions:
signature: Add(x int, y int) (sum int)
webs:
signature: Hello()
method: GET
events:
signature: OnDouble(x int)Use the powerful code generator to create boilerplate and skeleton code
func (svc *Service) Add(ctx context.Context, x int, y int) (sum int, err error) {
// TO DO: Implement Add
return nil
}
func (svc *Service) Hello(w http.ResponseWriter, r *http.Request) (err error) {
// TO DO: Implement Hello
return nil
}Fill in the gaps with the business logic of the particular microservice
func (svc *Service) Add(ctx context.Context, x int, y int) (sum int, err error) {
if x == y {
// Publish an event
helloworldapi.NewTrigger(svc).OnDouble(ctx, x)
}
// Marshaling to JSON is done automatically
return x+y, nil
}
func (svc *Service) Hello(w http.ResponseWriter, r *http.Request) (err error) {
// Access the config
greeting := svc.Greeting()
// Call another microservice via its client stub
user, err := userstoreapi.NewClient(svc).Me(r.Context())
if err != nil {
// Just return the error
return errors.Trace(err)
}
message := fmt.Sprintf("%s, %s!", greeting, user.FullName())
w.Write([]byte(message))
return nil
}Add the microservice to the application that manages its lifecycle
func main() {
app := application.New()
app.Add(
configurator.NewService(),
)
app.Add(
httpegress.NewService(),
openapiportal.NewService(),
metrics.NewService(),
)
app.Add(
// Add solution microservices here
helloworld.NewService(),
)
app.Add(
httpingress.NewService(),
)
app.Run()
}Deploy your apps across machines or availability zones. Microservices communicate via a messaging bus at up to 10X the speed of HTTP/1.1
Distributed tracing, metrics and structured logging provide precision observability of system internals
👉 Follow the quick start guide to set up your system and run the example app
👉 Go through the various examples
👉 Follow the step-by-step guide and build your first microservice
👉 Discover the power of code generation. It's totally RAD, dude
👉 Learn how to write thorough integration tests and achieve high code coverage
👉 Venture out and explore more on your own
👉 Ready? Build your own solution from scratch
Build your microservices on top of a Connector construct and use its simple API to communicate with other microservices using familiar HTTP semantics. Under the hood, communication happens over a real-time messaging bus.
Microbus brings together the patterns and best practices that get it right from the get-go, all in a developer-friendly holistic framework that throws complexity under the bus:
- Unicast 1:1 request/response
- Multicast 1:N publish/subscribe
- Persistent multiplexed connections
- Dynamic service discovery
- Load balancing
- Time budget
- Ack or fail fast
- Locality-aware routing
- Connectivity liveness check
- Structured logging
- Distributed tracing
- Metrics
- Error capture and propagation
- Configuration
- Client stubs
- Live integration tests
- OpenAPI
- Graceful shutdown
- Distributed caching
- Embedded static resources
- Recurring jobs
Dig deeper into the technology of Microbus and its philosophy.
- Architectural diagram - A map of the building blocks of
Microbusand how they stack up - Catalog of packages - Find your way around the codebase
- Code generation - Discover the power of
Microbus's powerful RAD tool - Configuration - How to configure microservices
- Path arguments - Define wildcard path arguments in subscriptions
- HTTP magic arguments - Use HTTP magic arguments in functional endpoints to gain finer control over the HTTP request and response
- Integration testing - Test a multitude of microservices together
- Environment variables - Environment variables used to initialize microservices
- NATS connection settings - How to configure microservices to connect and authenticate to NATS
- RPC over JSON vs REST - Implement these common web API styles
- Adaptable topology - Grow the topology of your system to match your requirements
- Bootstrap a new project - Create a project for your solution
- Create a new microservice - Create a new microservice and add it to your solution
- HTTP ingress proxy - The HTTP ingress proxy bridges the gap between HTTP and
Microbus - Unicast messaging - Unicast enables bi-directional 1:1 request/response HTTP messaging between a client and a single server over the bus
- Multicast messaging - Extending on the unicast pattern, multicast enables bi-directional 1:N publish/subscribe HTTP messaging between a client and a multitude of servers over the bus
- Error capture - How and why errors are captured and propagated across microservices boundaries
- Time budget - The right way to manage client-to-server request timeouts
- Control subscriptions - Subscriptions that all microservices implement out of the box on port
:888 - Deployment environments - An application can run in one of 4 deployment environments:
PROD,LAB,LOCALandTESTING - Events - How event-driven architecture can be used to decouple microservices
- Distributed tracing - Visualizing stack traces across microservices using OpenTelemetry and Jaeger
- OpenAPI - OpenAPI document generation for microservices
- Local development - Run an entire solution comprising a multitude of microservices in your local IDE
- Structured logging - JSON logging to
stderr - Ack or fail fast - Acks signal the sender if its request was received
- Graceful shutdown - Graceful shutdown drains pending operations before termination
- Tickers - Tickers are jobs that run on a schedule
- Multiplexed connections - Multiplexed connections are more efficient than HTTP/1.1
- Load balancing - Load balancing requests among all replicas of a microservice
- Internationalization - Loading and localizing strings from
strings.yaml - Locality-aware routing - Optimizing service-to-service communication
- Connectivity liveness tests - A microservice's connection to the messaging bus represents its liveness
- Skeleton code - Skeleton code is a placeholder for filling in meaningful code
- Client stubs - Client stubs facilitate calling downstream microservices
- Encapsulation pattern - The reasons for encapsulating third-party technologies
- JSON vs Protobuf - Why JSON over HTTP was chosen as the protocol
- Out of scope - Areas that
Microbusstays out of
- Milestones - Each milestone of
Microbusis maintained in a separate branch for archival purposes and to demonstrate the development process and evolution of the code.
A microservice architecture is best suited for addressing the technical and organizational scalability challenges of a business as it grows. Without microservices, the complexity of a monolithic codebase often grows to a point where the engineering team can no longer innovate and collaborate efficiently. In most likelihood the entire solution has to be rewritten at a critical point of the business - when it is growing rapidly - and at prohibitive cost. Investing in microservices from the get-go is a wise investment that mitigates this upside risk.
Building and operating microservices at scale, however, is quite difficult and beyond the skills of most engineering teams. It's easy to spin up one web server and call it a microservice but things get exponentially more complicated the more microservices are added to the mix. Many teams at some point either call it quits and stop adding microservices, or introduce complex tooling such as service meshes to help manage the complexity. Adding complexity to solve complexity is a self-defeating strategy: the chickens eventually come home to roost.
Microbus takes a novel approach to the development, testing, deployment and troubleshooting of microservices, and eliminates much of the complexity of the conventional practice. Microbus is a holistic open source framework that combines best-in-class OSS, tooling and best practices into a dramatically-simplified engineering experience that boosts productivity 4x.
Microbus is the culmination of a decade of research and has been successfully battle-tested in production settings running SaaS solutions comprising many dozens of microservices.
Microbus is a holistic open source framework for the development, testing, deployment and operation of microservices at scale.
Microbus combines best-in-class OSS, tooling and best practices into an elevated engineering experience that eliminates much of the complexity of the conventional practice.
Microbus’s runtime substrate is highly performant, strongly reliable and horizontally scalable.
Microbus conforms to industry standards and interoperates smoothly with existing systems.
We want your feedback. Clone the repo, try things out and let us know what worked for you, what didn't and what you'd like to see improved.
Help us spread the word. Let your peers and the Go community know about Microbus.
Give us a Github ⭐. And ask your friends to give us one too!
Reach out if you'd like to contribute code.
Corporation? Contact us for sponsorship opportunities.
Find us at any of the following channels. We're looking forward to hearing from you so don't hesitate to drop us a line.
| Find us at... | |
|---|---|
| Website | www.microbus.io |
| info@microbus.io | |
| Github | github.com/microbus-io |
| linkedin.com/company/microbus-io | |
| Slack | microbus-io.slack.com |
| Discord | discord.gg/FAJHnGkNqJ |
| r/microbus | |
| YouTube | @microbus-io |
The Microbus framework is the copyrighted work of various contributors. It is licensed to you free of charge by Microbus LLC - a Delaware limited liability company formed to hold rights to the combined intellectual property of all contributors - under the Apache License 2.0.
Refer to the list of third-party open source software for licensing information of components used by the Microbus framework.