io.krakens.grok.api

Class GrokCompiler

java.lang.Object

io.krakens.grok.api.GrokCompiler

public class GrokCompiler
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Grok	compile(java.lang.String pattern) Compiles a given Grok pattern and returns a Grok object which can parse the pattern.
Grok	compile(java.lang.String pattern, boolean namedOnly)
Grok	compile(java.lang.String pattern, java.time.ZoneId defaultTimeZone, boolean namedOnly) Compiles a given Grok pattern and returns a Grok object which can parse the pattern.
java.util.Map<java.lang.String,java.lang.String>	getPatternDefinitions()
static GrokCompiler	newInstance()
void	register(java.io.InputStream input) Registers multiple pattern definitions from a given inputStream, and decoded as a UTF-8 source.
void	register(java.io.InputStream input, java.nio.charset.Charset charset) Registers multiple pattern definitions from a given inputStream.
void	register(java.util.Map<java.lang.String,java.lang.String> patternDefinitions) Registers multiple pattern definitions.
void	register(java.io.Reader input) Registers multiple pattern definitions from a given Reader.
void	register(java.lang.String name, java.lang.String pattern) Registers a new pattern definition.
void	registerDefaultPatterns()
void	registerPatternFromClasspath(java.lang.String path)
void	registerPatternFromClasspath(java.lang.String path, java.nio.charset.Charset charset)

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static GrokCompiler newInstance()

getPatternDefinitions

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

register

public void register(java.lang.String name,
                     java.lang.String pattern)

Registers a new pattern definition.

Parameters:

name - : Pattern Name

pattern - : Regular expression Or Grok pattern

Throws:

GrokException - runtime expt

register

public void register(java.util.Map<java.lang.String,java.lang.String> patternDefinitions)

Registers multiple pattern definitions.

registerDefaultPatterns

public void registerDefaultPatterns()

registerPatternFromClasspath

public void registerPatternFromClasspath(java.lang.String path)
                                  throws GrokException

Throws:

GrokException

registerPatternFromClasspath

public void registerPatternFromClasspath(java.lang.String path,
                                         java.nio.charset.Charset charset)
                                  throws GrokException

Throws:

GrokException

register

public void register(java.io.InputStream input)
              throws java.io.IOException

Registers multiple pattern definitions from a given inputStream, and decoded as a UTF-8 source.

Throws:

java.io.IOException

register

public void register(java.io.InputStream input,
                     java.nio.charset.Charset charset)
              throws java.io.IOException

Registers multiple pattern definitions from a given inputStream.

Throws:

java.io.IOException

register

public void register(java.io.Reader input)
              throws java.io.IOException

Registers multiple pattern definitions from a given Reader.

Throws:

java.io.IOException

compile

public Grok compile(java.lang.String pattern)
             throws java.lang.IllegalArgumentException

Compiles a given Grok pattern and returns a Grok object which can parse the pattern.

Throws:

java.lang.IllegalArgumentException

compile

public Grok compile(java.lang.String pattern,
                    boolean namedOnly)
             throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

compile

public Grok compile(java.lang.String pattern,
                    java.time.ZoneId defaultTimeZone,
                    boolean namedOnly)
             throws java.lang.IllegalArgumentException

Compiles a given Grok pattern and returns a Grok object which can parse the pattern.

Parameters:

pattern - : Grok pattern (ex: %{IP})

defaultTimeZone - : time zone used to parse a timestamp when it doesn't contain the time zone

namedOnly - : Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})

Returns:

a compiled pattern

Throws:

java.lang.IllegalArgumentException - when pattern definition is invalid