Skip to content
@go-orb

go-orb

go-orb Logo License Go.Dev reference Go Report Card Discord

Orb is a framework for distributed systems development, it can be seen as the successor of go-micro.dev/v4.

⚠️ WIP

This project is a work in progress, please do not use yet!

We are not far from the releasing the first Alpha, see the Roadmap.

🚀 What's new since v4

Use of wire

With wire we gain:

  • compile-time safety
  • no more globals

It was the main reason for starting orb, wire allows us to decouple the components and plugins.

No more reflect

we have been working hard on removing all usage of reflect.

Multiple Entrypoints

Orb allows you to listen on multiple port's with different protocols: gRPC, HTTP, HTTPS, DRPC, HTTP2, H2C, HTTP3. See the config system entry on howto configure it.

Advanced config system

With orb you can configure your plugins with a config file or environment options.

service1:
  server:
    handlers:
      - Streams
    middlewares:
      - middleware-1
    entrypoints:
      - name: grpc
        plugin: grpc
        insecure: true
        reflection: false
  registry:
    enabled: true
    plugin: mdns
    timeout: 350
    domain: svc.orb
service1:
  server:
    handlers:
      - Streams
    middlewares:
      - middleware-1
      - middleware-2
    entrypoints:
      - name: hertzhttp
        plugin: hertz
        http2: false
        insecure: true

      - name: grpc
        plugin: grpc
        insecure: true
        reflection: false
        handlers:
          - ImOnlyOnGRPC
        middlewares:
          - ImAGRPCSpecificMiddlware

      - name: http
        plugin: http
        insecure: true

      - name: drpc
        plugin: drpc
  registry:
    plugin: consul
    address: consul:8500

These 2 config's with different options will both work, we first parse the config, get the "plugin" from it and pass a map[any]any with all config data to the plugin.

Both work with a single binary. :)

Proto conform handlers

Return types as a result instead of HTTP req format.

New:

req := HelloRequest{Name: "test"}

// Look at resp, it's now returned as a result.
resp , err := client.Call[HelloResponse](context.Background(), clientDi, "org.orb.svc.hello", "Say.Hello", &req)

Old:

req := c.c.NewRequest(c.serviceName, "Greeter.Hello", in)
out := new(HelloResponse)
err := c.c.Call(ctx, req, out, opts...)
if err != nil {
  return nil, err
}
return out, nil

Send json

go-orb has support for sending nearly anything you throw in as application/json to the Server.

pre encoded / proxy

resp , err := client.Call[map[string]any](context.Background(), clientDi, "org.orb.svc.hello", "Say.Hello", `{"name": "Alex"}`, client.WithContentType("application/json"))

map[string]any{}

req := make(map[string]any)
req["name"] = "Alex"

resp , err := client.Call[map[string]any](context.Background(), clientDi, "org.orb.svc.hello", "Say.Hello", req, client.WithContentType("application/json"))

Structured logging

We like structured logging, this is why we replaced all logging with one based on slog.

go-orb/go-orb is just interfaces

We made sure that go-orb/go-orb (the core) is just a bunch of interfaces as well as some glue code, the most real code lives in go-orb/plugins.

Linted and analyzed

Everything is linted and staticaly analyzed by golangcli-lint, enforced with CI/CD pipelines on github.

Community

Chat with us on Discord.

Authors

go-orb

go-micro

A lot of this is copy&pasted from go-micro, top contributors have been:

License

go-orb is Apache 2.0 licensed and is based on go-micro.

Pinned Loading

  1. go-orb go-orb Public

    A framework for distributed systems

    Go 185 8

Repositories

Showing 6 of 6 repositories
  • plugins Public

    Orb plugins.

    go-orb/plugins’s past year of commit activity
    Go 7 2 0 0 Updated Nov 12, 2024
  • plugins-experimental Public

    Experimental plugins for go-orb.

    go-orb/plugins-experimental’s past year of commit activity
    Go 1 0 0 0 Updated Nov 12, 2024
  • go-orb Public

    A framework for distributed systems

    go-orb/go-orb’s past year of commit activity
    Go 185 8 0 0 Updated Nov 10, 2024
  • workspace Public

    Our development workspace for go-orb, plugins and examples.

    go-orb/workspace’s past year of commit activity
    JavaScript 1 1 1 0 Updated Oct 9, 2024
  • examples Public

    Examples for go-orb.

    go-orb/examples’s past year of commit activity
    Go 2 0 0 0 Updated Oct 9, 2024
  • .github Public

    A framework for distributed systems

    go-orb/.github’s past year of commit activity
    0 0 0 0 Updated Oct 9, 2024

Top languages

Loading…

Most used topics

Loading…