platform

README

Simple (Cloud) Platform Abstractions

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

Documentation

Index

• Constants
• func Close() error
• func Logger(logID string) provider.LoggingProvider
• func Meter(ctx context.Context, metric string, args ...string)
• func NewHttpContext(req *h.Request) context.Context
• func Provider(providerType provider.ProviderType) (interface{}, bool)
• func ReportError(e error)
• type Platform
  • func DefaultPlatform() *Platform
  • func InitPlatform(ctx context.Context, opts ...provider.ProviderConfig) (*Platform, error)
  • func RegisterPlatform(p *Platform) *Platform
  • func (p *Platform) Close() error
  • func (p *Platform) RegisterProviders(ignoreExists bool, opts ...provider.ProviderConfig) error

Constants

const (
	MsgMissingProvider = "provider '%s' required"
)

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) provider.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 Provider

func Provider(providerType provider.ProviderType) (interface{}, bool)

Provider returns the registered provider instance if it is defined. The bool flag is set to true if there is a provider and false otherwise.

func ReportError

func ReportError(e error)

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

Types

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 ...provider.ProviderConfig) (*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 ...provider.ProviderConfig) error

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