Plugins 〉Cribl Search
Cribl Search
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
Install this plugin to your Grafana deployment: Add this plugin to your Grafana deployment to enable data source creation.
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.
Click "Explore" and start running adhoc queries: You can run any Cribl Search query right there in Grafana.
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:
Navigate to the Cribl cloud and select your organization.
Look for the API Credentials section.
Copy your client ID and client secret.
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.
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:
- Join the conversation at the Cribl community: https://cribl.io/community/
- Dig deeper with our documentation: https://docs.cribl.io/
- Community Slack cribl-community.slack.com
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
.h4 . .mb-0 }
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing Cribl Search on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Data Source
Use the grafana-cli tool to install Cribl Search from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Configure the Data Source
Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.
Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.
To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.
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}
.