-
Notifications
You must be signed in to change notification settings - Fork 66
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
Improve Grok function docs #5243
Conversation
that can be referenced in any pattern. The included named patterns can be seen | ||
[here](https://raw.githubusercontent.com/brimdata/zed/main/pkg/grok/base.go). | ||
|
||
### Comparison to Other Implementations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this section is long, but it's my best attempt to deal with the fact that web searches for "grok parsing" and such will reveal tons of examples that, taken unmodified, will not work in our implementation. Since we collectively don't have the cycles or stomach to build full compatibility with Logstash, I figure the next best thing is just disclose as much as we can and hope users are patient.
I think my problem with this change is it basically reads like here are the features we don't have that logstash has when docs usually read like here are the features. It also assumes that user looking at this doc is familiar with logstash's implementation of grok which probably is true but also might now be. I do think we could add example showing how to capture nested fields using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I spoke with @mattnibs about this today. We agreed that working through his suggestions comes second to work he and I are focused on now, so we should merge this as is (and possibly revisit the suggestions later).
A recent community Slack thread inspired me to finish a long standing to-do to improve these Grok function docs.
If you'd like to review by seeing it rendered, I've got it on a personal staging site at:
https://66c760c8bd7394547de20d6c--spiffy-gnome-8f2834.netlify.app/docs/next/language/functions/grok