Plugins 〉Cribl Search


Developer

Cribl, Inc.

Sign up to receive occasional product news and updates:



Data Source
commercial

Cribl Search

  • Overview
  • Installation
  • Change log
  • Related content

Grafana Cribl Plugin

Welcome to the Grafana Cribl plugin README. This plugin empowers you to create Grafana data sources pulling data directly from Cribl Search, with the resulting data visualizations offering insights like never before. Let's get into how to set this up.

How It Works

  1. Install this plugin to your Grafana deployment: Add this plugin to your Grafana deployment to enable data source creation.

  2. Create a data source in Grafana using this plugin: Configure this data source using your Cribl client ID and client secret. Details on how to acquire these can be found in the next section.

  3. Click "Explore" and start running adhoc queries: You can run any Cribl Search query right there in Grafana.

  4. Use saved/scheduled searches to make your dashboards faster: Save a search in Cribl and configure it to run on a scheduled basis. Make a note of this search's ID. Learn how to set up a scheduled search with this guide. In Grafana, the data source will fetch the latest results based on the search ID you select.

That's the nutshell of the plugin's workings!

Getting Your Cribl Client ID and Client Secret

To set up the data source in Grafana, you will need to input your Cribl client ID and client secret. Here's how you find these:

  1. Navigate to the Cribl cloud and select your organization.

  2. Look for the API Credentials section.

  3. Copy your client ID and client secret.

  4. Back in Grafana, while adding a data source, paste the copied Cribl organization URL (e.g. https://main-{your-org-id}.cribl.cloud) and the credentials.

  5. Click on "Save and Test" to ensure everything is working correctly.

Support & Feedback

We're always looking forward to hearing about your experience with the plugin. If you have any questions, suggestions, or feedback, don't hesitate to reach out:

Installing Cribl Search on Grafana Cloud:

For more information, visit the docs on plugin installation.

Changelog

1.0.0

Initial release. Provides basic data source functionality of fetching saved/scheduled search results from Cribl.

1.1.0

  • Add support for using dashboard variables in Cribl Search queries.
  • Add support for Grafana alerting.

1.1.1

  • Remove unnecessary logic from CheckHealth
  • Properly close HTTP response body in all cases

1.1.2

  • Query timeout is now configurable.
  • Add info & doc link to the timeout error message to encourage the user to leverage scheduled search.
  • Upon timeout, cancel the query on the Cribl Search side.
  • Allow saved search ID to be composed using dashboard ${variables}.