Skip to content

Add documentation of custom grok patterns #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Marusyk opened this issue Jul 25, 2021 · 8 comments · Fixed by #20
Closed

Add documentation of custom grok patterns #19

Marusyk opened this issue Jul 25, 2021 · 8 comments · Fixed by #20

Comments

@Marusyk
Copy link
Owner

Marusyk commented Jul 25, 2021

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:[email protected]");

DoD

Describe a new feature in README

@Marusyk Marusyk added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jul 25, 2021
@ManasviGoyal
Copy link
Contributor

ManasviGoyal commented Jul 28, 2021

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

@Marusyk
Copy link
Owner Author

Marusyk commented Jul 29, 2021

Hi @ManasviGoyal please go ahead. It is yours

@ManasviGoyal
Copy link
Contributor

Can you help me get started? @Marusyk

@Marusyk
Copy link
Owner Author

Marusyk commented Jul 29, 2021

@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
Copy link

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

@ManasviGoyal
Copy link
Contributor

Hi @ManasviGoyal please go ahead. It is yours

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

@Marusyk
Copy link
Owner Author

Marusyk commented Jul 29, 2021

@ManasviGoyal right

@obinnadtq yes, if @ManasviGoyal doesn't mind

@ManasviGoyal
Copy link
Contributor

@Marusyk pls check

@Marusyk Marusyk removed documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants