billing

Documentation

Index

• func Enrich[E Event](now time.Time, hostname string, countInBatch, batchSize int, event E) E
• func GetHostname() string
• func Send[E Event](ctx context.Context, client Client, traceID TraceID, events []E) error
• type AbsoluteEvent
• type AzureAuthSharedKey
• type AzureBlobStorageClientConfig
• type AzureClient
  • func NewAzureBlobStorageClient(cfg AzureBlobStorageClientConfig) (*AzureClient, error)
  • func (c AzureClient) LogFields() zap.Field
• type AzureError
  • func (e AzureError) Error() string
  • func (e AzureError) Unwrap() error
• type Client
• type Event
• type HTTPClient
  • func NewHTTPClient(url string, c *http.Client) HTTPClient
  • func (c HTTPClient) LogFields() zap.Field
• type IncrementalEvent
• type JSONError
  • func (e JSONError) Error() string
  • func (e JSONError) Unwrap() error
• type RequestError
  • func (e RequestError) Error() string
  • func (e RequestError) Unwrap() error
• type S3Client
  • func NewS3Client(ctx context.Context, cfg S3ClientConfig) (*S3Client, error)
  • func (c S3Client) LogFields() zap.Field
• type S3ClientConfig
• type S3Error
  • func (e S3Error) Error() string
  • func (e S3Error) Unwrap() error
• type TraceID
  • func GenerateTraceID() TraceID
• type UnexpectedStatusCodeError
  • func (e UnexpectedStatusCodeError) Error() string

Functions

func Enrich

func Enrich[E Event](now time.Time, hostname string, countInBatch, batchSize int, event E) E

Enrich sets the event's Type and IdempotencyKey fields, so that users of this API don't need to manually set them

func GetHostname

func GetHostname() string

GetHostname returns the hostname to be used for enriching billing events (see Enrich())

This function MUST NOT be run before init has finished.

func Send

func Send[E Event](ctx context.Context, client Client, traceID TraceID, events []E) error

Send attempts to push the events to the remote endpoint.

On failure, the error is guaranteed to be one of: JSONError, RequestError, or UnexpectedStatusCodeError.

Types

type AbsoluteEvent

type AbsoluteEvent struct {
	IdempotencyKey string    `json:"idempotency_key"`
	MetricName     string    `json:"metric"`
	Type           string    `json:"type"`
	TenantID       string    `json:"tenant_id"`
	TimelineID     string    `json:"timeline_id"`
	Time           time.Time `json:"time"`
	Value          int       `json:"value"`
}

type AzureAuthSharedKey

type AzureAuthSharedKey struct {
	AccountName string `json:"accountName"`
	AccountKey  string `json:"accountKey"`
}

type AzureBlobStorageClientConfig

type AzureBlobStorageClientConfig struct {
	// In Azure a Container is close to a bucket in AWS S3
	Container string `json:"container"`
	// Files will be created with name starting with PrefixInContainer
	PrefixInContainer string `json:"prefixInContainer"`
	// Example Endpoint: "https://MYSTORAGEACCOUNT.blob.core.windows.net/"
	Endpoint string `json:"endpoint"`
	// contains filtered or unexported fields
}

type AzureClient

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

func NewAzureBlobStorageClient

func NewAzureBlobStorageClient(cfg AzureBlobStorageClientConfig) (*AzureClient, error)

func (AzureClient) LogFields

func (c AzureClient) LogFields() zap.Field

type AzureError

type AzureError struct {
	Err error
}

func (AzureError) Error

func (e AzureError) Error() string

func (AzureError) Unwrap

func (e AzureError) Unwrap() error

type Client

type Client interface {
	LogFields() zap.Field
	// contains filtered or unexported methods
}

type Event

type Event interface {
	*AbsoluteEvent | *IncrementalEvent
	// contains filtered or unexported methods
}

type HTTPClient

type HTTPClient struct {
	URL string
	// contains filtered or unexported fields
}

func NewHTTPClient

func NewHTTPClient(url string, c *http.Client) HTTPClient

func (HTTPClient) LogFields

func (c HTTPClient) LogFields() zap.Field

type IncrementalEvent

type IncrementalEvent struct {
	IdempotencyKey string    `json:"idempotency_key"`
	MetricName     string    `json:"metric"`
	Type           string    `json:"type"`
	EndpointID     string    `json:"endpoint_id"`
	StartTime      time.Time `json:"start_time"`
	StopTime       time.Time `json:"stop_time"`
	Value          int       `json:"value"`
}

type JSONError

type JSONError struct {
	Err error
}

func (JSONError) Error

func (e JSONError) Error() string

func (JSONError) Unwrap

func (e JSONError) Unwrap() error

type RequestError

type RequestError struct {
	Err error
}

func (RequestError) Error

func (e RequestError) Error() string

func (RequestError) Unwrap

func (e RequestError) Unwrap() error

type S3Client

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

func NewS3Client

func NewS3Client(ctx context.Context, cfg S3ClientConfig) (*S3Client, error)

func (S3Client) LogFields

func (c S3Client) LogFields() zap.Field

type S3ClientConfig

type S3ClientConfig struct {
	Bucket         string `json:"bucket"`
	Region         string `json:"region"`
	PrefixInBucket string `json:"prefixInBucket"`
	Endpoint       string `json:"endpoint"`
}

type S3Error

type S3Error struct {
	Err error
}

func (S3Error) Error

func (e S3Error) Error() string

func (S3Error) Unwrap

func (e S3Error) Unwrap() error

type TraceID

type TraceID string

func GenerateTraceID

func GenerateTraceID() TraceID

type UnexpectedStatusCodeError

type UnexpectedStatusCodeError struct {
	StatusCode int
}

func (UnexpectedStatusCodeError) Error

func (e UnexpectedStatusCodeError) Error() string