hotthreads

package
v8.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2023 License: Apache-2.0 Imports: 14 Imported by: 4

Documentation

Overview

Returns information about hot threads on each node in the cluster.

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type HotThreads

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

func New

Returns information about hot threads on each node in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html

func (HotThreads) Do

func (r HotThreads) Do(ctx context.Context) (*Response, error)

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

func (*HotThreads) Header

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

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

func (*HotThreads) HttpRequest

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

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

func (*HotThreads) IgnoreIdleThreads

func (r *HotThreads) IgnoreIdleThreads(ignoreidlethreads bool) *HotThreads

IgnoreIdleThreads If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out. API name: ignore_idle_threads

func (*HotThreads) Interval

func (r *HotThreads) Interval(duration string) *HotThreads

Interval The interval to do the second sampling of threads. API name: interval

func (HotThreads) IsSuccess

func (r HotThreads) IsSuccess(ctx 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 (*HotThreads) MasterTimeout

func (r *HotThreads) MasterTimeout(duration string) *HotThreads

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (*HotThreads) NodeId

func (r *HotThreads) NodeId(nodeid string) *HotThreads

NodeId List of node IDs or names used to limit returned information. API Name: nodeid

func (HotThreads) Perform added in v8.7.0

func (r HotThreads) Perform(ctx context.Context) (*http.Response, error)

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

func (*HotThreads) Snapshots

func (r *HotThreads) Snapshots(snapshots string) *HotThreads

Snapshots Number of samples of thread stacktrace. API name: snapshots

func (*HotThreads) Sort

func (r *HotThreads) Sort(sort threadtype.ThreadType) *HotThreads

Sort The sort order for 'cpu' type (default: total) API name: sort

func (*HotThreads) Threads

func (r *HotThreads) Threads(threads string) *HotThreads

Threads Specifies the number of hot threads to provide information for. API name: threads

func (*HotThreads) Timeout

func (r *HotThreads) Timeout(duration string) *HotThreads

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*HotThreads) Type

func (r *HotThreads) Type(type_ threadtype.ThreadType) *HotThreads

Type The type to sample. API name: type

type NewHotThreads

type NewHotThreads func() *HotThreads

NewHotThreads type alias for index.

func NewHotThreadsFunc

func NewHotThreadsFunc(tp elastictransport.Interface) NewHotThreads

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

type Response added in v8.7.0

type Response struct {
	HotThreads []types.HotThread `json:"hot_threads"`
}

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL