# Trifle Stats

## Content
# Trifle Stats

`trifle_stats_go` is a Go library for tracking time-series metrics with pluggable drivers.

## What it does

- Tracks counters and numeric payloads per key.
- Reads back series by timeframe and granularity.
- Supports SQLite, PostgreSQL, MySQL, Redis, and MongoDB backends.
- Supports buffered writes with size/duration/aggregation controls.
- Includes aggregators, formatters, and transponders for post-processing series.

## Quick example

```go
package main

import (
  "database/sql"
  "time"

  _ "github.com/jackc/pgx/v5/stdlib"
  TrifleStats "github.com/trifle-io/trifle_stats_go"
)

func main() {
  db, _ := sql.Open("pgx", "postgres://postgres:password@localhost:5432/postgres?sslmode=disable")
  driver := TrifleStats.NewPostgresDriver(db, "trifle_stats", TrifleStats.JoinedSeparated)
  _ = driver.Setup()

  cfg := TrifleStats.DefaultConfig()
  cfg.Driver = driver
  cfg.TimeZone = "UTC"
  cfg.Granularities = []string{"1h", "1d"}
  cfg.BufferEnabled = true
  cfg.BufferDuration = 1 * time.Second
  cfg.BufferSize = 256
  cfg.BufferAggregate = true

  _ = TrifleStats.Track(cfg, "event::uploads", time.Now().UTC(), map[string]any{"count": 1})

  from := time.Now().UTC().Add(-24 * time.Hour)
  _ = TrifleStats.Values(cfg, "event::uploads", from, time.Now().UTC(), "1h", false)
}
```

## What to expect

- `Values` returns `{ at: [...], values: [...] }` for the bucketed series.
- Payloads can be nested maps; leaf values must be numeric.
- SQL and Redis drivers store packed dot-notation keys; Mongo stores nested docs.
- Writes are buffered by default. Disable with `cfg.BufferEnabled = false` for immediate writes.

## Next steps

- [Installation](/trifle-stats-go/installation)
- [Configuration](/trifle-stats-go/configuration)
- [Getting Started](/trifle-stats-go/getting_started)
- [Usage](/trifle-stats-go/usage)
- [Drivers](/trifle-stats-go/drivers)
- [Designators](/trifle-stats-go/designators)
- [Transponders](/trifle-stats-go/transponders)
- [Aggregators](/trifle-stats-go/aggregators)
- [Formatters](/trifle-stats-go/formatters)