-
Notifications
You must be signed in to change notification settings - Fork 228
SUMO-255292 | Apoorv | Add. Azure VM App Doc and Images #5288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
himanshu219
merged 10 commits into
SumoLogic:main
from
Apoorvkudesia-sumologic:AzureVmApp
Apr 22, 2025
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e2c3c3b
SUMO-255292 | Apoorv | Add. Azure VM App Doc and Images
Apoorvkudesia-sumologic 49a0450
SUMO-255292 | Apoorv | Fix PR comments
Apoorvkudesia-sumologic b23b056
Apoorv | Remove extra statement regarding Metric Collection
Apoorvkudesia-sumologic b23b32e
SUMO-255292 | Apoorv | Add. Azure VM Monitors/Alerts
Apoorvkudesia-sumologic ee17639
SUMO-255292 | Apoorv | Fix. Spelling error
Apoorvkudesia-sumologic 7a9412e
minor fixes
JV0812 a717fe1
Update docs/integrations/microsoft-azure/azure-virtual-machine.md
JV0812 2c9331e
Add field creation
Apoorvkudesia-sumologic d52d734
Fix spell check
Apoorvkudesia-sumologic 51d587b
Merge branch 'main' into AzureVmApp
himanshu219 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
155 changes: 155 additions & 0 deletions
155
docs/integrations/microsoft-azure/azure-virtual-machine.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| --- | ||
| id: azure-virtual-machine | ||
| title: Azure Virtual Machine | ||
| description: Learn about the Sumo Logic collection process for the Azure Virtual Machine service. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/microsoft-azure/azure-vm-icon.png')} alt="Thumbnail icon" width="50"/> | ||
|
|
||
|
|
||
| [Azure Virtual Machine](https://learn.microsoft.com/en-us/azure/virtual-machines/) is a virtualized computing environment on Microsoft's cloud platform, Azure, that allows users to run applications and tasks on a dedicated, scalable, and on-demand basis. Azure VM provides scalable computing capacity in the Azure Cloud. You can use Azure VM to launch as many or as few virtual servers as you need, configure security and networking, and manage storage. | ||
|
|
||
| The Sumo Logic app for Azure Virtual Machine allows you to collect your VM instance metrics and display them using predefined dashboards. The app provides dashboards to display analysis of VM instance metrics for CPU, disk, network, cache, and memory. Also, it provides detailed insights into all audit events associated with VM instances and specifically helps identify changes, errors, and user activities. | ||
|
|
||
|
|
||
|
|
||
| ## Log and metric types | ||
|
|
||
| For Azure Virtual Machine, you can collect the following logs and metrics: | ||
|
|
||
| * **Activity logs**. To learn more about the different Activity log category types and schemas collected for Azure Virtual Machine, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/virtual-machines/monitor-vm-reference#activity-log). | ||
| * **Virtual Machine Metrics**. These metrics are available in [Microsoft.Compute/virtualMachines](https://learn.microsoft.com/en-us/azure/virtual-machines/monitor-vm-reference#metrics) namespace. | ||
|
|
||
| For more information on supported metrics and their units, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/virtual-machines/monitor-vm-reference#supported-metrics-for-microsoftcomputevirtualmachines). | ||
|
|
||
| ## Setup | ||
|
|
||
| Azure service sends monitoring data to Azure Monitor, which can then [stream data to Eventhub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/stream-monitoring-data-event-hubs). Sumo Logic supports: | ||
|
|
||
| * Logs collection from [Azure Monitor](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-get-started) using our [Azure Event Hubs source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/). | ||
| * Metrics collection using our [HTTP Logs and Metrics source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/) via Azure Functions deployed using the ARM template. | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| You must explicitly enable diagnostic settings for each Virtual Machine you want to monitor. You can forward logs to the same event hub provided they satisfy the limitations and permissions as described [here](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#destination-limitations). | ||
|
|
||
| When you configure the event hubs source or HTTP source, plan your source category to ease the querying process. A hierarchical approach allows you to make use of wildcards. For example: `Azure/VM/ActivityLogs`, `Azure/VM/Metrics`. | ||
|
|
||
| ### Configure metric rules | ||
|
|
||
| * **Azure Observability Metadata Extraction VMName** | ||
|
|
||
| In case this rule already exists, then no need to create it again. | ||
| ```sql | ||
| Rule Name: AzureObservabilityMetadataExtractionVMName | ||
| ``` | ||
|
|
||
| ```sql title="Metric match expression" | ||
| tenant_name=* namespace=Microsoft.Compute/virtualMachines resource_name=* | ||
| ``` | ||
| | Fields extracted | Metric rule | | ||
| |------------------|----------------| | ||
| | vmname | $resource_name._1 | | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Configure metrics collection | ||
|
|
||
| :::note | ||
| Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive. | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
JV0812 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ::: | ||
|
|
||
| 1. To set up the Azure Metrics source in Sumo Logic, refer to the shared beta documentation. | ||
| 1. In the Sumo Logic Azure Metrics source configuration, configure namespaces as `Microsoft.Compute/virtualMachines` and `Microsoft.Compute/virtualMachineScaleSets`. | ||
| <img src={useBaseUrl('img/integrations/microsoft-azure/azure-virtual-machine-namespaces.png')} alt="Azure Virtual Machine Namespaces" style={{border: '1px solid gray'}} width="500" /> | ||
|
|
||
| ### Configure logs collection | ||
|
|
||
| In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub. | ||
| #### Diagnostic logs | ||
| 1. To set up the Azure Event Hubs source in Sumo Logic, refer to [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/). | ||
| 1. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#create-diagnostic-settings). Perform the steps below for each Azure Virtual Machine namespace that you want to monitor. | ||
| 1. Choose `Stream to an event hub` as the destination. | ||
| 1. Select `allLogs`. | ||
| 1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azure-eventgrid-logs.png')} alt="Azure Event Grid logs" style={{border: '1px solid gray'}} width="800" /> | ||
| 1. Tag the location field in the source with the right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Virtual Machine Tag Location" style={{border: '1px solid gray'}} width="400" /> | ||
|
|
||
| #### Activity Logs | ||
|
|
||
| To collect activity logs, refer to the [Collecting Logs for the Azure Audit App from Event Hub](/docs/integrations/microsoft-azure/audit) section in the Azure Audit documentation. Do not perform this step in case you are already collecting activity logs for a subscription. | ||
| :::note | ||
| Since this source contains logs from multiple regions, make sure that you do not tag this source with the location tag. | ||
| ::: | ||
|
|
||
|
|
||
| ## Installing the Azure Virtual Machine app | ||
|
|
||
| Now that you have set up data collection, install the Azure Virtual Machine Sumo Logic app to use the pre-configured [dashboards](#viewing-the-azure-key-vault-dashboards) that provide visibility into your environment for real-time analysis of overall usage. | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2.md'; | ||
|
|
||
| <AppInstallNoDataSourceV2/> | ||
|
|
||
| ## Viewing the Azure Virtual Machine dashboards | ||
|
|
||
| import ViewDashboards from '../../reuse/apps/view-dashboards.md'; | ||
|
|
||
| <ViewDashboards/> | ||
|
|
||
| ### Overview | ||
|
|
||
| **Azure Virtual Machine - Overview** allows you to monitor and analyze your VM's usage metrics such as VM Availability, CPU usage, read/write ops, cache hits, VM usage, and average latencies. Gain insights into the performance of your VMs. | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Overview.png')} alt="Azure Key Vault - Overview dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
|
|
||
| ### OS/Disk | ||
|
|
||
| **Azure VM - OS/Disk** dashboard provides details on the operational activities and status of your Azure VM OS and Data disks | ||
|
|
||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Operations-Overview.png')} alt="Azure Key Vault - Operations Overview dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
|
|
||
| ### Network | ||
|
|
||
| **Azure VM - Network** dashboard provides detailed information about VM network activities based on incoming and outgoing packets and bytes. | ||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Operations-Detailed.png')} alt="Azure Key Vault - Operations Detailed dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
|
|
||
| ### Disk | ||
|
|
||
| **Azure VM - Disk** dashboard provides details on the operational activities and status of your Azure VM disks and premium disks. | ||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Errors-and-Failures.png')} alt="Azure Key Vault - Errors and Failures dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Administrative Operations | ||
|
|
||
| **Azure VM - Administrative Operations** dashboard provides details on the operational activities and status of your Azure Virtual Machine resources Use this dashboard to monitor the distribution of operation types and their success rates to ensure proper functioning of your Virtual Machine. Identify potential issues by analyzing the top operations causing errors and correlating them with specific users or applications. Track recent write and delete operations to maintain an audit trail of changes made to your Virtual Machine. | ||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Administrative-Operations.png')} alt="Azure Key Vault - Administrative Operations dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Policy and Recommendations | ||
|
|
||
| **Azure Virtual Machine - Policy and Recommendations** dashboard provides details on policy events and recommendations for your Azure Virtual Machine resources. Use this dashboard to monitor the success and failure rates of policy events to ensure proper configuration and compliance. Track and analyse recent recommendations to improve the performance and security of your Vaults setup. Identify trends in policy events and recommendations over time to proactively address potential issues. | ||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Policy-and-Recommendations.png')} alt="Azure Key Vault - Policy and Recommendations dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### CPU | ||
|
|
||
| **Azure VM - CPU** dashboard provides details on the CPU metrics and usage of your Azure VM CPU. | ||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Vault-Health.png')} alt="Azure Key Vault - Vault Health dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
|
|
||
| ### Cache | ||
|
|
||
| **Azure VM - Cache** dashboard provides details on the status and usage of your Azure VM cache resources | ||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Compliance.png')} alt="Azure Key Vault - Compliance dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Temp Disk | ||
|
|
||
| **Azure VM - Temp Disk** dashboard provides details on the operational activities and status of your Azure VM Temp Disk. | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Compliance.png')} alt="Azure Key Vault - Compliance dashboard" style={{border: '1px solid gray'}} width="800" /> | ||
|
|
||
| ## Create monitors for Azure Virtual Machine app | ||
|
|
||
| import CreateMonitors from '../../reuse/apps/create-monitors.md'; | ||
|
|
||
| <CreateMonitors/> | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### HTTP Logs and Metrics Source used by Azure Functions | ||
|
|
||
| To troubleshoot metrics collection, follow the instructions in [Collect Metrics from Azure Monitor > Troubleshooting metrics collection](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#troubleshooting-metrics-collection). | ||
Apoorvkudesia-sumologic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.