client

Documentation

Index

• Constants
• func IsReportingError(err error) bool
• func NewUsageClient(usageServerUrl string, usagePayloadReader UsagePayloadReader, ...) *client
• type Client
• type CloseableConnection
• type ReportingError
  • func ErrorConnecting(err error) *ReportingError
  • func ErrorGettingSignature(err error) *ReportingError
  • func ErrorReadingPayload(err error) *ReportingError
  • func ErrorSendingUsage(err error) *ReportingError
  • func (r *ReportingError) Error() string
• type ReportingServiceClientBuilder
• type UsagePayloadReader

Constants

const (
	// set this env var to the string "true" to prevent usage from being reported
	DisableUsageVar = "DISABLE_USAGE_REPORTING"
	TestingUrl      = "localhost:3000"
)

Functions

func IsReportingError

func IsReportingError(err error) bool

func NewUsageClient

func NewUsageClient(usageServerUrl string, usagePayloadReader UsagePayloadReader, product *api.Product, signatureManager signature.SignatureManager) *client

Types

type Client

type Client interface {
	StartReportingUsage(ctx context.Context, interval time.Duration) <-chan error
}

type CloseableConnection

type CloseableConnection interface {
	Close() error
}

type ReportingError

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

func ErrorConnecting

func ErrorConnecting(err error) *ReportingError

func ErrorGettingSignature

func ErrorGettingSignature(err error) *ReportingError

func ErrorReadingPayload

func ErrorReadingPayload(err error) *ReportingError

func ErrorSendingUsage

func ErrorSendingUsage(err error) *ReportingError

func (*ReportingError) Error

func (r *ReportingError) Error() string

type ReportingServiceClientBuilder

type ReportingServiceClientBuilder func() (api.ReportingServiceClient, CloseableConnection, error)

type UsagePayloadReader

type UsagePayloadReader interface {
	GetPayload(ctx context.Context) (map[string]string, error)
}

a type that knows how to load the usage payload you want to report