Use the CIM to create reports and dashboards
If you are working with data that has already been normalized to the Common Information Model, you can use the CIM data models to generate visualizations, reports, and dashboards the same way you would use any other data model in the Splunk platform.
Your data is normalized if you or someone else in your organization have completed the normalizing steps described in Use the CIM to normalize data at search time, or you are using an add-on that normalizes data to the CIM data models.
For example, you want to create a report to monitor authorization events on your systems. Both the Authentication and Change Analysis data models contain authorization-relevant fields. You can create reports using search or using Pivot. This example uses Pivot.
Start by opening the Change Analysis data model in Pivot. You can open a data model in Pivot two different ways, depending on if you use the Splunk Datasets Add-on or not.
- If you use Splunk Cloud or you have the Splunk Datasets Add-on, open a data model in Pivot with the following steps:
- In the Search and Reporting App, click Datasets.
- Locate the Change Analysis > All Changes > Account Management data model and datasets.
- Click > to review the fields available in the dataset of the data model.
- Click Explore > Visualize with Pivot to open Pivot to explore the data model and dataset.
- If you do not have the Splunk Datasets Add-on, or do not use Splunk Cloud, you can open a data model in Pivot with the following steps:
- In the Search and Reporting App, click Pivot.
- Select the Change Analysis data model. Observe that it has a child dataset called Account Management.
- Click > next to the Account Management dataset and its child datasets to browse the available events and fields contained in the model.
Then, create a report in Pivot. This report uses the Account Management dataset of the Change Analysis data model.
For example, to see the number of account lockouts over the past hour, create a report as follows.
- In Pivot, select the Area Chart option.
- Set the time range to Last 60 minutes.
- If the
dest_categoryfield is in use, you can filter based on the destination category to review account lockouts only on specifically-categorized machines. Otherwise, leave the filter blank.
- Leave the X-axis as the default of time.
- Select a field of
is_Account_Lockoutsfor the Y-axis.
- (Optional) Modify additional settings.
- Select Save As > Report to save the chart as a report.
After creating the report, you can add the report to a dashboard and adjust the permissions so that others can view it.
Resources for using Pivot with data models
To learn more about using Pivot with data models, use the following resources.
- See About Data Models in the Splunk Enterprise Knowledge Manager Manual.
- See the Introduction to Pivot in the Splunk Enterprise documentation.
Use the Data Model Audit and Predictive Analytics dashboards
You can also use the dashboards included with the Common Information Model to monitor your data model accelerations and searches. The Common Information Model includes two dashboards:
- The Data Model Audit dashboard helps you analyze the performance of your data model accelerations.
- The Predictive Analytics dashboard helps you identify outliers in your data based on the predictive analysis functionality in the Splunk platform.
Access these dashboards by going to the Search and Reporting app. From there, click Dashboards to view your list of dashboards. When the Splunk Common Information Model Add-on is installed, these two dashboards appear in the list.
For more detail on the data model audit dashboard, see Check the status of data model accelerations in this manual. For more information on the Predictive Analytics dashboard, see Predictive Analytics dashboard in Use Splunk Enterprise Security. Splunk Enterprise Security is not required for these dashboards to work.
Use the CIM to validate your data
Use the common action model to build custom alert actions
This documentation applies to the following versions of Splunk® Common Information Model Add-on: 4.9.0, 4.9.1, 4.10.0, 4.11.0