{"id":24081495,"url":"https://github.com/beh01der/node-grok","last_synced_at":"2025-08-11T00:51:35.278Z","repository":{"id":31969212,"uuid":"35539310","full_name":"Beh01der/node-grok","owner":"Beh01der","description":"Regular expression template library for Node.js inspired by logstash grok filter module","archived":false,"fork":false,"pushed_at":"2023-02-17T10:15:23.000Z","size":48,"stargazers_count":52,"open_issues_count":10,"forks_count":32,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-08-04T03:39:24.871Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Beh01der.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-05-13T09:12:04.000Z","updated_at":"2025-05-23T11:56:12.000Z","dependencies_parsed_at":"2024-06-18T21:25:44.125Z","dependency_job_id":null,"html_url":"https://github.com/Beh01der/node-grok","commit_stats":{"total_commits":42,"total_committers":10,"mean_commits":4.2,"dds":0.6428571428571428,"last_synced_commit":"046379885d059e2596464995101d686e577dc58f"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/Beh01der/node-grok","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-grok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-grok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-grok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-grok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Beh01der","download_url":"https://codeload.github.com/Beh01der/node-grok/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beh01der%2Fnode-grok/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269814225,"owners_count":24479357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-09T23:17:03.332Z","updated_at":"2025-08-11T00:51:35.218Z","avatar_url":"https://github.com/Beh01der.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-grok\n\nThis library is inspired by logstash grok filter but it's not a port of it.\n\nThis is a templating library that helps reusing existing regular expressions and constructing new, more complex one. The primary goal was to help parsing and transforming plain text logs into JSON objects (one line =\u003e one object) based on provided template. \n\n## Install\nInstall locally: `npm install node-grok`.\n\n## Quick start\nFollowing simple snippet\n```javascript\nvar p = '%{IP:client} \\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\] \"%{WORD:method} %{URIHOST:site}%{URIPATHPARAM:url}\" %{INT:code} %{INT:request} %{INT:response} - %{NUMBER:took} \\\\[%{DATA:cache}\\\\] \"%{DATA:mtag}\" \"%{DATA:agent}\"';\nvar str = '203.35.135.165 [2016-03-15T12:42:04+11:00] \"GET memz.co/cloud/\" 304 962 0 - 0.003 [MISS] \"-\" \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36\"';\n\nrequire('node-grok').loadDefault(function (patterns) {\n    var pattern = patterns.createPattern(p);\n    pattern.parse(str, function (err, obj) {\n        console.log(obj);\n    });\n});\n```\nwill transform string\n```\n203.35.135.165 [2016-03-15T12:42:04+11:00] \"GET memz.co/cloud/\" 304 962 0 - 0.003 [MISS] \"-\" \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36\"\n```\ninto object\n```json\n{ \n   \"client\": \"203.35.135.165\",\n   \"timestamp\": \"2016-03-15T12:42:04+11:00\",\n   \"method\": \"GET\",\n   \"site\": \"memz.co\",\n   \"url\": \"/cloud/\",\n   \"code\": \"304\",\n   \"request\": \"962\",\n   \"response\": \"0\",\n   \"took\": \"0.003\",\n   \"cache\": \"MISS\",\n   \"mtag\": \"-\",\n   \"agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36\" \n}\n```\n\n## Synchronous version of code\n```javascript\nvar p = '%{IP:client} \\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\] \"%{WORD:method} %{URIHOST:site}%{URIPATHPARAM:url}\" %{INT:code} %{INT:request} %{INT:response} - %{NUMBER:took} \\\\[%{DATA:cache}\\\\] \"%{DATA:mtag}\" \"%{DATA:agent}\"';\nvar str = '203.35.135.165 [2016-03-15T12:42:04+11:00] \"GET memz.co/cloud/\" 304 962 0 - 0.003 [MISS] \"-\" \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36\"';\n\nvar patterns = require('node-grok').loadDefaultSync();\nvar pattern = patterns.createPattern(p);\nconsole.log(pattern.parseSync(str));\n```\n\n## API\n* **loadDefault([loadModules,] callback)** - creates new pattern collection including all built-in patterns from `./patterns` folder. By providing *loadModules* parameter you can limit number of loaded patterns: `loadDefault(['grok-patterns'] ,...);`. Callback receives *patterns* collection filled in with default templates: `function(err, patterns)`.\n\n* **loadDefaultSync([loadModules])** - creates new default pattern collection and returns it `GrokCollection`.\n\n* **new GrokCollection()** - creates a new empty pattern collection.\n\n* **GrokCollection.createPattern(expression, [id])** - creates new pattern and adds it to the collection. Find out more about pattern syntax [here](http://logstash.net/docs/1.4.2/filters/grok) and about regular expression syntax [here](http://www.geocities.jp/kosako3/oniguruma/doc/RE.txt)\n\n* **GrokCollection.getPattern(id)** - returns existing pattern `GrokPattern`\n\n* **GrokCollection.load(filePath, callback)** - asynchronously loads patterns from file. Callback is `function(err)`.\n\n* **GrokCollection.loadSync(filePath)** - loads patterns from file and returns number of newly loaded patterns `number`\n\n* **GrokPattern.parse(str, callback)** - parses string using corresponding pattern. Callback function receives optional *error* and resulting object *result*: `function(error, result)`\n\n* **GrokPattern.parseSync(str)** - parses string using corresponding pattern and returns resulting object `object`\n\n## License \n**ISC License (ISC)**\n\nCopyright (c) 2015, Andrey Chausenko \u003candrey.chausenko@gmail.com\u003e\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\nWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\nANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\nWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\nACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\nOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeh01der%2Fnode-grok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeh01der%2Fnode-grok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeh01der%2Fnode-grok/lists"}