usage

package
v0.33.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 2, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithCallMeta 

func WithCallMeta(ctx context.Context, meta CallMeta) context.Context

Types

type Analytics added in v0.31.87 

type Analytics struct {
	Days   int                 `json:"days"`
	Totals AnalyticsTotals     `json:"totals"`
	Daily  []AnalyticsDailyRow `json:"daily"`
	Models []AnalyticsModelRow `json:"models"`
	Skills []AnalyticsSkillRow `json:"skills"`
}

type AnalyticsDailyRow added in v0.31.87 

type AnalyticsDailyRow struct {
	Day          string  `json:"day"`
	Calls        int     `json:"calls"`
	Sessions     int     `json:"sessions"`
	InputTokens  int     `json:"input_tokens"`
	OutputTokens int     `json:"output_tokens"`
	TotalTokens  int     `json:"total_tokens"`
	CostUSD      float64 `json:"cost_usd"`
}

type AnalyticsModelRow added in v0.31.87 

type AnalyticsModelRow struct {
	Provider     string  `json:"provider"`
	Model        string  `json:"model"`
	Calls        int     `json:"calls"`
	Sessions     int     `json:"sessions"`
	InputTokens  int     `json:"input_tokens"`
	OutputTokens int     `json:"output_tokens"`
	TotalTokens  int     `json:"total_tokens"`
	CostUSD      float64 `json:"cost_usd"`
}

type AnalyticsSkillRow added in v0.31.87 

type AnalyticsSkillRow struct {
	Name    string `json:"name"`
	Source  string `json:"source,omitempty"`
	Calls   int    `json:"calls"`
	FirstAt string `json:"first_at,omitempty"`
	LastAt  string `json:"last_at,omitempty"`
}

type AnalyticsTotals added in v0.31.87 

type AnalyticsTotals struct {
	Calls               int     `json:"calls"`
	Sessions            int     `json:"sessions"`
	InputTokens         int     `json:"input_tokens"`
	OutputTokens        int     `json:"output_tokens"`
	TotalTokens         int     `json:"total_tokens"`
	CostUSD             float64 `json:"cost_usd"`
	AvgTokensPerSession float64 `json:"avg_tokens_per_session"`
}

type CallMeta 

type CallMeta struct {
	Source    string
	SessionID string
	RunID     string
}

func CallMetaFromContext 

func CallMetaFromContext(ctx context.Context) CallMeta

type DailyTokenSummary added in v0.31.79 

type DailyTokenSummary struct {
	Date          string  `json:"date"`
	ResetAt       string  `json:"reset_at"`
	InputTokens   int     `json:"input_tokens"`
	OutputTokens  int     `json:"output_tokens"`
	TotalTokens   int     `json:"total_tokens"`
	BudgetTokens  int     `json:"budget_tokens"`
	BudgetEnabled bool    `json:"budget_enabled"`
	UsagePercent  float64 `json:"usage_percent"`
	Level         string  `json:"level"`
}

type Entry 

type Entry struct {
	Timestamp        time.Time `json:"timestamp"`
	Provider         string    `json:"provider"`
	Model            string    `json:"model"`
	InputTokens      int       `json:"input_tokens"`
	OutputTokens     int       `json:"output_tokens"`
	CachedTokens     int       `json:"cached_tokens,omitempty"`
	CacheReadTokens  int       `json:"cache_read_tokens,omitempty"`
	CacheWriteTokens int       `json:"cache_write_tokens,omitempty"`
	EstimatedCostUSD float64   `json:"estimated_cost_usd"`
	Source           string    `json:"source"`
	SessionID        string    `json:"session_id,omitempty"`
	RunID            string    `json:"run_id,omitempty"`
	PricingKnown     bool      `json:"pricing_known"`
}

type LimitStatus 

type LimitStatus struct {
	Exceeded bool
	Mode     string
	Period   string
	SpentUSD float64
	LimitUSD float64
}

type Limits 

type Limits struct {
	DailyUSD    float64 `json:"daily_usd"`
	WeeklyUSD   float64 `json:"weekly_usd"`
	MonthlyUSD  float64 `json:"monthly_usd"`
	DailyTokens int     `json:"daily_tokens"`
	Mode        string  `json:"mode"`
}

type ModelPrice 

type ModelPrice struct {
	InputPer1MUSD      float64 `json:"input_per_1m_usd"`
	OutputPer1MUSD     float64 `json:"output_per_1m_usd"`
	CacheReadPer1MUSD  float64 `json:"cache_read_per_1m_usd,omitempty"`
	CacheWritePer1MUSD float64 `json:"cache_write_per_1m_usd,omitempty"`
}

type SignalEntry added in v0.31.6 

type SignalEntry struct {
	Timestamp  time.Time         `json:"timestamp"`
	Name       string            `json:"name"`
	Count      int               `json:"count"`
	Source     string            `json:"source,omitempty"`
	SessionID  string            `json:"session_id,omitempty"`
	RunID      string            `json:"run_id,omitempty"`
	Dimensions map[string]string `json:"dimensions,omitempty"`
}

type SignalSummary added in v0.31.6 

type SignalSummary struct {
	Period     string             `json:"period"`
	TotalCount int                `json:"total_count"`
	Rows       []SignalSummaryRow `json:"rows"`
}

type SignalSummaryRow added in v0.31.6 

type SignalSummaryRow struct {
	Name       string            `json:"name"`
	Source     string            `json:"source,omitempty"`
	Count      int               `json:"count"`
	Dimensions map[string]string `json:"dimensions,omitempty"`
	FirstAt    string            `json:"first_at,omitempty"`
	LastAt     string            `json:"last_at,omitempty"`
}

type Summary 

type Summary struct {
	Period          string       `json:"period"`
	GroupBy         string       `json:"group_by"`
	TotalCalls      int          `json:"total_calls"`
	TotalCostUSD    float64      `json:"total_cost_usd"`
	TotalInput      int          `json:"total_input_tokens"`
	TotalOutput     int          `json:"total_output_tokens"`
	TotalCached     int          `json:"total_cached_tokens"`
	TotalCacheRead  int          `json:"total_cache_read_tokens"`
	TotalCacheWrite int          `json:"total_cache_write_tokens"`
	Rows            []SummaryRow `json:"rows"`
}

type SummaryRow 

type SummaryRow struct {
	Key              string  `json:"key"`
	Calls            int     `json:"calls"`
	CostUSD          float64 `json:"cost_usd"`
	InputTokens      int     `json:"input_tokens"`
	OutputTokens     int     `json:"output_tokens"`
	CachedTokens     int     `json:"cached_tokens"`
	CacheReadTokens  int     `json:"cache_read_tokens"`
	CacheWriteTokens int     `json:"cache_write_tokens"`
}

type TrackedClient 

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

func NewTrackedClient 

func NewTrackedClient(inner llm.Client, tracker *Tracker, provider string, model string, tier llm.Tier) *TrackedClient

func (*TrackedClient) Ask 

func (c *TrackedClient) Ask(ctx context.Context, prompt string) (string, error)

func (*TrackedClient) Chat 

func (c *TrackedClient) Chat(ctx context.Context, messages []llm.ChatMessage, opts llm.ChatOptions) (llm.ChatResponse, error)

func (*TrackedClient) Inner added in v0.32.28 

func (c *TrackedClient) Inner() llm.Client

Inner returns the wrapped llm.Client. Lets server-side wiring unwrap the concrete provider client (e.g. OpenAICodexClient) when it needs to attach provider-specific callbacks like rate-limit observers.

func (*TrackedClient) LastCodexRateLimit added in v0.32.27 

func (c *TrackedClient) LastCodexRateLimit() (llm.CodexRateLimitSnapshot, bool)

LastCodexRateLimit forwards to the inner client when it implements llm.CodexRateLimitSource. Lets admin handlers fish a Codex rate-limit snapshot out of the router without unwrapping the TrackedClient manually.

func (*TrackedClient) SetNotifier 

func (c *TrackedClient) SetNotifier(notifier WarningNotifier)

type Tracker 

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

func NewTracker 

func NewTracker(workspaceDir string, opts TrackerOptions) (*Tracker, error)

func (*Tracker) Analytics added in v0.31.87 

func (t *Tracker) Analytics(days int) (Analytics, error)

func (*Tracker) CheckLimitStatus 

func (t *Tracker) CheckLimitStatus() (LimitStatus, error)

func (*Tracker) EstimateCost 

func (t *Tracker) EstimateCost(provider, model string, u llm.Usage) (float64, bool)

func (*Tracker) Limits 

func (t *Tracker) Limits() Limits

func (*Tracker) Record 

func (t *Tracker) Record(entry Entry) error

func (*Tracker) RecordSignal added in v0.31.6 

func (t *Tracker) RecordSignal(entry SignalEntry) error

func (*Tracker) Signals added in v0.31.6 

func (t *Tracker) Signals(period string) (SignalSummary, error)

func (*Tracker) Summary 

func (t *Tracker) Summary(period, groupBy string) (Summary, error)

func (*Tracker) TodayTokens added in v0.31.79 

func (t *Tracker) TodayTokens() (DailyTokenSummary, error)

func (*Tracker) UpdateLimits 

func (t *Tracker) UpdateLimits(next Limits) (Limits, error)

type TrackerOptions 

type TrackerOptions struct {
	Now            func() time.Time
	InitialLimits  Limits
	PriceOverrides map[string]ModelPrice
}

type WarningNotifier 

type WarningNotifier func(ctx context.Context, message string)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.