billing

Documentation

Index

• func Enrich[E Event](now time.Time, hostname string, countInBatch, batchSize int, event E) E
• func Send[E Event](ctx context.Context, client Client, traceID TraceID, events []E) error
• type AbsoluteEvent
• type Client
  • func NewClient(url string, c *http.Client) Client
  • func (c Client) GenerateTraceID() TraceID
  • func (c Client) Hostname() string
• type Event
• 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 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 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 Client

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

func NewClient

func NewClient(url string, c *http.Client) Client

func (Client) GenerateTraceID

func (c Client) GenerateTraceID() TraceID

func (Client) Hostname

func (c Client) Hostname() string

type Event

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

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 TraceID

type TraceID string

type UnexpectedStatusCodeError

type UnexpectedStatusCodeError struct {
	StatusCode int
}

func (UnexpectedStatusCodeError) Error

func (e UnexpectedStatusCodeError) Error() string