Welcome to GoatSearch! The goatsearch command allows you to run Cribl KQL searches through a Splunk search bar to view search results, add to dashboards, and use in alerts!
Unsure how to use GoatSearch? Hey, we gotchu! We've built the GoatSearch Explorer dashboard to guide crafting a goatsearch. Simply configure your tenant, select your dataset, and let Explorer guide your syntax!
Need help configuring your Cribl tenant? Check out our GoatSearch Credentials tutorial! The tutorial is also linked from the setup page.
Want to see the new features in 1.1.0? Check our GoatSearch 1.1.0 Release Notes
Here is a list of the goatsearch options available as of version 1.1.0:
query: This string contains the KQL query to execute. If query and sid are missing, goatsearch returns a list of available datasets.sid: Instead of running a new search, sid allows you to pass a Cribl Search ID to retrieve results from an existing search. sid will take priority over query if both are passed.tenant: Specifies the tenant to query. Tenants must be configured on the Setup page, and omitting tenant will use the default - if configured.workspace: Specifies the workspace to query. If omitted, workspace defaults to main.earliest: Specifies the relative time modifier or absolute epoch time of the earliest event to retrieve. If omitted, defaults to the time range picker. Must be Cribl KQL format - not SPL.latest: Specifies the relative time modifier or absolute epoch time of the latest event to retrieve. If omitted, defaults to the time range picker. Must be Cribl KQL format - not SPL.sample: Specifies the sample ratio. For a 1:100 sample ratio, use 100. Defaults to 1.page: Specifies the page size for API calls. Only tune this if you are on a high-latency network.retry: Specifies the number of search retries before giving up if execution or queuing fails. Retries are separated by a hard-limit of 5 seconds. Defaults to 10.debug: Boolean - see how the sausage is made. Maybe wish you hadn't. Debug messages are assigned sourcetype goatsearch:jsonThe GoatSearch package also has a goatpass command. It handles passwords (client secrets) and that's all we're gonna tell you. If you want to figure it out be our guest - however long that takes will be infinitely longer than just letting it do its thing.
Release notes video walkthrough
Enhancements:
- Applies Cribl parser/field extractions to search results
- Allows searching by SID
- goatsearch command now respects earliest and latest parameters
- Better processing of KQL transforming commands (summarize, project, top-talkers)
- Dataset previews on GoatSearch Explorer
- Roles/Capabilities to use GoatSearch and configure tenants (goatsearch_user, goatsearch_admin)
- goatsearch command now respects retry keyword to buffer multiple concurrent searches
Bug Fixes
- Corrects an issue where certain expected metadata fields were not present in the Cribl Search results
- Corrects an issue where searches fail inexplicably due to Cribl Search limits
- Corrects an issue where multiple Cribl Searches are instantiated but only one actioned
The official 1.0.0 release of GoatSearch is here bringing you:
Features:
- Configured datasets now appear on GoatSearch Explorer
- Default settings for tenant and workspace
- Events on the Splunk search timeline
- Dropdowns for sample ratio and API page size
Bugfixes:
- Search icon from settings now properly links to and populates GoatSearch Explorer
- Cancel button in settings now works 😅
- Chased off a little debug token from he Explorer
- At times, buttons would not reset on settings when a no-refresh-needed setting changed
- passwords.conf is now pruned when deleting a GoatSearch tenant.
Initial Release
As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.