flamegraph

Documentation

Overview

Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.

Index

• Variables
• type Flamegraph
  • func New(tp elastictransport.Interface) *Flamegraph
  • func (r Flamegraph) Do(ctx context.Context) (bool, error)
  • func (r *Flamegraph) Header(key, value string) *Flamegraph
  • func (r *Flamegraph) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Flamegraph) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Flamegraph) Perform(providedCtx context.Context) (*http.Response, error)
• type NewFlamegraph
  • func NewFlamegraphFunc(tp elastictransport.Interface) NewFlamegraph

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type Flamegraph

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

func New

func New(tp elastictransport.Interface) *Flamegraph

Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.

https://www.elastic.co/guide/en/observability/current/universal-profiling.html

func (Flamegraph) Do

func (r Flamegraph) Do(ctx context.Context) (bool, error)

Do runs the request through the transport, handle the response and returns a flamegraph.Response

func (*Flamegraph) Header

func (r *Flamegraph) Header(key, value string) *Flamegraph

Header set a key, value pair in the Flamegraph headers map.

func (*Flamegraph) HttpRequest

func (r *Flamegraph) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (Flamegraph) IsSuccess

func (r Flamegraph) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (Flamegraph) Perform

func (r Flamegraph) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

type NewFlamegraph

type NewFlamegraph func() *Flamegraph

NewFlamegraph type alias for index.

func NewFlamegraphFunc

func NewFlamegraphFunc(tp elastictransport.Interface) NewFlamegraph

NewFlamegraphFunc returns a new instance of Flamegraph with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.