filesystem

Documentation

Overview

Package filesystem implements a receiver that persists received profiles to a directory tree. The layout groups stack traces by container and separates them by sample type, e.g.:

<dir>/<container.id>/<sample-type>/<n>.json

Each JSON file represents a single stack trace (one sample) together with its timestamps and attributes.

Index

• type Config
  • func DefaultConfig() Config
• type Filesystem
  • func NewReceiver(config Config) *Filesystem
  • func (f *Filesystem) Receive(ctx context.Context, pd pprofile.Profiles) error
  • func (f *Filesystem) Start(_ context.Context) error
  • func (f *Filesystem) Stop(_ context.Context) error

Types

type Config

type Config struct {
	// Dir is the root output directory. Container/sample-type sub-directories
	// are created underneath it on demand.
	Dir string
	// IgnoreProfilesWithoutContainerID skips resource profiles that do not
	// carry a container.id resource attribute.
	IgnoreProfilesWithoutContainerID bool
	// ContainerID, when set, restricts processing to resource profiles whose
	// container.id matches it; all other profiles are ignored.
	ContainerID string
}

func DefaultConfig

func DefaultConfig() Config

type Filesystem

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

func NewReceiver

func NewReceiver(config Config) *Filesystem

func (*Filesystem) Receive

func (f *Filesystem) Receive(ctx context.Context, pd pprofile.Profiles) error

func (*Filesystem) Start

func (f *Filesystem) Start(_ context.Context) error

func (*Filesystem) Stop

func (f *Filesystem) Stop(_ context.Context) error