Marusyk / grok.net

.NET implementation of the grok 📝
MIT License
290 stars 55 forks source link

Add documentation of custom grok patterns #19

Closed Marusyk closed 3 years ago

Marusyk commented 3 years ago

Context

The support of custom grok patterns was added in #15

Just add the directory with the name Patterns and a file (the file name doesn't matter) with your own patterns.

Like Patterns\grok-custom-patterns:

ZIPCODE [1-9]{1}[0-9]{2}\s{0,1}[0-9]{3}

and use:

Grok grok = new Grok("%{ZIPCODE:zipcode}:%{EMAILADDRESS:email}");
var grokResult = grok.Parse($"122001:Bob.Davis@microsoft.com");

DoD

Describe a new feature in README

ManasviGoyal commented 3 years ago

@Marusyk can you pls elaborate? would like to work in this

Marusyk commented 3 years ago

Hi @ManasviGoyal please go ahead. It is yours

ManasviGoyal commented 3 years ago

Can you help me get started? @Marusyk

Marusyk commented 3 years ago

@ManasviGoyal here is everything you need. Other information is in README.md. What other help do you need? Also see, https://github.com/Marusyk/grok.net/blob/main/CONTRIBUTING.md

obinnadtq commented 3 years ago

Hi, please can I try working on this as well?

ManasviGoyal commented 3 years ago

Hi @ManasviGoyal please go ahead. It is yours

@Marusyk so i just have to describe this feature in the Read me file, right?

Marusyk commented 3 years ago

@ManasviGoyal right

@obinnadtq yes, if @ManasviGoyal doesn't mind

ManasviGoyal commented 3 years ago

@Marusyk pls check