grok

README

grok

This library is a fork of github.com/vjeantet/grok that parses grok patterns in Go.

Usage

Denormalize and Compile

denormalized, errs := DenormalizePatternsFromMap(CopyDefalutPatterns())
if len(errs) == 0 {
  g, err := CompilePattern("%{DAY:day}", grok.PatternStorage{denormalized})
  if err == nil {
    ret, _ := g.Run("Tue qds", false)
  }
}

Example

package main

import (
  "fmt"

  "github.com/GuanceCloud/grok"
)

func main() {
  de, errs := grok.DenormalizePatternsFromMap(grok.CopyDefalutPatterns())
  if len(errs) != 0 {
    fmt.Print(errs)
    return
  }
  g, err := grok.CompilePattern("%{COMMONAPACHELOG}", grok.PatternStorage{de})
  if err != nil {
    fmt.Print(err)
  }
  ret, err := g.Run(`127.0.0.1 - - [23/Apr/2014:22:58:32 +0200] "GET /index.php HTTP/1.1" 404 207`, true)
  if err != nil {
    fmt.Print(err)
  }
  for k, name := range g.MatchNames() {
    fmt.Printf("%+15s: %s\n", name, ret[k])
  }
}

output:

     clientip: 127.0.0.1
        ident: -
         auth: -
    timestamp: 23/Apr/2014:22:58:32 +0200
         verb: GET
      request: /index.php
  httpversion: 1.1
   rawrequest:
     response: 404
        bytes: 207

Documentation

Overview

Package grok used to parses grok patterns in Go

Index

• Constants
• Variables
• func CopyDefalutPatterns() map[string]string
• func CopyDenormalizedDefalutPatterns() map[string]*GrokPattern
• func DenormalizePatternsFromMap(m map[string]string, denormalized ...map[string]*GrokPattern) (map[string]*GrokPattern, map[string]string)
• func LoadPatternsFromPath(path string) (map[string]string, error)
• type GrokPattern
  • func DenormalizePattern(input string, denormalized ...PatternStorageIface) (*GrokPattern, error)
  • func (g *GrokPattern) Denormalized() string
  • func (g *GrokPattern) Pattern() string
  • func (g *GrokPattern) TypedVar() map[string]string
• type GrokRegexp
  • func CompilePattern(input string, denomalized PatternStorageIface) (*GrokRegexp, error)
  • func (g *GrokRegexp) GetValAnyByName(k string, val []any) (any, bool)
  • func (g *GrokRegexp) GetValByName(k string, val []string) (string, bool)
  • func (g *GrokRegexp) GetValCastByName(k string, val []string) (any, bool)
  • func (g *GrokRegexp) MatchNames() []string
  • func (g *GrokRegexp) Run(content string, trimSpace bool) ([]string, error)
  • func (g *GrokRegexp) RunWithTypeInfo(content string, trimSpace bool) ([]any, error)
  • func (g *GrokRegexp) WithTypeInfo() bool
• type PatternStorage
  • func (p PatternStorage) GetPattern(pattern string) (*GrokPattern, bool)
  • func (p PatternStorage) SetPattern(patternAlias string, gp *GrokPattern)
• type PatternStorageIface
• type SubMatchName

Constants

const (
	GTypeStr    = "str"
	GTypeString = "string"
	GTypeInt    = "int"
	GTypeFloat  = "float"
	GTypeBool   = "bool"
)

Variables

var ErrMismatch = errors.New("mismatch")

var ErrNotCompiled = errors.New("not compiled")

Functions

func CopyDefalutPatterns

func CopyDefalutPatterns() map[string]string

func CopyDenormalizedDefalutPatterns

func CopyDenormalizedDefalutPatterns() map[string]*GrokPattern

func DenormalizePatternsFromMap

func DenormalizePatternsFromMap(m map[string]string, denormalized ...map[string]*GrokPattern) (map[string]*GrokPattern, map[string]string)

DenormalizePatternsFromMap denormalize pattern from map, will return a valid pattern:value map and an invalid pattern:error map.

func LoadPatternsFromPath

func LoadPatternsFromPath(path string) (map[string]string, error)

Types

type GrokPattern

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

func DenormalizePattern

func DenormalizePattern(input string, denormalized ...PatternStorageIface) (
	*GrokPattern, error,
)

DenormalizePattern denormalizes the pattern to the regular expression.

func (*GrokPattern) Denormalized

func (g *GrokPattern) Denormalized() string

func (*GrokPattern) Pattern

func (g *GrokPattern) Pattern() string

func (*GrokPattern) TypedVar

func (g *GrokPattern) TypedVar() map[string]string

type GrokRegexp

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

func CompilePattern

func CompilePattern(input string, denomalized PatternStorageIface) (*GrokRegexp, error)

func (*GrokRegexp) GetValAnyByName

func (g *GrokRegexp) GetValAnyByName(k string, val []any) (any, bool)

func (*GrokRegexp) GetValByName

func (g *GrokRegexp) GetValByName(k string, val []string) (string, bool)

func (*GrokRegexp) GetValCastByName

func (g *GrokRegexp) GetValCastByName(k string, val []string) (any, bool)

func (*GrokRegexp) MatchNames

func (g *GrokRegexp) MatchNames() []string

func (*GrokRegexp) Run

func (g *GrokRegexp) Run(content string, trimSpace bool) ([]string, error)

func (*GrokRegexp) RunWithTypeInfo

func (g *GrokRegexp) RunWithTypeInfo(content string, trimSpace bool) ([]any, error)

func (*GrokRegexp) WithTypeInfo

func (g *GrokRegexp) WithTypeInfo() bool

type PatternStorage

type PatternStorage []map[string]*GrokPattern

func (PatternStorage) GetPattern

func (p PatternStorage) GetPattern(pattern string) (*GrokPattern, bool)

func (PatternStorage) SetPattern

func (p PatternStorage) SetPattern(patternAlias string, gp *GrokPattern)

type PatternStorageIface

type PatternStorageIface interface {
	GetPattern(string) (*GrokPattern, bool)
	SetPattern(string, *GrokPattern)
}

type SubMatchName

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