Skip to content

Commit

Permalink
Azure Batch doc only apps (SumoLogic#2984)
Browse files Browse the repository at this point in the history
* azure batch doc completed

* added redirects/sidebar/small changes in doc

* Update docs/integrations/microsoft-azure/azure-batch.md

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* Update sidebars.ts

* Update docs/integrations/microsoft-azure/azure-batch.md

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>

* image swap

* Apply suggestions from code review

Co-authored-by: Kim <56411016+kimsauce@users.noreply.github.com>

---------

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>
Co-authored-by: Kim <56411016+kimsauce@users.noreply.github.com>
  • Loading branch information
3 people authored Aug 26, 2023
1 parent f7c3d53 commit 9a5942e
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 16 deletions.
1 change: 1 addition & 0 deletions cid-redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -2481,6 +2481,7 @@
"/cid/15631": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/citrix-cloud-source",
"/cid/14323": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/docusign-source",
"/cid/14326": "/docs/integrations/global-intelligence/kubernetes-devops",
"/cid/30001": "/docs/integrations/microsoft-azure/azure-batch",
"/Cloud_SIEM_Enterprise": "/docs/cse",
"/Cloud_SIEM_Enterprise/Administration": "/docs/cse/administration",
"/Cloud_SIEM_Enterprise/Administration/Cloud_SIEM_Enterprise_Feature_Update_(2022)": "/docs/cse/administration",
Expand Down
63 changes: 63 additions & 0 deletions docs/integrations/microsoft-azure/azure-batch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
id: azure-batch
title: Azure Batch
description: Learn about the Sumo Logic collection process for the Azure Batch service.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/integrations/microsoft-azure/azure-batch.png')} alt="Thumbnail icon" width="50"/>

**Azure Batch** runs large-scale parallel and high-performance computing (HPC) batch jobs efficiently in Azure. This integration helps in monitoring health of the nodes; creation, update, and deletion events of individual Batch resources, such as a pool or task; and tracking the state (start/fail/complete) of jobs and tasks.

For more details on Azure Batch, refer to the Azure Batch [documentation](https://learn.microsoft.com/en-us/azure/batch/).

## Log and Metric types

For Azure Batch, you can collect the following logs and metrics:

* **Service Logs**: Events emitted by the Batch service during the lifetime of an individual resource such as a pool or task. Logs events collected are listed [here](https://learn.microsoft.com/en-us/azure/batch/batch-diagnostics#service-log-events).
* **Batch account metrics**: Metrics at the Batch account level. Metrics collected are listed [here](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-batch-batchaccounts-metrics).


## 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/hosted-collectors/cloud-to-cloud-integration-framework/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.

You must explicitly enable diagnostic settings for each Batch account 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/Batch/Logs`, `Azure/Batch/Metrics`.


### Configure metrics collection

In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.

1. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
2. [Configure and deploy the ARM Template](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-2-configure-azure-resources-using-arm-template).
3. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Choose `Stream to an event hub` as destination and select `allMetrics`. Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the Policy name.


### Configure logs collection

In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.

1. To set up the Azure Event Hubs cloud-to-cloud source in Sumo Logic portal, refer to our [Azure Event Hubs cloud-to-cloud source guide documentation](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/azure-event-hubs-source/).
2. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/batch/batch-diagnostics#enable-collection-of-batch-diagnostic-logs).
* Choose `Stream to an event hub` as the destination.
* Select `allLogs` and `audit`.
* Use the Event hub namespace and Event hub name configured in previous step in destination details section. You can use the default policy `RootManageSharedAccessKey` as the Policy name.

## Troubleshooting

### Azure Event Hubs Source

Common error types are described [here](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/azure-event-hubs-source/#error-types).

You can try [restarting](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/azure-event-hubs-source/#restarting-your-source) the source for `ThirdPartyConfig` errors.

### HTTP Logs and Metrics Source used by Azure Functions

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).
37 changes: 22 additions & 15 deletions docs/integrations/microsoft-azure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,105 +41,112 @@ This guide has documentation for all of the apps that Sumo provides for Microsof
<p>A guide to the Sumo Logic app for Azure Audit.</p>
</div>
</div>
<div className="box smallbox5 card">
<div className="box smallbox5 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-batch.png')} alt="Thumbnail icon" width="60"/>
<h4><a href="/docs/integrations/microsoft-azure/azure-batch">Azure Batch</a></h4>
<p>A guide to the Sumo Logic integration for Azure Batch.</p>
</div>
</div>
<div className="box smallbox6 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-faq.png')} alt="Thumbnail icon" width="55"/>
<h4><a href="/docs/integrations/microsoft-azure/arm-integration-faq">Azure Integration with ARM FAQs</a></h4>
<p>A guide to the Sumo Logic app for Azure Integration with ARM FAQs.</p>
</div>
</div>
<div className="box smallbox6 card">
<div className="box smallbox7 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/k8s.png')} alt="Thumbnail icon" width="40"/>
<h4><a href="/docs/integrations/microsoft-azure/kubernetes">Azure Kubernetes Service Control Plane</a></h4>
<p>A guide to the Sumo Logic app for Azure Kubernetes Service Control Plane.</p>
</div>
</div>
<div className="box smallbox7 card">
<div className="box smallbox8 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/network-watcher.png')} alt="Thumbnail icon" width="50"/>
<h4><a href="/docs/integrations/microsoft-azure/network-watcher">Azure Network Watcher</a></h4>
<p>A guide to the Sumo Logic app for Azure Network Watcher.</p>
</div>
</div>
<div className="box smallbox8 card">
<div className="box smallbox9 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/sql.png')} alt="Thumbnail icon" width="50"/>
<h4><a href="/docs/integrations/microsoft-azure/sql">Azure SQL</a></h4>
<p>A guide to the Sumo Logic app for Azure SQL.</p>
</div>
</div>
<div className="box smallbox9 card">
<div className="box smallbox10 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/webapps.png')} alt="Thumbnail icon" width="55"/>
<h4><a href="/docs/integrations/microsoft-azure/web-apps">Azure Web Apps</a></h4>
<p>A guide to the Sumo Logic app for Azure Web Apps.</p>
</div>
</div>
<div className="box smallbox10 card">
<div className="box smallbox11 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/microsoft_iis_10.png')} alt="Thumbnail icon" width="120"/>
<h4><a href="/docs/integrations/microsoft-azure/iis-7">IIS 7</a></h4>
<p>A guide to the Sumo Logic app for IIS 7.</p>
</div>
</div>
<div className="box smallbox11 card">
<div className="box smallbox12 card">
<div className="container">
<img src={useBaseUrl('img/send-data/ms-graph.svg')} alt="Thumbnail icon" width="50"/>
<h4><a href="/docs/integrations/microsoft-azure/microsoft-graph-identity-protection">Microsoft Graph Identity Protection</a></h4>
<p>A guide to the Sumo Logic app for Microsoft Graph Identity Protection.</p>
</div>
</div>
<div className="box smallbox12 card">
<div className="box smallbox13 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/365.png')} alt="Thumbnail icon" width="50"/>
<h4><a href="/docs/integrations/microsoft-azure/office-365">Microsoft Office Audit 365</a></h4>
<p>A guide to the Sumo Logic app for Microsoft Office Audit 365.</p>
</div>
</div>
<div className="box smallbox13 card">
<div className="box smallbox14 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/sql.png')} alt="Thumbnail icon" width="45"/>
<h4><a href="/docs/integrations/microsoft-azure/sql-server">Microsoft SQL Server</a></h4>
<p>A guide to the Sumo Logic app for Microsoft SQL Server.</p>
</div>
</div>
<div className="box smallbox14 card">
<div className="box smallbox15 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/MSTeams.png')} alt="Thumbnail icon" width="43"/>
<h4><a href="/docs/integrations/microsoft-azure/teams">Microsoft Teams</a></h4>
<p>A guide to the Sumo Logic app for Microsoft Teams.</p>
</div>
</div>
<div className="box smallbox15 card">
<div className="box smallbox16 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/pci-icon_2.png')} alt="Thumbnail icon" width="65"/>
<h4><a href="/docs/integrations/microsoft-azure/windows-legacy-pci-compliance">PCI Compliance for Windows Legacy</a></h4>
<p>A guide to the Sumo Logic app for PCI Compliance for Windows Legacy.</p>
</div>
</div>
<div className="box smallbox16 card">
<div className="box smallbox17 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/pci-icon_2.png')} alt="Thumbnail icon" width="75"/>
<h4><a href="/docs/integrations/microsoft-azure/windows-json-pci-compliance">PCI Compliance for Windows JSON</a></h4>
<p>A guide to the Sumo Logic app for PCI Compliance for Windows JSON.</p>
</div>
</div>
<div className="box smallbox17 card">
<div className="box smallbox18 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/windows.png')} alt="Thumbnail icon" width="45"/>
<h4><a href="/docs/integrations/microsoft-azure/windows-json">Windows JSON</a></h4>
<p>A guide to the Sumo Logic app for Windows JSON.</p>
</div>
</div>
<div className="box smallbox18 card">
<div className="box smallbox19 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/windows.png')} alt="Thumbnail icon" width="45"/>
<h4><a href="/docs/integrations/microsoft-azure/windows-legacy">Windows Legacy</a></h4>
<p>A guide to the Sumo Logic app for Windows Legacy.</p>
</div>
</div>
<div className="box smallbox19 card">
<div className="box smallbox20 card">
<div className="container">
<img src={useBaseUrl('img/integrations/microsoft-azure/windows.png')} alt="Thumbnail icon" width="50"/>
<h4><a href="/docs/integrations/microsoft-azure/performance">Windows Performance</a></h4>
Expand Down
3 changes: 2 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1904,6 +1904,7 @@ integrations: [
'integrations/microsoft-azure/active-directory-azure',
'integrations/microsoft-azure/audit',
'integrations/microsoft-azure/arm-integration-faq',
'integrations/microsoft-azure/azure-batch',
'integrations/microsoft-azure/kubernetes',
'integrations/microsoft-azure/network-watcher',
'integrations/microsoft-azure/sql',
Expand All @@ -1917,7 +1918,7 @@ integrations: [
'integrations/microsoft-azure/windows-json-pci-compliance',
'integrations/microsoft-azure/windows-json',
'integrations/microsoft-azure/windows-legacy',
'integrations/microsoft-azure/performance',
'integrations/microsoft-azure/performance'
],
},
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9a5942e

Please sign in to comment.