Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

flightrecorder

package module

Go to main page

Versions in this module

v0

v0.2.0

Aug 11, 2026

Changes in this version

+ const SnapshotSourceAsync

+ const SnapshotSourceManual

+ const SnapshotSourceTrigger

+ type LoggerHook func(format string, args ...any)

+ type MetricsHook func(event SnapshotEvent, err error)

type Option

+ func WithCompression(level int) Option

+ func WithLogger(hook LoggerHook) Option

+ func WithMaxSnapshots(n int) Option

+ func WithMetrics(hook MetricsHook) Option

+ func WithSnapshotDir(dir string) Option

+ func WithSnapshotPrefix(prefix string) Option

type Recorder

+ func (r *Recorder) SnapshotIfAsync(ctx context.Context, tc TriggerContext, trigger TriggerFunc) bool

+ func (r *Recorder) SnapshotToDir(ctx context.Context) (string, error)

+ func (r *Recorder) SnapshotToWriter(ctx context.Context, dest io.Writer) (int64, error)

+ type SnapshotEvent struct

+ Bytes int64

+ Compressed bool

+ Duration time.Duration

+ Kind string

+ Path string

+ Source string

+ Type string

v0.1.1

Aug 10, 2026

Changes in this version

+ type AlreadyEnabledError struct

+ Cause error

+ func (e *AlreadyEnabledError) Error() string

+ func (e *AlreadyEnabledError) Is(target error) bool

+ func (e *AlreadyEnabledError) Unwrap() error

+ type ConfigError struct

+ Constraint string

+ Field string

+ Value any

+ func (e *ConfigError) Error() string

+ type SnapshotError struct

+ Err error

+ Op string

+ Path string

+ func (e *SnapshotError) Error() string

+ func (e *SnapshotError) Unwrap() error

v0.1.0

Aug 10, 2026

Changes in this version

+ var ErrAlreadyEnabled = errors.New("flightrecorder: another flight recorder is already active in this process")

+ type Option func(*recorderConfig)

+ func WithFile(path string) Option

+ func WithMaxBytes(n uint64) Option

+ func WithMinAge(d time.Duration) Option

+ func WithWriter(w io.Writer) Option

+ type Recorder struct

+ func New(opts ...Option) (*Recorder, error)

+ func (r *Recorder) Close() error

+ func (r *Recorder) Enabled() bool

+ func (r *Recorder) Reset()

+ func (r *Recorder) Snapshot(ctx context.Context) error

+ func (r *Recorder) SnapshotIf(ctx context.Context, tc TriggerContext, trigger TriggerFunc) bool

+ func (r *Recorder) SnapshotToFile(ctx context.Context, path string) error

+ func (r *Recorder) Start() error

+ func (r *Recorder) Stop()

+ type TriggerContext struct

+ Duration time.Duration

+ Err error

+ Kind string

+ Type string

+ type TriggerFunc func(TriggerContext) bool

+ func OnAll(triggers ...TriggerFunc) TriggerFunc

+ func OnAlways() TriggerFunc

+ func OnAny(triggers ...TriggerFunc) TriggerFunc

+ func OnError() TriggerFunc

+ func OnErrorOrLatency(threshold time.Duration) TriggerFunc

+ func OnLatency(threshold time.Duration) TriggerFunc