Packages

Packages enable you to share sets of components — parsers, queries, dashboards — by collecting them together into a single package. Users can create packages, and Humio provides a marketplace for sharing and distributing Packages with the community.

For instance, as an nginx user, the humio/nginx package provides you with a collection of parsers, queries, and alert template that help you get started working with nginx logs.

Package Types

There are two types of packages:

  • Libraries define a set of components that you can use as templates for creating new components within Humio.

  • Applications contain components that can be deployed within your Humio environment.

Packages can contain parsers, queries, dashboards, actions, and alerts.

Applications

Applications are bundles of components that provide a set of functionality to support the use of Humio for a specific logging environment or application. Using a package, you can install a collection of dashboards and parsers designed to work and extract the data and display it effectively for a given technology stack.

Using a package is a great way to populate your Humio deployment with the tools required to support the rest of your infrastructure. For example, you obtain an effective and ready-to-use collection

Applications provide a degree of plug-and-play functionality for a technology stack, or at least a solid starting point that you can customize to fit your needs.

They are the best way to get started using Humio because you don’t need to know how to e.g. write a parser to get started ingesting data for a standard technology.

Installing an app will add a bunch of new dashboards, parsers, queries, etc to your repository. Unlike a template library an application actually creates and maintains dashboards, alerts etc. and these are visible alongside your own items in e.g. the Dashboard List or under Alerts where they are displayed separate from other components categorized by the package they come from.

Put plainly an app is a bundle of dashboards, parsers, queries and so on that can be installed into your repository all at once.

Libraries

A package library is a collection of component templates and extensions, for example dashboards, saved queries, alerts, or parsers. After installing a library within Humio these templates will be available as the basis for creating a new item.

Libraries do not provide components that provide functionality, only templates for building new components that you can customise to suit your requirements.

You can use libraries to share common functionality across several repositories. For example, you could maintain a custom package that provides useful queries and templates that match your company requirements for the metrics you need to monitor. Installing the library provides the core functionality which is then customised for the data in each repository.

Creating Custom Packages

You can also create custom packages either based on components created in Humio, or by writing them manually. You can use these to maintain your Humio components in source control or to share your work with others.

Custom packages can be published to the central Marketplace, or you can share them in whatever way you find best without having to publish them to everyone else.

You can find out more about creating and maintaining your own packages in the Creating a Package documentation page.

Publishing Packages

In order to publish your package you just have to make it available as a Zip file, and publish the URL. A good place to tell people about your package is Humio’s Slack community.

You can make an open source Github repository on and people can install it using Humio’s CLI or by downloading the Zip archive of your repository.