debuginfo

Documentation

Index

• type Client
  • func NewNoopClient() Client
• type DebugInfo
  • func New(logger log.Logger, client Client) *DebugInfo
  • func (di *DebugInfo) EnsureUploaded(ctx context.Context, objFiles []*objectfile.MappedObjectFile)
• type Extractor
  • func NewExtractor(logger log.Logger) *Extractor
  • func (e *Extractor) Extract(ctx context.Context, dst io.WriteSeeker, src string) error
  • func (e *Extractor) ExtractAll(ctx context.Context, srcDsts map[string]io.WriteSeeker) error
• type Finder
  • func NewFinder(logger log.Logger) *Finder
  • func (f *Finder) Find(ctx context.Context, objFile *objectfile.MappedObjectFile) (string, error)
• type NoopClient
  • func (c *NoopClient) Exists(ctx context.Context, buildID, hash string) (bool, error)
  • func (c *NoopClient) Upload(ctx context.Context, buildID, hash string, f io.Reader) (uint64, error)
• type SourceInfo
• type Uploader
  • func NewUploader(logger log.Logger, client Client) *Uploader
  • func (u *Uploader) Upload(ctx context.Context, src SourceInfo, r io.Reader) error
  • func (u *Uploader) UploadAll(ctx context.Context, srcDbgInfo map[SourceInfo]io.Reader) error

Types

type Client

type Client interface {
	Exists(ctx context.Context, buildID, hash string) (bool, error)
	Upload(ctx context.Context, buildID, hash string, f io.Reader) (uint64, error)
}

func NewNoopClient

func NewNoopClient() Client

type DebugInfo

type DebugInfo struct {
	*Extractor
	*Uploader
	*Finder
	// contains filtered or unexported fields
}

func New

func New(logger log.Logger, client Client) *DebugInfo

New creates a new DebugInfo.

func (*DebugInfo) EnsureUploaded

func (di *DebugInfo) EnsureUploaded(ctx context.Context, objFiles []*objectfile.MappedObjectFile)

EnsureUploaded ensures that the extracted or the found debuginfo for the given buildID is uploaded.

type Extractor

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

Extractor extracts debug information from a binary.

func NewExtractor

func NewExtractor(logger log.Logger) *Extractor

NewExtractor creates a new Extractor.

func (*Extractor) Extract

func (e *Extractor) Extract(ctx context.Context, dst io.WriteSeeker, src string) error

Extract extracts debug information from the given executable. Cleaning up the temporary directory and the interim file is the caller's responsibility.

func (*Extractor) ExtractAll

func (e *Extractor) ExtractAll(ctx context.Context, srcDsts map[string]io.WriteSeeker) error

ExtractAll extracts debug information from the given executables. It consumes a map of file sources to extract and a destination io.Writer.

type Finder

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

Finder finds the separate debug information files on the system.

func NewFinder

func NewFinder(logger log.Logger) *Finder

NewFinder creates a new Finder.

func (*Finder) Find

func (f *Finder) Find(ctx context.Context, objFile *objectfile.MappedObjectFile) (string, error)

Find finds the separate debug file for the given object file.

type NoopClient

type NoopClient struct{}

func (*NoopClient) Exists

func (c *NoopClient) Exists(ctx context.Context, buildID, hash string) (bool, error)

func (*NoopClient) Upload

func (c *NoopClient) Upload(ctx context.Context, buildID, hash string, f io.Reader) (uint64, error)

type SourceInfo

type SourceInfo struct {
	BuildID string
	Path    string
}

SourceInfo source information of the given debug information.

type Uploader

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

Uploader uploads debug information to the Parca server.

func NewUploader

func NewUploader(logger log.Logger, client Client) *Uploader

NewUploader creates a new Uploader.

func (*Uploader) Upload

func (u *Uploader) Upload(ctx context.Context, src SourceInfo, r io.Reader) error

Upload uploads the debug information to the Parca server.

func (*Uploader) UploadAll

func (u *Uploader) UploadAll(ctx context.Context, srcDbgInfo map[SourceInfo]io.Reader) error

UploadAll uploads all debug information to the Parca server.