Packages

Tools, query, dashboards and widgets to extend the utility and expand your query repertoire

Packages provide a way to bundle LogScale assets such as parsers, queries, dashboards and alerts into a Package file that can then be shared with others. Packages can be distributed and installed manually by uploading the Package file to LogScale from the LogScale UI or CLI. This provides customers with an efficient and easy way to distribute and configure LogScale assets.

The LogScale Marketplace is accessed from within the LogScale UI and is where end-users can browse a selection of pre-built packages and can install them directly into their LogScale service. Anyone can build a LogScale package and submit it to LogScale for inclusion in the marketplace. The marketplace provides a way for LogScale, customers and partners to share LogScale assets, which saves time and encourages people to find new ways to do more with LogScale. LogScale is keen that all packages can be freely used and edited by anyone to fuel creativity in the spirit of the open source community.

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 LogScale.

  • Applications include the templates, but also install collection of the library components deployed within your LogScale environment.

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

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 LogScale these templates will be available as the basis for creating a new component. Libraries do not provide components that provide functionality, only templates for building new components that you can customize to suit your requirements.

Figure 172. Package Structure


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

Applications

Applications are bundles of components that provide a set of functionality to support the use of LogScale 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.

graph LR; subgraph "Package: Application" S2[Version] S1[Readme] subgraph "Templates" T1["Dashboards"] T2["Saved Queries"] T3["Parsers"] T4["Alerts"] end subgraph " " A1["Dashboards"] A2["Saved Queries"] A3["Parsers"] A4["Alerts"] T1 -.-> A1 T2 -.-> A2 T3 -.-> A3 T4 -.-> A4 end end

Figure 173. Packages - Applications


Using a package is a great way to populate your LogScale deployment with the tools required to support the rest of your infrastructure. For example, a package might contain all of the queries, widgets and dashboards required to manage and monitor your infrastructure, without you needing to determine or develop your own set. Application Packages can provide a solid starting point that you can customize to fit your needs.

Unlike a package library, an application actually creates and maintains the dashboards , alerts etc to support the events from the monitored application. These components 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.

Creating Packages

You can create your own packages based on components available in LogScale, including by creating or using your own queries, widgets and components. This functionality enables you to create a standard set of components that you can then use on your LogScale clusters, or to distribute to others.

Custom packages can be shared as a Zip file with other users, or they can be published to the Package Marketplace.

For more information about creating and maintaining packages, see Creating a Package.

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 LogScale's Slack community.

You can also the share the package on a repository service, for example Github, where it can be installed using Command-Line Interface (humioctl) or by downloading the Zip archive of your repository. See Developer Guidelines for Packages for more infromation on creating packages for the marketplace.