title | description | author | ms.author | ms.topic | ms.date | ms.custom |
---|---|---|---|---|---|---|
Convert dashboards to Azure Monitor Workbooks | Microsoft Docs |
Learn how to review, planning and migrate your current workbooks to Azure Workbooks. |
limwainstein |
lwainstein |
how-to |
05/03/2022 |
ignite-fall-2021 |
Dashboards in your existing SIEM will convert to Azure Monitor Workbooks, the Microsoft Sentinel adoption of Azure Monitor Workbooks, which provides versatility in creating custom dashboards.
This article describes how to review, plan, and convert your current workbooks to Azure Monitor Workbooks.
Review these considerations when designing your migration.
- Discover dashboards. Gather information about your dashboards, including design, parameters, data sources, and other details. Identify the purpose or usage of each dashboard.
- Select. Don’t migrate all dashboards without consideration. Focus on dashboards that are critical and used regularly.
- Consider permissions. Consider who are the target users for workbooks. Microsoft Sentinel uses Azure Workbooks, and access is controlled using Azure Role Based Access Control (RBAC). To create dashboards outside Azure, for example for business execs without Azure access, using a reporting tool such as Power BI.
After reviewing your dashboards, do the following to prepare for your dashboard migration:
- Review all of the visualizations in each dashboard. The dashboards in your current SIEM might contain several charts or panels. It's crucial to review the content of your short-listed dashboards to eliminate any unwanted visualizations or data.
- Capture the dashboard design and interactivity.
- Identify any design elements that are important to your users. For example, the layout of the dashboard, the arrangement of the charts or even the font size or color of the graphs.
- Capture any interactivity such as drilldown, filtering, and others that you need to carry over to Azure Monitor Workbooks.
- Identify required parameters or user inputs. In most cases, you need to define parameters for users to perform search, filtering, or scoping the results (for example, date range, account name and others). Hence, it's crucial to capture the details around parameters. Here are some of the key points to help you with collecting the parameter requirements:
- The type of parameter for users to perform selection or input. For example, date range, text, or others.
- How the parameters are represented, such as drop-down, text box, or others.
- The expected value format, for example, time, string, integer, or others.
- Other properties, such as the default value, allow multi-select, conditional visibility, or others.
Perform the following tasks in Azure Workbook and Microsoft Sentinel to convert your dashboard.
Azure Monitor workbooks are compatible with a large number of data sources. In most cases, use the Azure Monitor Logs data source and use Kusto Query Language (KQL) queries to visualize the underlying logs in your Microsoft Sentinel workspace.
In this step, you mainly work with KQL to visualize your data. You can construct and test your queries in the Microsoft Sentinel Logs page before converting them to Azure Monitor workbooks. Before finalizing your KQL queries, always review and tune the queries to improve query performance. Optimized queries:
- Run faster, reduce the overall duration of the query execution.
- Have a smaller chance of being throttled or rejected.
Learn how to optimize KQL queries:
- KQL query best practices
- Optimize queries in Azure Monitor Logs
- Optimizing KQL performance (webinar)
Create a workbook, update the workbook, or clone an existing workbook so that you don’t have to start from scratch. Also, specify how the data or visualizations will be represented, arranged and grouped. There are two common designs:
- Vertical workbook
- Tabbed workbook
By the time you arrive at this stage, you should have identified the required parameters. With parameters, you can collect input from the consumers and reference the input in other parts of the workbook. This input is typically used to scope the result set, to set the correct visualization, and allows you to build interactive reports and experiences.
Workbooks allow you to control how your parameter controls are presented to consumers. For example, you select whether the controls are presented as a text box vs. drop down, or single- vs. multi-select. You can also select which values to use, from text, JSON, KQL, or Azure Resource Graph, and more.
Review the supported workbook parameters. You can reference these parameter values in other parts of workbooks either via bindings or value expansions.
Workbooks provide a rich set of capabilities for visualizing your data. Review these detailed examples of each visualization type.
Once you've saved your workbook, specify the parameters, if any exist, and validate the results. You can also try the auto refresh or the print feature to save as a PDF.
In this article, you learned how to convert your dashboards to Azure workbooks.
[!div class="nextstepaction"] Update SOC processes