reports

Documentation

Index

• func GenerateAttributionCSV(ctx context.Context, database string, start time.Time, end time.Time, ...) error
• func ParseRange(startArg, endArg string) (time.Time, time.Time, error)
• type AttributionTotals
  • func ProcessAttributions(rows []*attribution.BucketUsage, userAgents []string, log *zap.Logger) AttributionTotals
• type AttributionTotalsIndex
• type Total

Functions

func GenerateAttributionCSV

func GenerateAttributionCSV(ctx context.Context, database string, start time.Time, end time.Time, userAgents []string, output io.Writer) error

GenerateAttributionCSV creates a report with.

func ParseRange

func ParseRange(startArg, endArg string) (time.Time, time.Time, error)

ParseRange parses report date range arguments. If the dates are malformed or if the start date does not come before the end date, an error is returned. The end date is exclusive.

Types

type AttributionTotals

type AttributionTotals map[AttributionTotalsIndex]Total

AttributionTotals is a map of attribution totals per user agent, project ID, and bucket name combination.

func ProcessAttributions

func ProcessAttributions(rows []*attribution.BucketUsage, userAgents []string, log *zap.Logger) AttributionTotals

ProcessAttributions sums all bucket attribution by the first entry in the user agent, project ID, and bucket name.

type AttributionTotalsIndex

type AttributionTotalsIndex struct {
	UserAgent  string
	ProjectID  string
	BucketName string
}

AttributionTotalsIndex is a key into AttributionTotals.

type Total

type Total struct {
	ByteHours    float64
	SegmentHours float64
	ObjectHours  float64
	BucketHours  float64
	BytesEgress  int64
}

Total is the total attributable usage for a user agent over a period of time.