Graylog Marketplace
  • 23 Sep 2021
  • 3 Minutes to read
  • Dark
    Light

Graylog Marketplace

  • Dark
    Light

The Graylog Marketplace is the central directoryof add-ons for Graylog. It contains plugins, content packs, GELF libraries andmore content built by Graylog developers and community members.

marketplace.png

GitHub integration

The Marketplace is deeply integrated with GitHub. You sign-in with your GitHubaccount if you want to submit content and only have to select an existingrepository to list on the Marketplace.

From there on you manage your releases and code changes in GitHub. The Marketplacewill automatically update your content.

There is no need to sign-in if you only want to browse or download content.

General best practices

README content

We kindly ask you to provide an as descriptive as possible READMEfile with yoursubmission. Thisfile will be displayed on the Marketplace detail page and should provide the followinginformation:

  • What is it.
  • Why would you want to use it? (Use cases)
  • Do you have to register somewhere to get for example an API token?
  • How to install and configure it.
  • How to use it in a Graylog context.

Take a look at the Splunk plug-in as an example.

The README supports Markdown for formatting. You cannot submit content that does not contain a READMEfile.

License

You cannot submit content that does not contain a LICENSEor COPYINGfile.We recommend to consult ChooseALicense.com if you areunsure which license to use.

4 Types of Add-Ons

Plug-Ins: Code that extends Graylog to support a specific use case that it doesn’t support out of the box.

Content Pack: A file that can be uploaded into your Graylog system that sets up streams, inputs, extractors, dashboards, etc. to support a given log source or use case.

GELF Library: A library for a programming language or logging framework that supports sending log messages in GELF format for easy integration and pre-structured messages.

Other Solutions: Any other content or guide that helps you integrate Graylog with an external system or device. For example, how to configure a specific device to support a format Graylog understands out of the box.

Contributing plug-ins

You created a Graylog plugin and want to list it in theMarketplace? This is great. Here are the simple steps to follow:

  1. Create a GitHub repository for your plugin
  2. Include a README and a LICENSE file inthe repository.
  3. Push all your code to the repository.
  4. Create a GitHub release and give it the name of the plugin version. For example 0.1. TheMarketplace will always show and link the latest version. You can uploadas many release artifacts as you want here. For example the .jarfiletogether with DEBand RPMfiles. The Marketplace will link to thedetail page of a release for downloads.
  5. Submit the repository to the Marketplace

Contributing content packs

Graylog content packs can be shared on the Marketplace by following these steps:

  1. Download a Graylog content pack from the Graylog Web Interface and save thegenerated JSON in a file called content_pack.json.
  2. Create a GitHub repository for your content pack
  3. Include a README and a LICENSE file inthe repository.
  4. Include the content_pack.jsonfile in the root of your GitHub repository.
  5. Submit the repository to the Marketplace

Contributing GELF libraries

A GELF library can be added like this:

  1. Create a GitHub repository for your GELF library.
  2. Include a README and a LICENSE file inthe repository.
  3. Describe where to download and how to use the GELF library in the README
    .

Contributing other content

You want to contribute content that does not really fit into the other categoriesbut describes how to integrate a certain system or make it send messages to Graylog?

This is how you can do it:

  1. Create a GitHub repository for your content
  2. Include a README and a LICENSE file inthe repository.
  3. All content goes into the README

Was this article helpful?