{"id":19788335,"url":"https://github.com/graylog2/graylog-plugin-sample","last_synced_at":"2025-05-01T00:30:58.237Z","repository":{"id":4834756,"uuid":"50035299","full_name":"Graylog2/graylog-plugin-sample","owner":"Graylog2","description":"Sample plugin for Graylog 2.0 including web ui parts.","archived":false,"fork":false,"pushed_at":"2024-02-07T18:24:29.000Z","size":56,"stargazers_count":11,"open_issues_count":1,"forks_count":14,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-04-15T00:39:06.316Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Graylog2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-01-20T14:27:28.000Z","updated_at":"2023-08-05T14:14:01.000Z","dependencies_parsed_at":"2023-07-05T17:01:13.344Z","dependency_job_id":null,"html_url":"https://github.com/Graylog2/graylog-plugin-sample","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Graylog2%2Fgraylog-plugin-sample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Graylog2%2Fgraylog-plugin-sample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Graylog2%2Fgraylog-plugin-sample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Graylog2%2Fgraylog-plugin-sample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Graylog2","download_url":"https://codeload.github.com/Graylog2/graylog-plugin-sample/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224229140,"owners_count":17277137,"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-11-12T06:26:54.236Z","updated_at":"2024-11-12T06:26:54.784Z","avatar_url":"https://github.com/Graylog2.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sample Plugin for Graylog\n\nThis repository is intended to be used to follow the [Plugin API documentation](https://go2docs.graylog.org/5-1/what_more_can_graylog_do_for_me/plugins.html) for Graylog.\nIt contains no useful functionality beyond illustrating the various extension points one can use for customizing and extending Graylog. \n\n__Important: Do not use this repository as a boilerplate for a new graylog plugin.\\\nPlease use the maven archetype to create a plugin skeleton, as [described in the Plugin API documentation](https://go2docs.graylog.org/5-1/what_more_can_graylog_do_for_me/plugins.html#WritingPlugins).__\n\n\n[![Build Status](https://travis-ci.org/Graylog2/graylog-plugin-sample.svg?branch=master)](https://travis-ci.org/Graylog2/graylog-plugin-sample)\n\n__Use this paragraph to enter a description of your plugin.__\n\n**Required Graylog version:** 5.1 and later\n\nInstallation\n------------\n\n[Download the plugin](https://github.com/Graylog2/graylog-plugin-sample/releases)\nand place the `.jar` file in your Graylog plugin directory. The plugin directory\nis the `plugins/` folder relative from your `graylog-server` directory by default\nand can be configured in your `graylog.conf` file.\n\nRestart `graylog-server` and you are done.\n\nDevelopment\n-----------\n\nYou can improve your development experience for the web interface part of your plugin\ndramatically by making use of hot reloading. To do this, do the following:\n\n* `git clone https://github.com/Graylog2/graylog2-server.git`\n* `cd graylog2-server/graylog2-web-interface`\n* `ln -s $YOURPLUGIN plugin/`\n* `npm install \u0026\u0026 npm start`\n\nUsage\n-----\n\n__Use this paragraph to document the usage of your plugin__\n\n\nGetting started\n---------------\n\nThis project is using Maven 3 and requires Java 7 or higher.\n\n* Clone this repository.\n* Run `mvn package` to build a JAR file.\n* Optional: Run `mvn jdeb:jdeb` and `mvn rpm:rpm` to create a DEB and RPM package respectively.\n* Copy generated JAR file in target directory to your Graylog plugin directory.\n* Restart the Graylog.\n\nPlugin Release\n--------------\n\nWe are using the maven release plugin:\n\n```\n$ mvn release:prepare\n[...]\n$ mvn release:perform\n```\n\nThis sets the version numbers, creates a tag and pushes to GitHub. Travis CI will build the release artifacts and upload to GitHub automatically.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraylog2%2Fgraylog-plugin-sample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraylog2%2Fgraylog-plugin-sample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraylog2%2Fgraylog-plugin-sample/lists"}