io.krakens.grok.api

Class Grok

java.lang.Object

io.krakens.grok.api.Grok

public class Grok
extends java.lang.Object

Grok parse arbitrary text and structure it.
Grok is simple API that allows you to easily parse logs and other files (single line). With Grok, you can turn unstructured log and event data into structured data.

Since:

0.0.1

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,io.krakens.grok.api.Converter.IConverter<? extends java.lang.Object>>	converters
java.util.Map<java.lang.String,Converter.Type>	groupTypes
java.util.Set<java.lang.String>	namedGroups

Constructor Summary

Constructors

Constructor and Description
Grok(java.lang.String pattern, java.lang.String namedRegex, java.util.Map<java.lang.String,java.lang.String> namedRegexCollection, java.util.Map<java.lang.String,java.lang.String> patternDefinitions, java.time.ZoneId defaultTimeZone)

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.util.Map<java.lang.String,java.lang.Object>>	capture(java.util.List<java.lang.String> logs) Match the given list of log with the named regex and return the list of json representation of the matched elements.
java.util.Map<java.lang.String,java.lang.Object>	capture(java.lang.String log) Match the given log with the named regex.
java.lang.String	discover(java.lang.String input) Grok will try to find the best expression that will match your input.
java.lang.String	getNamedRegex() Get the named regex from the Grok pattern.
java.util.Map<java.lang.String,java.lang.String>	getNamedRegexCollection() Get the full collection of the named regex.
java.lang.String	getNamedRegexCollectionById(java.lang.String id) Get the named regex from the given id.
java.lang.String	getOriginalGrokPattern() Original grok pattern used to compile to the named regex.
java.util.Map<java.lang.String,java.lang.String>	getPatterns() Get the current map of Grok pattern.
java.lang.String	getSaved_pattern()
Match	match(java.lang.CharSequence text) Match the given text with the named regex Grok will extract data from the string and get an extence of Match.
void	setSaved_pattern(java.lang.String savedpattern)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

namedGroups

public final java.util.Set<java.lang.String> namedGroups

groupTypes

public final java.util.Map<java.lang.String,Converter.Type> groupTypes

converters

public final java.util.Map<java.lang.String,io.krakens.grok.api.Converter.IConverter<? extends java.lang.Object>> converters

Constructor Detail

Grok

public Grok(java.lang.String pattern,
            java.lang.String namedRegex,
            java.util.Map<java.lang.String,java.lang.String> namedRegexCollection,
            java.util.Map<java.lang.String,java.lang.String> patternDefinitions,
            java.time.ZoneId defaultTimeZone)

Method Detail

getSaved_pattern

public java.lang.String getSaved_pattern()

setSaved_pattern

public void setSaved_pattern(java.lang.String savedpattern)

getPatterns

public java.util.Map<java.lang.String,java.lang.String> getPatterns()

Get the current map of Grok pattern.

Returns:

Patterns (name, regular expression)

getNamedRegex

public java.lang.String getNamedRegex()

Get the named regex from the Grok pattern.

Returns:

named regex

getOriginalGrokPattern

public java.lang.String getOriginalGrokPattern()

Original grok pattern used to compile to the named regex.

Returns:

String Original Grok pattern

getNamedRegexCollectionById

public java.lang.String getNamedRegexCollectionById(java.lang.String id)

Get the named regex from the given id.

Parameters:

id - : named regex id

Returns:

String of the named regex

getNamedRegexCollection

public java.util.Map<java.lang.String,java.lang.String> getNamedRegexCollection()

Get the full collection of the named regex.

Returns:

named RegexCollection

capture

public java.util.Map<java.lang.String,java.lang.Object> capture(java.lang.String log)

Match the given log with the named regex. And return the json representation of the matched element

Parameters:

log - : log to match

Returns:

map containing matches

capture

public java.util.ArrayList<java.util.Map<java.lang.String,java.lang.Object>> capture(java.util.List<java.lang.String> logs)

Match the given list of log with the named regex and return the list of json representation of the matched elements.

Parameters:

logs - : list of log

Returns:

list of maps containing matches

match

public Match match(java.lang.CharSequence text)

Match the given text with the named regex Grok will extract data from the string and get an extence of Match.

Parameters:

text - : Single line of log

Returns:

Grok Match

discover

public java.lang.String discover(java.lang.String input)

Grok will try to find the best expression that will match your input. Discovery

Parameters:

input - : Single line of log

Returns:

the Grok pattern