topnfunctions

Documentation

Overview

Extracts a list of topN functions from Universal Profiling.

Index

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

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 NewTopnFunctions

type NewTopnFunctions func() *TopnFunctions

NewTopnFunctions type alias for index.

func NewTopnFunctionsFunc

func NewTopnFunctionsFunc(tp elastictransport.Interface) NewTopnFunctions

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

type TopnFunctions

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

func New

func New(tp elastictransport.Interface) *TopnFunctions

Extracts a list of topN functions from Universal Profiling.

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

func (TopnFunctions) Do

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

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

func (*TopnFunctions) Header

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

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

func (*TopnFunctions) HttpRequest

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

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

func (TopnFunctions) IsSuccess

func (r TopnFunctions) 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 (TopnFunctions) Perform

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

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