The highest tagged major version is v2.

platform

package module

v0.9.5 Latest Latest Go to latest Published: May 1, 2021 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/txsvc/platform

Links

Open Source Insights

README ¶

Simple (Cloud) Platform Abstractions

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

Documentation ¶

Index ¶

func InitDefaultProviders()
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 InstanceProviderFunc
type Platform
type PlatformOpts
type ProviderType
- func (l ProviderType) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func InitDefaultProviders ¶ added in v0.9.3

func InitDefaultProviders()

func Logger ¶

func Logger(logID string) logging.LoggingProvider

Logger returns a logger instance identified by ID

func Meter ¶ added in v0.9.5

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

Meter reports args

func NewHttpContext ¶

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

NewHttpContext creates a new Http context for request req

func NewTask ¶ added in v0.9.3

func NewTask(task tasks.HttpTask) error

func ReportError ¶

func ReportError(e error)

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

Types ¶

type InstanceProviderFunc ¶

type InstanceProviderFunc func(string) interface{}

type Platform ¶

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

func DefaultPlatform ¶ added in v0.9.3

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

type PlatformOpts ¶

type PlatformOpts struct {
	ID   string
	Type ProviderType
	Impl InstanceProviderFunc
}

var (
	DefaultLoggingConfig        PlatformOpts = PlatformOpts{ID: "platform.default.logger", Type: ProviderTypeLogger, Impl: local.NewDefaultLoggingProvider}
	DefaultErrorReportingConfig PlatformOpts = PlatformOpts{ID: "platform.default.errorreporting", Type: ProviderTypeErrorReporter, Impl: local.NewDefaultErrorReportingProvider}
	DefaultContextConfig        PlatformOpts = PlatformOpts{ID: "platform.default.context", Type: ProviderTypeHttpContext, Impl: local.NewDefaultContextProvider}
	DefaultTaskConfig           PlatformOpts = PlatformOpts{ID: "platform.default.task", Type: ProviderTypeTask, Impl: local.NewDefaultTaskProvider}
	DefaultMetricsConfig        PlatformOpts = PlatformOpts{ID: "platform.default.metrics", Type: ProviderTypeMetrics, Impl: local.NewDefaultMetricsProvider}
)

type ProviderType ¶

type ProviderType int

const (
	ProviderTypeLogger ProviderType = iota
	ProviderTypeErrorReporter
	ProviderTypeHttpContext
	ProviderTypeTask
	ProviderTypeMetrics
)

func (ProviderType) String ¶

func (l ProviderType) String() string

Returns the name of a provider type

Source Files ¶

View all Source files

platform.go

Directories ¶

Path	Synopsis
pkg
api
env
errorreporting
http
id
logging
metrics
netrc
tasks
timestamp
validate
provider
google
local

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL