findstructure

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: 12 Imported by: 0

Documentation

Overview

Find the structure of a text file. The text file 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. Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. It must, however, be text; binary text formats are not currently supported. The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.

The response from the API contains:

* A couple of messages from the beginning of the text. * 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.

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 FindStructure 

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

func New 

func New(tp elastictransport.Interface) *FindStructure

Find the structure of a text file. The text file 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. Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. It must, however, be text; binary text formats are not currently supported. The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.

The response from the API contains:

* A couple of messages from the beginning of the text. * 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.

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

func (*FindStructure) Charset 

func (r *FindStructure) Charset(charset string) *FindStructure

Charset The text's character set. It must be a character set that is supported by the JVM that Elasticsearch uses. For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`. If this parameter is not specified, the structure finder chooses an appropriate character set. API name: charset

func (*FindStructure) ColumnNames 

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

ColumnNames If you have set format 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 role, columns are named "column1", "column2", "column3", for example. API name: column_names

func (*FindStructure) Delimiter 

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

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 (FindStructure) Do 

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

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

func (*FindStructure) EcsCompatibility 

func (r *FindStructure) EcsCompatibility(ecscompatibility string) *FindStructure

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. Valid values are `disabled` and `v1`. 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 (*FindStructure) Explain 

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

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. If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen. API name: explain

func (*FindStructure) Format 

func (r *FindStructure) Format(format string) *FindStructure

Format The high level structure of the text. Valid values are `ndjson`, `xml`, `delimited`, and `semi_structured_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 (*FindStructure) GrokPattern 

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

GrokPattern If you have set `format` to `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 (*FindStructure) HasHeaderRow 

func (r *FindStructure) HasHeaderRow(hasheaderrow bool) *FindStructure

HasHeaderRow If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text. If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows. API name: has_header_row

func (*FindStructure) Header 

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

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

func (*FindStructure) HttpRequest 

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

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

func (*FindStructure) LineMergeSizeLimit 

func (r *FindStructure) LineMergeSizeLimit(linemergesizelimit string) *FindStructure

LineMergeSizeLimit The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected. API name: line_merge_size_limit

func (*FindStructure) LinesToSample 

func (r *FindStructure) LinesToSample(linestosample string) *FindStructure

LinesToSample The number of lines to include in the structural analysis, starting from the beginning of the text. The minimum is 2. If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.

NOTE: The number of lines and the variation of the lines affects the speed of the analysis. For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample. If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety. API name: lines_to_sample

func (FindStructure) Perform 

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

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

func (*FindStructure) Quote 

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

Quote If you have set `format` to `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 (*FindStructure) Raw 

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

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

func (*FindStructure) Request 

func (r *FindStructure) Request(req *Request) *FindStructure

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

func (*FindStructure) ShouldTrimFields 

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

ShouldTrimFields If you have set `format` to `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 (*FindStructure) Timeout 

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

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

func (*FindStructure) TimestampField 

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

TimestampField The name of the field that contains the primary timestamp of each record in the text. In particular, if the text were 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 (*FindStructure) TimestampFormat 

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

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 separated from the `ss` by a `.`, `,` or `:`. Spacing and punctuation is also permitted with the exception of `?`, 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 NewFindStructure 

type NewFindStructure func() *FindStructure

NewFindStructure type alias for index.

func NewFindStructureFunc 

func NewFindStructureFunc(tp elastictransport.Interface) NewFindStructure

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

type Request 

type Request = []json.RawMessage

Request holds the request body struct for the package findstructure

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/text_structure/find_structure/FindStructureRequest.ts#L24-L207

func NewRequest 

func NewRequest() *Request

NewRequest returns a Request

type Response 

type Response struct {

	// Charset The character encoding used to parse the text.
	Charset string `json:"charset"`
	// ColumnNames If `format` is `delimited`, the `column_names` field lists the column names
	// in the order they appear in the sample.
	ColumnNames         []string `json:"column_names,omitempty"`
	Delimiter           *string  `json:"delimiter,omitempty"`
	ExcludeLinesPattern *string  `json:"exclude_lines_pattern,omitempty"`
	Explanation         []string `json:"explanation,omitempty"`
	// FieldStats The most common values of each field, plus basic numeric statistics for the
	// numeric `page_count` field.
	// This information may provide clues that the data needs to be cleaned or
	// transformed prior to use by other Elastic Stack functionality.
	FieldStats map[string]types.FieldStat `json:"field_stats"`
	// Format Valid values include `ndjson`, `xml`, `delimited`, and
	// `semi_structured_text`.
	Format      string  `json:"format"`
	GrokPattern *string `json:"grok_pattern,omitempty"`
	// HasByteOrderMarker For UTF character encodings, it indicates whether the text begins with a byte
	// order marker.
	HasByteOrderMarker bool                 `json:"has_byte_order_marker"`
	HasHeaderRow       *bool                `json:"has_header_row,omitempty"`
	IngestPipeline     types.PipelineConfig `json:"ingest_pipeline"`
	// JavaTimestampFormats The Java time formats recognized in the time fields.
	// Elasticsearch mappings and ingest pipelines use this format.
	JavaTimestampFormats []string `json:"java_timestamp_formats,omitempty"`
	// JodaTimestampFormats Information that is used to tell Logstash how to parse timestamps.
	JodaTimestampFormats []string `json:"joda_timestamp_formats,omitempty"`
	// Mappings Some suitable mappings for an index into which the data could be ingested.
	Mappings              types.TypeMapping `json:"mappings"`
	MultilineStartPattern *string           `json:"multiline_start_pattern,omitempty"`
	// NeedClientTimezone If a timestamp format is detected that does not include a timezone,
	// `need_client_timezone` is `true`.
	// The server that parses the text must therefore be told the correct timezone
	// by the client.
	NeedClientTimezone bool `json:"need_client_timezone"`
	// NumLinesAnalyzed The number of lines of the text that were analyzed.
	NumLinesAnalyzed int `json:"num_lines_analyzed"`
	// NumMessagesAnalyzed The number of distinct messages the lines contained.
	// For NDJSON, this value is the same as `num_lines_analyzed`.
	// For other text formats, messages can span several lines.
	NumMessagesAnalyzed int     `json:"num_messages_analyzed"`
	Quote               *string `json:"quote,omitempty"`
	// SampleStart The first two messages in the text verbatim.
	// This may help diagnose parse errors or accidental uploads of the wrong text.
	SampleStart      string `json:"sample_start"`
	ShouldTrimFields *bool  `json:"should_trim_fields,omitempty"`
	// TimestampField The field considered most likely to be the primary timestamp of each
	// document.
	TimestampField *string `json:"timestamp_field,omitempty"`
}

Response holds the response body struct for the package findstructure

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/text_structure/find_structure/FindStructureResponse.ts#L27-L97

func NewResponse 

func NewResponse() *Response

NewResponse returns a Response

Source Files

View all Source files
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.