title | description | ms.topic | author | ms.author | ms.reviewer | ms.date |
---|---|---|---|---|---|---|
Log queries in Azure Monitor |
This reference information for Kusto Query Language used by Azure Monitor includes elements specific to Azure Monitor and elements not supported in Azure Monitor log queries. |
conceptual |
guywild |
guywild |
ilanawaitser |
05/26/2024 |
Azure Monitor Logs is based on Azure Data Explorer, and log queries are written by using the same Kusto Query Language (KQL). This rich language is designed to be easy to read and author, so you should be able to start writing queries with some basic guidance.
Areas in Azure Monitor where you'll use queries include:
- Log Analytics: Use this primary tool in the Azure portal to edit log queries and interactively analyze their results. Even if you intend to use a log query elsewhere in Azure Monitor, you'll typically write and test it in Log Analytics before you copy it to its final location.
- Log search alert rules: Proactively identify issues from data in your workspace. Each alert rule is based on a log query that's automatically run at regular intervals. The results are inspected to determine if an alert should be created.
- Workbooks: Include the results of log queries by using different visualizations in interactive visual reports in the Azure portal.
- Azure dashboards: Pin the results of any query into an Azure dashboard, which allows you to visualize log and metric data together and optionally share with other Azure users.
- Azure Logic Apps: Use the results of a log query in an automated workflow by using a logic app workflow.
- PowerShell: Use the results of a log query in a PowerShell script from a command line or an Azure Automation runbook that uses
Invoke-AzOperationalInsightsQuery
. - Log Analytics Query API: Retrieve log data from the workspace from any REST API client. The API request includes a query that's run against Azure Monitor to determine the data to retrieve.
- Azure Monitor Query client libraries: Retrieve log data from the workspace via an idiomatic client library for the following ecosystems:
-
For an example of how to implement the Azure Monitor Query client library for Python, see Analyze data in Azure Monitor Logs using a notebook.
The best way to get started learning to write log queries by using KQL is to use available tutorials and samples:
- Log Analytics tutorial: Tutorial on using the features of Log Analytics, which is the tool that you'll use in the Azure portal to edit and run queries. It also allows you to write simple queries without directly working with the query language. If you haven't used Log Analytics before, start here so that you understand the tool you'll use with the other tutorials and samples.
- KQL tutorial: Guided walk through basic KQL concepts and common operators. This is the best place to start to come up to speed with the language itself and the structure of log queries.
- Example queries: Description of the example queries available in Log Analytics. You can use the queries without modification or use them as samples to learn KQL.
Documentation for KQL, including the reference for all commands and operators, is available in the Azure Data Explorer documentation. Even as you get proficient at using KQL, you'll still regularly use the reference to investigate new commands and scenarios that you haven't used before.
Although Azure Monitor uses the same KQL as Azure Data Explorer, there are some differences. The KQL documentation will specify those operators that aren't supported by Azure Monitor or that have different functionality. Operators specific to Azure Monitor are documented in the Azure Monitor content. The following sections list the differences between versions of the language for quick reference.
- cluster()
- cursor_after()
- cursor_before_or_at()
- cursor_current(), current_cursor()
- database()
- current_principal()
- extent_id()
- extent_tags()
The following operators support specific Azure Monitor features and aren't available outside of Azure Monitor:
- Walk through a tutorial on writing queries.
- Access the complete reference documentation for KQL.