hotthreads

Documentation

Overview

Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

Index

• Variables
• type HotThreads
  • func New(tp elastictransport.Interface) *HotThreads
  • func (r HotThreads) Do(providedCtx context.Context) (*Response, error)
  • func (r *HotThreads) ErrorTrace(errortrace bool) *HotThreads
  • func (r *HotThreads) FilterPath(filterpaths ...string) *HotThreads
  • func (r *HotThreads) Header(key, value string) *HotThreads
  • func (r *HotThreads) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *HotThreads) Human(human bool) *HotThreads
  • func (r *HotThreads) IgnoreIdleThreads(ignoreidlethreads bool) *HotThreads
  • func (r *HotThreads) Interval(duration string) *HotThreads
  • func (r HotThreads) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *HotThreads) MasterTimeout(duration string) *HotThreads
  • func (r *HotThreads) NodeId(nodeid string) *HotThreads
  • func (r HotThreads) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *HotThreads) Pretty(pretty bool) *HotThreads
  • func (r *HotThreads) Snapshots(snapshots string) *HotThreads
  • func (r *HotThreads) Sort(sort threadtype.ThreadType) *HotThreads
  • func (r *HotThreads) Threads(threads string) *HotThreads
  • func (r *HotThreads) Timeout(duration string) *HotThreads
  • func (r *HotThreads) Type(type_ threadtype.ThreadType) *HotThreads
• type NewHotThreads
  • func NewHotThreadsFunc(tp elastictransport.Interface) NewHotThreads
• type Response
  • func NewResponse() *Response

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 HotThreads

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

func New

func New(tp elastictransport.Interface) *HotThreads

Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

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

func (HotThreads) Do

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

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

func (*HotThreads) ErrorTrace

func (r *HotThreads) ErrorTrace(errortrace bool) *HotThreads

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*HotThreads) FilterPath

func (r *HotThreads) FilterPath(filterpaths ...string) *HotThreads

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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) Human

func (r *HotThreads) Human(human bool) *HotThreads

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

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(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 (*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

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

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

func (*HotThreads) Pretty

func (r *HotThreads) Pretty(pretty bool) *HotThreads

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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

type Response struct {
}

Response holds the response body struct for the package hotthreads

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/nodes/hot_threads/NodesHotThreadsResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response