Skip to content

Commit

Permalink
Fix broken link for grok patterns in documentation (#78878)
Browse files Browse the repository at this point in the history
* Fix broken link for grok patterns in documentation

The current link for grok patterns does not exist anymore:

https://github.com/elastic/elasticsearch/blob/master/libs/grok/src/main/resources/patterns/grok-patterns

I have replaced it with:

https://github.com/elastic/elasticsearch/blob/master/libs/grok/src/main/resources/patterns/ecs-v1/grok-patterns

But I'm unsure if it is the right link as there is also a 'legacy' folder.

* Update link and add section for ECS migration

Co-authored-by: Adam Locke <[email protected]>
  • Loading branch information
stephane-deraco and Adam Locke authored Oct 12, 2021
1 parent 31e7cf9 commit dfc9df8
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/reference/scripting/grok-syntax.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ fields.

[[grok-syntax]]
==== Grok patterns
The {stack} ships with numerous https://github.com/elastic/elasticsearch/blob/master/libs/grok/src/main/resources/patterns/grok-patterns[predefined grok patterns] that simplify working with grok. The syntax for reusing grok patterns
The {stack} ships with numerous https://github.com/elastic/elasticsearch/blob/master/libs/grok/src/main/resources/patterns/legacy/grok-patterns[predefined grok patterns] that simplify working with grok. The syntax for reusing grok patterns
takes one of the following forms:

[%autowidth]
Expand Down Expand Up @@ -49,6 +49,22 @@ can match this text by using the following grok expression:
%{NUMBER:duration} %{IP:client}
----

[[grok-ecs]]
==== Migrating to Elastic Common Schema (ECS)

To ease migration to the {ecs-ref}[Elastic Common Schema (ECS)], a new set of
ECS-compliant patterns is available in addition to the existing patterns. The
new ECS pattern definitions capture event field names that are compliant with
the schema.

The ECS pattern set has all of the pattern definitions from the legacy set, and
is a drop-in replacement. Use the
{logstash-ref}/plugins-filters-grok.html#plugins-filters-grok-ecs_compatibility[`ecs-compatability`]
setting to switch modes.

New features and enhancements will be added to the ECS-compliant files. The
legacy patterns may still receive bug fixes which are backwards compatible.

[[grok-patterns]]
==== Use grok patterns in Painless scripts
You can incorporate predefined grok patterns into Painless scripts to extract
Expand Down

0 comments on commit dfc9df8

Please sign in to comment.