Dashboards
Learn about how to create custom Spyderbat dashboards and dashboard cards using Athena Search or existing dashboard templates, as well as how to share and manage access to the custom dashboards.
Last updated
Learn about how to create custom Spyderbat dashboards and dashboard cards using Athena Search or existing dashboard templates, as well as how to share and manage access to the custom dashboards.
Last updated
© SPYDERBAT, Inc., All Rights Reserved
Published: July 20, 2023
If you are looking for information on out-of-the-box Spyderbat Dashboards, please check out All About Spyderbat Dashboards and Spyderbat Dashboard Categories articles.
In addition to a number of dashboard cards in 7 different default dashboard categories, Spyderbat users with adequate permissions are able to create custom dashboard cards and categories for their organization in the Spyderbat UI.
In this article we will discuss:
Creating a brand new dashboard card from scratch
Creating a new dashboard card off an existing dashboard card
Managing custom dashboards and dashboard cards
Spyderbat allows you to create custom dashboard cards based on your specific search queries. Follow the steps below to create a custom dashboard card:
Access the Search Section:
In the top-left corner of the Spyderbat interface, navigate to the Search section.
The search section includes a list of popular queries to get started with.
Build Your Search Query:
The search section provides predefined categories such as System, Operation, Security, and Kubernetes (K8s). Each category offers a variety of search objects/Schemas with relevant fields.
For example, if you're searching for Kubernetes Nodes, choose Node from the Kubernetes category. Click on Open Query Builder to start building your query.
Select the fields that you need (e.g., Cluster Name, Node Name, etc.) available from the list. You can add additional rows and conditions to refine the query.
You can refer the Search doc here on how to write Search queries.
Set Filters and Execute the Query:
Once your query is built, click on Send to Search.
Apply the appropriate time filter (e.g., last 24 hours, custom date range).
Click Search to run the query and display the results.
Save the Query as a Dashboard Card:
After the results are displayed, click on Save Dashboard Card.
You can either add the results to an existing dashboard card or create a New Dashboard Card. Both these options are available in the drop down list.
Click Create to finalize and add your custom card to the dashboard.
Your custom dashboard card will now be available in the Dashboard section, reflecting real-time data based on the query results.
Perhaps, an easier way to create custom dashboard cards is by tweaking some of the existing out-of-the-box cards that are available in the Spyderbat UI.
For example, let’s take a look at one of the Security cards named “Recent Spydertraces with Score >50”. Assume you would like to prioritize your focus on Spydertraces with much higher severity scores of 100+. The quickest way to build out a dashboard card like that would be to take the existing card and click “Run In Search”:
You can see the full query and can easily find the parameter to modify, which would be the score:
Once you update the score value to “>100”, you can save this as a new Dashboard Card and place it into your custom Dashboard category of choice to be easily accessible. You can also set notifications to be alerted if there is data pulling into that custom card.
Use this method for minor query changes, else start building your query from Search section.
One thing to keep in mind: you cannot edit a query in the custom dashboard card. If you saved a card and then decided to further tweak it, you will need to follow the steps outlined above: select a card you wish to modify, click “Run in Search”, update the query as desired, and save as a new dashboard card.
Once you have created a number of custom dashboards and dashboard cards, they will be visible to all the users in your organization in the Spyderbat UI. Users with adequate permissions will be able to rename dashboards and cards, add new dashboard cards to customer dashboards created by other users and delete dashboard cards and entire dashboards.
All dashboard management options can be accessed by clicking on the “pencil” icon in the upper right corner of the custom Dashboard, you wish to modify:
Here you can do a number of things:
See if you have configured notifications for any of the cards in your custom dashboard.
Hide a dashboard card from view by using the on/off slider on the left side of the dashboard card name
Delete a dashboard card by clicking the “x” icon (Note: you will not be prompted to confirm your deletion, but it won’t be applied until you click “Save” in the lower right corner of the Edit window)
Rename a dashboard card by clicking a “pencil” icon and then a “save” icon that looks like a floppy disk
Change the order of appearance for the dashboard cards within the dashboard by dragging and dropping the “=” on the right hand side of the respective dashboard card names
Rename the Dashboard category by clicking the ellipsis (three vertical dots) and selecting the “Edit Dashboard Name” option
All these changes will only apply after you click “Save” and will be in effect for all users in your organization, as stated on the next screen:
You can also delete an entire dashboard with all the cards in it by selecting “Delete Dashboard + Cards”, in which case you will need to confirm your decision:
Custom user-created dashboards will appear in the front positions of the category menu, pushing all default out-of-the-box categories to the right. The order of dashboard categories cannot be modified at this time, and categories cannot be hidden from view.
