{"id":13932988,"url":"https://github.com/logstash-plugins/logstash-filter-example","last_synced_at":"2025-07-19T16:32:24.715Z","repository":{"id":25592577,"uuid":"29027180","full_name":"logstash-plugins/logstash-filter-example","owner":"logstash-plugins","description":"Example filter plugin. This should help bootstrap your effort to write your own filter plugin!","archived":false,"fork":false,"pushed_at":"2021-11-08T10:07:21.000Z","size":34,"stargazers_count":20,"open_issues_count":2,"forks_count":52,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-08-08T21:19:45.361Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/logstash-plugins.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-09T17:27:29.000Z","updated_at":"2024-05-19T20:39:26.000Z","dependencies_parsed_at":"2022-08-24T09:50:44.236Z","dependency_job_id":null,"html_url":"https://github.com/logstash-plugins/logstash-filter-example","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logstash-plugins%2Flogstash-filter-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logstash-plugins%2Flogstash-filter-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logstash-plugins%2Flogstash-filter-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logstash-plugins%2Flogstash-filter-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/logstash-plugins","download_url":"https://codeload.github.com/logstash-plugins/logstash-filter-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226643884,"owners_count":17662968,"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","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":"2024-08-07T21:01:26.538Z","updated_at":"2024-11-26T23:30:51.701Z","avatar_url":"https://github.com/logstash-plugins.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Logstash Plugin\n\n[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-example.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-example)\n\nThis is a plugin for [Logstash](https://github.com/elastic/logstash).\n\nIt is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.\n\n## Documentation\n\nLogstash provides infrastructure to automatically build documentation for this plugin. We provide a template file, index.asciidoc, where you can add documentation. The contents of this file will be converted into html and then placed with other plugin documentation in a [central location](http://www.elastic.co/guide/en/logstash/current/).\n\n- For formatting config examples, you can use the asciidoc `[source,json]` directive\n- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide\n\n## Need Help?\n\nNeed help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.\n\n## Developing\n\n### 1. Plugin Developement and Testing\n\n#### Code\n- To get started, you'll need JRuby with the Bundler gem installed.\n\n- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).\n\n- Install dependencies\n```sh\nbundle install\n```\n\n#### Test\n\n- Update your dependencies\n\n```sh\nbundle install\n```\n\n- Run tests\n\n```sh\nbundle exec rspec\n```\n\n### 2. Running your unpublished Plugin in Logstash\n\n#### 2.1 Run in a local Logstash clone\n\n- Edit Logstash `Gemfile` and add the local plugin path, for example:\n```ruby\ngem \"logstash-filter-awesome\", :path =\u003e \"/your/local/logstash-filter-awesome\"\n```\n- Install plugin\n```sh\n# Logstash 2.3 and higher\nbin/logstash-plugin install --no-verify\n\n# Prior to Logstash 2.3\nbin/plugin install --no-verify\n\n```\n- Run Logstash with your plugin\n```sh\nbin/logstash -e 'filter {awesome {}}'\n```\nAt this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.\n\n#### 2.2 Run in an installed Logstash\n\nYou can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:\n\n- Build your plugin gem\n```sh\ngem build logstash-filter-awesome.gemspec\n```\n- Install the plugin from the Logstash home\n```sh\n# Logstash 2.3 and higher\nbin/logstash-plugin install --no-verify\n\n# Prior to Logstash 2.3\nbin/plugin install --no-verify\n\n```\n- Start Logstash and proceed to test the plugin\n\n## Contributing\n\nAll contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.\n\nProgramming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying \"send patches or die\" - you will not see that here.\n\nIt is more important to the community that you are able to contribute.\n\nFor more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogstash-plugins%2Flogstash-filter-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flogstash-plugins%2Flogstash-filter-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogstash-plugins%2Flogstash-filter-example/lists"}