Grok (Grok 0.1.5 API)

java.lang.Object
- io.thekraken.grok.api.Grok

All Implemented Interfaces:

Serializable
```
public class Grok
extends Object
implements Serializable
```
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 (JSON).
example:
```
  Grok grok = Grok.create("patterns/patterns");
  grok.compile("%{USER}");
  Match gm = grok.match("root");
  gm.captures();
 
```
Since:

0.0.1

Author:

anthonycorbacho

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Grok EMPTY
Create Empty Grok.

Fields
Modifier and Type	Field and Description
`static Grok`	`EMPTY` Create Empty `Grok`.

Constructor Summary

Constructors
Constructor and Description

Grok()
Create a new emptyGrok object.

Constructors
Constructor and Description
`Grok()` Create a new empty`Grok` object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPattern(String name, String pattern)` Add custom pattern to grok in the runtime.
`void`	`addPatternFromFile(String file)` Add patterns to `Grok` from the given file.
`void`	`addPatternFromReader(Reader r)` Add patterns to `Grok` from a Reader.
`String`	`capture(String log)` Match the given `log` with the named regex.
`List<String>`	`captures(List<String> logs)` Match the given list of `log` with the named regex and return the list of json representation of the matched elements.
`void`	`compile(String pattern)` Compile the `Grok` pattern to named regex pattern.
`void`	`compile(String pattern, boolean namedOnly)` Compile the `Grok` pattern to named regex pattern.
`void`	`copyPatterns(Map<String,String> cpy)` Copy the given Map of patterns (pattern name, regular expression) to `Grok`, duplicate element will be override.
`static Grok`	`create(String grokPatternPath)` Create a `Grok` instance with the given grok patterns file.
`static Grok`	`create(String grokPatternPath, String grokExpression)` Create a `Grok` instance with the given patterns file and a `Grok` pattern.
`String`	`discover(String input)` `Grok` will try to find the best expression that will match your input.
`String`	`getNamedRegex()` Get the named regex from the `Grok` pattern.
`Map<String,String>`	`getNamedRegexCollection()` Get the full collection of the named regex.
`String`	`getNamedRegexCollectionById(String id)` Get the named regex from the given id.
`String`	`getOriginalGrokPattern()` Original grok pattern used to compile to the named regex.
`Map<String,String>`	`getPatterns()` Get the current map of `Grok` pattern.
`String`	`getSaved_pattern()`
`Match`	`match(String 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(String savedpattern)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final Grok EMPTY
```
    Create Empty Grok.
- Constructor Detail
  - Grok
```
public Grok()
```
    Create a new emptyGrok object.
- Method Detail
  - getSaved_pattern
```
public String getSaved_pattern()
```
  - setSaved_pattern
```
public void setSaved_pattern(String savedpattern)
```
  - create
```
public static Grok create(String grokPatternPath,
                          String grokExpression)
                   throws GrokException
```
    Create a Grok instance with the given patterns file and a Grok pattern.
    
    Parameters:
    
    grokPatternPath - Path to the pattern file
    
    grokExpression - - OPTIONAL - Grok pattern to compile ex: %{APACHELOG}
    
    Returns:
    
    Grok instance
    
    Throws:
    
    GrokException - runtime expt
  - create
```
public static Grok create(String grokPatternPath)
                   throws GrokException
```
    Create a Grok instance with the given grok patterns file.
    
    Parameters:
    
    grokPatternPath - : Path to the pattern file
    
    Returns:
    
    Grok
    
    Throws:
    
    GrokException - runtime expt
  - addPattern
```
public void addPattern(String name,
                       String pattern)
                throws GrokException
```
    Add custom pattern to grok in the runtime.
    
    Parameters:
    
    name - : Pattern Name
    
    pattern - : Regular expression Or Grok pattern
    
    Throws:
    
    GrokException - runtime expt
  - copyPatterns
```
public void copyPatterns(Map<String,String> cpy)
                  throws GrokException
```
    Copy the given Map of patterns (pattern name, regular expression) to Grok, duplicate element will be override.
    
    Parameters:
    
    cpy - : Map to copy
    
    Throws:
    
    GrokException - runtime expt
  - getPatterns
```
public Map<String,String> getPatterns()
```
    Get the current map of Grok pattern.
    
    Returns:
    
    Patterns (name, regular expression)
  - getNamedRegex
```
public String getNamedRegex()
```
    Get the named regex from the Grok pattern.
    See compile(String) for more detail.
    
    Returns:
    
    named regex
  - addPatternFromFile
```
public void addPatternFromFile(String file)
                        throws GrokException
```
    Add patterns to Grok from the given file.
    
    Parameters:
    
    file - : Path of the grok pattern
    
    Throws:
    
    GrokException - runtime expt
  - addPatternFromReader
```
public void addPatternFromReader(Reader r)
                          throws GrokException
```
    Add patterns to Grok from a Reader.
    
    Parameters:
    
    r - : Reader with Grok patterns
    
    Throws:
    
    GrokException - runtime expt
  - capture
```
public String capture(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:
    
    json representation og the log
  - captures
```
public List<String> captures(List<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 json representation of the log
  - match
```
public Match match(String 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
  - compile
```
public void compile(String pattern)
             throws GrokException
```
    Compile the Grok pattern to named regex pattern.
    
    Parameters:
    
    pattern - : Grok pattern (ex: %{IP})
    
    Throws:
    
    GrokException - runtime expt
  - compile
```
public void compile(String pattern,
                    boolean namedOnly)
             throws GrokException
```
    Compile the Grok pattern to named regex pattern.
    
    Parameters:
    
    pattern - : Grok pattern (ex: %{IP})
    
    namedOnly - : Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})
    
    Throws:
    
    GrokException - runtime expt
  - discover
```
public String discover(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
  - getOriginalGrokPattern
```
public String getOriginalGrokPattern()
```
    Original grok pattern used to compile to the named regex.
    
    Returns:
    
    String Original Grok pattern
  - getNamedRegexCollectionById
```
public String getNamedRegexCollectionById(String id)
```
    Get the named regex from the given id.
    
    Parameters:
    
    id - : named regex id
    
    Returns:
    
    String of the named regex
  - getNamedRegexCollection
```
public Map<String,String> getNamedRegexCollection()
```
    Get the full collection of the named regex.
    
    Returns:
    
    named RegexCollection

Class Grok

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Constructor Detail

Grok

Method Detail

getSaved_pattern

setSaved_pattern

create

create

addPattern

copyPatterns

getPatterns

getNamedRegex

addPatternFromFile

addPatternFromReader

capture

captures

match

compile

compile

discover

getOriginalGrokPattern

getNamedRegexCollectionById

getNamedRegexCollection