core

Documentation

Index

• Variables
• func BuildDownstreamGRPCClient(_ string, cfg *config.CommonGRPCDownstreamData) (*grpc.ClientConn, error)
• func BuildDownstreamHTTPClient(serviceName string, cfg *config.CommonDownstreamData) (*http.Client, error)
• func ConfigFileSystemOnto(ctx context.Context, fs afero.Fs) context.Context
• func GetAppConfigType(createService interface{}) reflect.Type
• func InitialiseLogging(ctx context.Context, configs []log.Config, logrusLogger *logrus.Logger) context.Context
• func LoadCustomConfig(ctx context.Context, customConfig interface{}) (interface{}, error)
• func MustTypeCheckCreateService(createService, serviceInterface interface{})
• func NewZeroCustomConfig(downstreamConfigType, appConfigType reflect.Type) interface{}
• func Recoverer(ctx context.Context) func(http.Handler) http.Handler
• func SelectBasePath(fromSpec, dynamic string) string
• func Serve(ctx context.Context, ...) error
• func Server(ctx context.Context, name string, hl Manager, grpcHl GrpcManager, ...) error
• type GrpcGenCallback
• type GrpcManager
• type HTTPManager
  • func NewHTTPManager(libraryConfig *config.LibraryConfig, ...) *HTTPManager
  • func (h *HTTPManager) AdminServerConfig() *config.CommonHTTPServerConfig
  • func (h *HTTPManager) EnabledHandlers() []handlerinitialiser.HandlerInitialiser
  • func (h *HTTPManager) LibraryConfig() *config.LibraryConfig
  • func (h *HTTPManager) PublicServerConfig() *config.CommonHTTPServerConfig
• type Manager
• type RestCallback
• type RestGenCallback
• type ServerOption
  • func WithGrpcManager(manager GrpcManager) ServerOption
  • func WithLogrusLogger(logger *logrus.Logger) ServerOption
  • func WithPkgLogger(configs ...log.Config) ServerOption
  • func WithPrometheusRegistry(prometheusRegistry *prometheus.Registry) ServerOption
  • func WithRestManager(manager Manager) ServerOption
• type ServerParams
  • func NewServerParams(ctx context.Context, name string, opts ...ServerOption) *ServerParams
  • func (params *ServerParams) Start() error
• type TLSLogFilter
  • func (t *TLSLogFilter) Write(p []byte) (n int, err error)

Variables

var (

	// Name is set at the build time
	Name = ""

	// Version is set at the build time
	Version = ""

	// BuildID is set at the build time
	BuildID = ""

	// CommitSha is set at the build time
	CommitSha = ""

	// BranchName is set at the build time
	BranchName = ""

	// TagName is set at the build time
	TagName = ""
)

Functions

func BuildDownstreamGRPCClient

func BuildDownstreamGRPCClient(_ string, cfg *config.CommonGRPCDownstreamData) (*grpc.ClientConn, error)

func BuildDownstreamHTTPClient

func BuildDownstreamHTTPClient(serviceName string, cfg *config.CommonDownstreamData) (*http.Client, error)

func ConfigFileSystemOnto

func ConfigFileSystemOnto(ctx context.Context, fs afero.Fs) context.Context

ConfigFileSystemOnto adds a config filesystem to ctx.

func GetAppConfigType

func GetAppConfigType(createService interface{}) reflect.Type

GetAppConfigType extracts the app's config type from createService. Precondition: MustTypeCheckCreateService(createService, serviceInterface) succeeded.

func InitialiseLogging

func InitialiseLogging(ctx context.Context, configs []log.Config, logrusLogger *logrus.Logger) context.Context

initialise the logger sysl-go always uses a pkg logger internally. if custom code passes in a logrus logger, a mechanism which is deprecated, then a hook is added to the internal pkg logger that forwards logged events to the provided logrus logger. sysl-go can be requested to log in a verbose manner. logger in a verbose manner logs additional details within log events where appropriate. the mechanism to set this verbose manner is to either have a sufficiently high logrus log level or the verbose mode set against the pkg logger.

func LoadCustomConfig

func LoadCustomConfig(ctx context.Context, customConfig interface{}) (interface{}, error)

LoadCustomConfig populates the given zero customConfig value with configuration data.

func MustTypeCheckCreateService

func MustTypeCheckCreateService(createService, serviceInterface interface{})

MustTypeCheckCreateService checks that the given createService has an acceptable type, and panics otherwise.

func NewZeroCustomConfig

func NewZeroCustomConfig(downstreamConfigType, appConfigType reflect.Type) interface{}

NewZeroCustomConfig uses reflection to create a new type derived from DefaultConfig, but with new GenCode.Downstream and App fields holding the same types as downstreamConfig and appConfig. It returns a pointer to a zero value of that new type.

func Recoverer

func Recoverer(ctx context.Context) func(http.Handler) http.Handler

func SelectBasePath

func SelectBasePath(fromSpec, dynamic string) string

SelectBasePath chooses between a specified base path and a dynmaically chosen one.

func Serve

func Serve(
	ctx context.Context,
	downstreamConfig, createService, serviceInterface interface{},
	newManager func(cfg *config.DefaultConfig, serviceIntf interface{}, callback *RestCallback) (interface{}, error),
) error

Serve serves an auto-generated service.

func Server

func Server(ctx context.Context, name string, hl Manager, grpcHl GrpcManager, logger *logrus.Logger, promRegistry *prometheus.Registry) error

Deprecated: Use ServerParams instead

Types

type GrpcGenCallback

type GrpcGenCallback interface {
	DownstreamTimeoutContext(ctx context.Context) (context.Context, context.CancelFunc)
}

GrpcGenCallback is currently a subset of RestGenCallback so is defined separately for convenience.

type GrpcManager

type GrpcManager interface {
	Interceptors() []grpc.UnaryServerInterceptor
	EnabledGrpcHandlers() []handlerinitialiser.GrpcHandlerInitialiser
	GrpcAdminServerConfig() *config.CommonServerConfig
	GrpcPublicServerConfig() *config.CommonServerConfig
}

type HTTPManager

type HTTPManager struct {
	// contains filtered or unexported fields
}

func NewHTTPManager

func NewHTTPManager(libraryConfig *config.LibraryConfig, adminServerConfig *config.CommonHTTPServerConfig, publicServerConfig *config.CommonHTTPServerConfig, enabledHandlers []handlerinitialiser.HandlerInitialiser) *HTTPManager

func (*HTTPManager) AdminServerConfig

func (h *HTTPManager) AdminServerConfig() *config.CommonHTTPServerConfig

func (*HTTPManager) EnabledHandlers

func (h *HTTPManager) EnabledHandlers() []handlerinitialiser.HandlerInitialiser

func (*HTTPManager) LibraryConfig

func (h *HTTPManager) LibraryConfig() *config.LibraryConfig

func (*HTTPManager) PublicServerConfig

func (h *HTTPManager) PublicServerConfig() *config.CommonHTTPServerConfig

type Manager

type Manager interface {
	EnabledHandlers() []handlerinitialiser.HandlerInitialiser
	LibraryConfig() *config.LibraryConfig
	AdminServerConfig() *config.CommonHTTPServerConfig
	PublicServerConfig() *config.CommonHTTPServerConfig
}

type RestCallback

type RestCallback struct {
	MapError func(ctx context.Context, err error) *common.HTTPError
}

type RestGenCallback

type RestGenCallback interface {
	// AddMiddleware allows hand-crafted code to add middleware to the router
	AddMiddleware(ctx context.Context, r chi.Router)
	// BasePath allows hand-crafted code to set the base path for the Router
	BasePath() string
	// Config returns a structure representing the server config
	// This is returned from the status endpoint
	Config() interface{}
	// MapError maps an error to an HTTPError in instances where custom error mapping is required. Return nil to perform default error mapping; defined as:
	// 1. CustomError.HTTPError if the original error is a CustomError, otherwise
	// 2. common.MapError
	MapError(ctx context.Context, err error) *common.HTTPError
	// DownstreamTimeoutContext add the desired timeout duration to the context for downstreams
	// A separate service timeout (usually greater than the downstream) should also be in
	// place to automatically respond to callers
	DownstreamTimeoutContext(ctx context.Context) (context.Context, context.CancelFunc)
}

RestGenCallback is used by `sysl-go` to call hand-crafted code.

type ServerOption

type ServerOption interface {
	// contains filtered or unexported methods
}

func WithGrpcManager

func WithGrpcManager(manager GrpcManager) ServerOption

func WithLogrusLogger

func WithLogrusLogger(logger *logrus.Logger) ServerOption

Deprecated: Use WithPkgLogger instead.

func WithPkgLogger

func WithPkgLogger(configs ...log.Config) ServerOption

func WithPrometheusRegistry

func WithPrometheusRegistry(prometheusRegistry *prometheus.Registry) ServerOption

func WithRestManager

func WithRestManager(manager Manager) ServerOption

type ServerParams

type ServerParams struct {
	Ctx  context.Context
	Name string
	// contains filtered or unexported fields
}

func NewServerParams

func NewServerParams(ctx context.Context, name string, opts ...ServerOption) *ServerParams

func (*ServerParams) Start

func (params *ServerParams) Start() error

type TLSLogFilter

type TLSLogFilter struct {
	// contains filtered or unexported fields
}

func (*TLSLogFilter) Write

func (t *TLSLogFilter) Write(p []byte) (n int, err error)