platform

README

Simple (Cloud) Platform Abstractions

Cloud Platform abstractions and other shared code to build cloud-native services.

Documentation

Index

• func Close() error
• func Logger(logID string) logging.LoggingProvider
• func Meter(ctx context.Context, metric string, args ...string)
• func NewHttpContext(req *h.Request) context.Context
• func NewTask(task tasks.HttpTask) error
• func ReportError(e error)
• type GenericProvider
• type InstanceProviderFunc
• type Platform
  • func DefaultPlatform() *Platform
  • func InitPlatform(ctx context.Context, opts ...PlatformOpts) (*Platform, error)
  • func RegisterPlatform(p *Platform) *Platform
  • func (p *Platform) Close() error
  • func (p *Platform) RegisterProviders(ignoreExists bool, opts ...PlatformOpts) error
• type PlatformOpts
  • func WithProvider(ID string, providerType ProviderType, impl InstanceProviderFunc) PlatformOpts
• type ProviderType
  • func (l ProviderType) String() string

Functions

func Close

func Close() error

Close asks all registered providers of the current default platform instance to gracefully shutdown.

func Logger

func Logger(logID string) logging.LoggingProvider

Logger returns a logger instance identified by ID

func Meter

func Meter(ctx context.Context, metric string, args ...string)

Meter logs args to a metrics log from where the values can be aggregated and analyzed.

func NewHttpContext

func NewHttpContext(req *h.Request) context.Context

NewHttpContext creates a new Http context for request req

func NewTask

func NewTask(task tasks.HttpTask) error

NewTask schedules a new http background task

func ReportError

func ReportError(e error)

ReportError reports error e using the current platform's error reporting provider

Types

type GenericProvider

type GenericProvider interface {
	Close() error
}

type InstanceProviderFunc

type InstanceProviderFunc func(string) interface{}

type Platform

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

func DefaultPlatform

func DefaultPlatform() *Platform

DefaultPlatform returns the current default platform provider.

func InitPlatform

func InitPlatform(ctx context.Context, opts ...PlatformOpts) (*Platform, error)

InitPlatform creates a new platform instance and configures it with providers

func RegisterPlatform

func RegisterPlatform(p *Platform) *Platform

RegisterPlatform makes p the new default platform provider

func (*Platform) Close

func (p *Platform) Close() error

Close iterates over all registered providers and shuts them down.

func (*Platform) RegisterProviders

func (p *Platform) RegisterProviders(ignoreExists bool, opts ...PlatformOpts) error

RegisterProviders registers one or more providers. An existing provider will be overwritten if ignoreExists is true, otherwise the function returns an error.

type PlatformOpts

type PlatformOpts struct {
	ID   string
	Type ProviderType
	Impl InstanceProviderFunc
}

func WithProvider

func WithProvider(ID string, providerType ProviderType, impl InstanceProviderFunc) PlatformOpts

WithProvider returns a populated PlatformOption struct.

type ProviderType

type ProviderType int

const (
	ProviderTypeLogger ProviderType = iota
	ProviderTypeErrorReporter
	ProviderTypeHttpContext
	ProviderTypeTask
	ProviderTypeMetrics
	ProviderTypeAuth
)

func (ProviderType) String

func (l ProviderType) String() string

Returns the name of a provider type