meters

type Dimension ¶

type Dimension struct {
	Key   string
	Value string
}

Dimension represents a key-value pair used for metering dimensions.

type Dimensions ¶

type Dimensions []Dimension

type MeterEvent ¶

type MeterEvent struct {
	EventID      string
	Name         string
	Value        float64
	Timestamp    time.Time
	Dimensions   Dimensions
	RequestID    string        // Request ID associated with the event, useful for tracing
	StatusCode   int           // HTTP status code of the request that generated this event
	Success      bool          // Indicates if the event was successful (e.g., HTTP status < 400)
	Duration     time.Duration // Duration of the request
	ResponseSize int64         // Size of the response body in bytes
}

MeterEvent represents a metered event with a name, value, timestamp, dimensions, and request ID.

func NewMeterEvent(name string, value float64, dims Dimensions) MeterEvent

type MeterProvider ¶

type MeterProvider interface {
	// NewMeter creates a new Meterer for the given MeterUser.
	NewMeter(MeterUser) Meterer
	// Close and Flush are used to clean up resources and ensure all data is written out.
	Close() error
	// Flush is used to ensure all buffered data is written out.
	Flush() error
}

MeterProvider is an interface for creating new Meterers. It also provides methods for closing the provider and flushing any buffered data. The NewMeter method takes a MeterUser, which provides user-specific context for metering. The Close method is used to clean up resources, and Flush is used to ensure all data is written out.

type MeterReader ¶

type MeterReader interface {
	GetValue(context.Context, string, time.Time, time.Time, Dimensions) (float64, bool)
	Check(context.Context, string, float64, Dimensions) (bool, error)
}

MeterReader is an interface for reading metered values and checking rate limits.

type MeterRecorder ¶

type MeterRecorder interface {
	Meter(context.Context, MeterEvent) error
	ApplyDimension(key, value string)
}

MeterRecorder is an interface for recording metered events. ApplyDimension mutates the MeterRecorder and adds a dimension that will be applied to all future Meter calls.

func ForContext(ctx context.Context) MeterRecorder

type MeterUser ¶

type MeterUser interface {
	ID() string
	GetExternalData(string) (string, bool)
}

MeterUser is an interface representing a user for metering purposes. It provides an ID method to get the user's identifier and a GetExternalData method to retrieve external data associated with the user, which can be used for metering purposes.

type Meterer ¶

type Meterer interface {
	MeterReader
	MeterRecorder
}

Meterer combines both MeterReader and MeterRecorder interfaces.