findfieldstructure

package
v8.19.0 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2025 License: Apache-2.0 Imports: 13 Imported by: 1

Documentation

Overview

Find the structure of a text field. Find the structure of a text field in an Elasticsearch index.

This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.

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 FindFieldStructure 

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

func New 

func New(tp elastictransport.Interface) *FindFieldStructure

Find the structure of a text field. Find the structure of a text field in an Elasticsearch index.

This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.

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/guide/en/elasticsearch/reference/current/find-field-structure.html

func (*FindFieldStructure) ColumnNames added in v8.18.0 

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

ColumnNames If `format` is set to `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 row, columns are named "column1", "column2", "column3", for example. API name: column_names

func (*FindFieldStructure) Delimiter added in v8.18.0 

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

Delimiter If you have set `format` to `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 (FindFieldStructure) Do 

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

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

func (*FindFieldStructure) DocumentsToSample added in v8.18.0 

func (r *FindFieldStructure) DocumentsToSample(documentstosample string) *FindFieldStructure

DocumentsToSample The number of documents to include in the structural analysis. The minimum value is 2. API name: documents_to_sample

func (*FindFieldStructure) EcsCompatibility added in v8.18.0 

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

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 the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output. The intention in that situation is that a user who knows the meanings will rename the fields before using them. API name: ecs_compatibility

func (*FindFieldStructure) ErrorTrace added in v8.18.0 

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

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

func (*FindFieldStructure) Explain added in v8.18.0 

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

Explain If `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 (*FindFieldStructure) Field added in v8.18.0 

func (r *FindFieldStructure) Field(field string) *FindFieldStructure

Field The field that should be analyzed. API name: field

func (*FindFieldStructure) FilterPath added in v8.18.0 

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

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

func (*FindFieldStructure) Format added in v8.18.0 

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

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 set to 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 (*FindFieldStructure) GrokPattern added in v8.18.0 

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

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 (*FindFieldStructure) Header 

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

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

func (*FindFieldStructure) HttpRequest 

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

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

func (*FindFieldStructure) Human added in v8.18.0 

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

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 (*FindFieldStructure) Index added in v8.18.0 

func (r *FindFieldStructure) Index(indexname string) *FindFieldStructure

Index The name of the index that contains the analyzed field. API name: index

func (FindFieldStructure) IsSuccess 

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

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

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

func (*FindFieldStructure) Pretty added in v8.18.0 

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

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

func (*FindFieldStructure) Quote added in v8.18.0 

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

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 (*FindFieldStructure) ShouldTrimFields added in v8.18.0 

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

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 (*FindFieldStructure) Timeout added in v8.18.0 

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

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 (*FindFieldStructure) TimestampField added in v8.18.0 

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

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 (*FindFieldStructure) TimestampFormat added in v8.18.0 

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

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 NewFindFieldStructure 

type NewFindFieldStructure func() *FindFieldStructure

NewFindFieldStructure type alias for index.

func NewFindFieldStructureFunc 

func NewFindFieldStructureFunc(tp elastictransport.Interface) NewFindFieldStructure

NewFindFieldStructureFunc returns a new instance of FindFieldStructure 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.18.0 

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 findfieldstructure

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/text_structure/find_field_structure/FindFieldStructureResponse.ts#L31-L49

func NewResponse added in v8.18.0 

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.