processorgrok

Documentation

Overview

Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.

Index

• Variables
• type NewProcessorGrok
  • func NewProcessorGrokFunc(tp elastictransport.Interface) NewProcessorGrok
• type ProcessorGrok
  • func New(tp elastictransport.Interface) *ProcessorGrok
  • func (r ProcessorGrok) Do(providedCtx context.Context) (*Response, error)
  • func (r *ProcessorGrok) ErrorTrace(errortrace bool) *ProcessorGrok
  • func (r *ProcessorGrok) FilterPath(filterpaths ...string) *ProcessorGrok
  • func (r *ProcessorGrok) Header(key, value string) *ProcessorGrok
  • func (r *ProcessorGrok) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ProcessorGrok) Human(human bool) *ProcessorGrok
  • func (r ProcessorGrok) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ProcessorGrok) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ProcessorGrok) Pretty(pretty bool) *ProcessorGrok
• 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 NewProcessorGrok

type NewProcessorGrok func() *ProcessorGrok

NewProcessorGrok type alias for index.

func NewProcessorGrokFunc

func NewProcessorGrokFunc(tp elastictransport.Interface) NewProcessorGrok

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

type ProcessorGrok

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

func New

func New(tp elastictransport.Interface) *ProcessorGrok

Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.

https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html

func (ProcessorGrok) Do

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

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

func (*ProcessorGrok) ErrorTrace

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

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

func (*ProcessorGrok) FilterPath

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

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

func (*ProcessorGrok) Header

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

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

func (*ProcessorGrok) HttpRequest

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

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

func (*ProcessorGrok) Human

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

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 (ProcessorGrok) IsSuccess

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

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

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

func (*ProcessorGrok) Pretty

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

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

type Response

type Response struct {
	Patterns map[string]string `json:"patterns"`
}

Response holds the response body struct for the package processorgrok

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ingest/processor_grok/GrokProcessorPatternsResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response