core

Core (Go)

A collection of packages for building a Go microservice on the LUSH platform.

Quick start

Below there's an example for how to get running quickly with a service using the LUSHDigital core package.

package main

import (
	"context"
	"net/http"
	"time"

	"github.com/LUSHDigital/core"
	"github.com/LUSHDigital/core/workers/httpsrv"
	"github.com/LUSHDigital/core/workers/keybroker"
	"github.com/LUSHDigital/core/workers/metricsrv"
	"github.com/LUSHDigital/core/workers/readysrv"
)

func main() {
	core.SetupLogs()

	metrics := metricsrv.New()
	broker := keybroker.NewRSA(nil)
	readiness := readysrv.New(readysrv.Checks{
		"public_key": broker,
	})

	server := httpsrv.New(&http.Server{
		ReadTimeout: 10 * time.Second,
		Handler: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
			w.WriteHeader(200)
			w.Write([]byte("hello world"))
		}),
	})

	ctx := context.Background()
	svc := &core.Service{
		Name:    "example",
		Type:    "service",
		Version: "1.0.0",
	}
	svc.StartWorkers(ctx,
		server,
		metrics,
		broker,
		readiness,
	)
}

Documentation

Documentation and examples are provided in README files in each pacakge.

Core Concepts

These packages contain functionality for the core concepts of our services.

• core/auth
• core/env
• core/pagination
• core/response
• core/metrics
• core/test

Middlewares

These packages contain convenient middlewares for transport protocols like HTTP REST and gRPC.

• core/middleware/tracingmw
• core/middleware/paginationmw
• core/middleware/authmw
• core/middleware/metricsmw

Service Workers

These packages contain convenient service workers things like network servers, background workers and message brokers.

• core/workers/grpcsrv
• core/workers/httpsrv
• core/workers/readysrv
• core/workers/metricsrv
• core/workers/keybroker