findmessagestructure

package
v9.0.0 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.

The response from the API contains:

* Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.

All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen.

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 FindMessageStructure 

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

func New 

func New(tp elastictransport.Interface) *FindMessageStructure

Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.

The response from the API contains:

* Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.

All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-message-structure

func (*FindMessageStructure) ColumnNames 

func (r *FindMessageStructure) ColumnNames(columnnames string) *FindMessageStructure

ColumnNames If the format is `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example. API name: column_names

func (*FindMessageStructure) Delimiter 

func (r *FindMessageStructure) Delimiter(delimiter string) *FindMessageStructure

Delimiter If you the format is `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. API name: delimiter

func (FindMessageStructure) Do 

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

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

func (*FindMessageStructure) EcsCompatibility 

func (r *FindMessageStructure) EcsCompatibility(ecscompatibility ecscompatibilitytype.EcsCompatibilityType) *FindMessageStructure

EcsCompatibility The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. API name: ecs_compatibility

func (*FindMessageStructure) ErrorTrace 

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

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

func (*FindMessageStructure) Explain 

func (r *FindMessageStructure) Explain(explain bool) *FindMessageStructure

Explain If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. API name: explain

func (*FindMessageStructure) FilterPath 

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

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

func (*FindMessageStructure) Format 

func (r *FindMessageStructure) Format(format formattype.FormatType) *FindMessageStructure

Format The high level structure of the text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. API name: format

func (*FindMessageStructure) GrokPattern 

func (r *FindMessageStructure) GrokPattern(grokpattern string) *FindMessageStructure

GrokPattern If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern. API name: grok_pattern

func (*FindMessageStructure) Header 

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

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

func (*FindMessageStructure) HttpRequest 

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

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

func (*FindMessageStructure) Human 

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

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 (*FindMessageStructure) Messages 

func (r *FindMessageStructure) Messages(messages ...string) *FindMessageStructure

The list of messages you want to analyze. API name: messages

func (FindMessageStructure) Perform 

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

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

func (*FindMessageStructure) Pretty 

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

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

func (*FindMessageStructure) Quote 

func (r *FindMessageStructure) Quote(quote string) *FindMessageStructure

Quote If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (`"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. API name: quote

func (*FindMessageStructure) Raw 

func (r *FindMessageStructure) Raw(raw io.Reader) *FindMessageStructure

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*FindMessageStructure) Request 

func (r *FindMessageStructure) Request(req *Request) *FindMessageStructure

Request allows to set the request property with the appropriate payload.

func (*FindMessageStructure) ShouldTrimFields 

func (r *FindMessageStructure) ShouldTrimFields(shouldtrimfields bool) *FindMessageStructure

ShouldTrimFields If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. Otherwise, the default value is `false`. API name: should_trim_fields

func (*FindMessageStructure) Timeout 

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

Timeout The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires, it will be stopped. API name: timeout

func (*FindMessageStructure) TimestampField 

func (r *FindMessageStructure) TimestampField(field string) *FindMessageStructure

TimestampField The name of the field that contains the primary timestamp of each record in the text. In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.

If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.

For structured text, if you specify this parameter, the field must exist within the text.

If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text. API name: timestamp_field

func (*FindMessageStructure) TimestampFormat 

func (r *FindMessageStructure) TimestampFormat(timestampformat string) *FindMessageStructure

TimestampFormat The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported:

* `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz`

Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.

One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default.

If this parameter is not specified, the structure finder chooses the best format from a built-in set.

If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. API name: timestamp_format

type NewFindMessageStructure 

type NewFindMessageStructure func() *FindMessageStructure

NewFindMessageStructure type alias for index.

func NewFindMessageStructureFunc 

func NewFindMessageStructureFunc(tp elastictransport.Interface) NewFindMessageStructure

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

type Request 

type Request struct {

	// Messages The list of messages you want to analyze.
	Messages []string `json:"messages"`
}

Request holds the request body struct for the package findmessagestructure

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/text_structure/find_message_structure/FindMessageStructureRequest.ts#L25-L174

func NewRequest 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON 

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response 

type Response struct {
	Charset               string                                     `json:"charset"`
	EcsCompatibility      *ecscompatibilitytype.EcsCompatibilityType `json:"ecs_compatibility,omitempty"`
	FieldStats            map[string]types.FieldStat                 `json:"field_stats"`
	Format                formattype.FormatType                      `json:"format"`
	GrokPattern           *string                                    `json:"grok_pattern,omitempty"`
	IngestPipeline        types.PipelineConfig                       `json:"ingest_pipeline"`
	JavaTimestampFormats  []string                                   `json:"java_timestamp_formats,omitempty"`
	JodaTimestampFormats  []string                                   `json:"joda_timestamp_formats,omitempty"`
	Mappings              types.TypeMapping                          `json:"mappings"`
	MultilineStartPattern *string                                    `json:"multiline_start_pattern,omitempty"`
	NeedClientTimezone    bool                                       `json:"need_client_timezone"`
	NumLinesAnalyzed      int                                        `json:"num_lines_analyzed"`
	NumMessagesAnalyzed   int                                        `json:"num_messages_analyzed"`
	SampleStart           string                                     `json:"sample_start"`
	TimestampField        *string                                    `json:"timestamp_field,omitempty"`
}

Response holds the response body struct for the package findmessagestructure

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/text_structure/find_message_structure/FindMessageStructureResponse.ts#L31-L49

func NewResponse 

func NewResponse() *Response

NewResponse returns a Response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.