Skip to content

Commit b52e5b9

Browse files
amee-sumosachin-sumologicJV0812
authored
Updated Azure docs for Azure metrics source compatibility (part 2) (#5372)
* Updated Azure docs * added monitors section * resolved syntax issue * Update azure-container-instances.md * resolved syntax issue * Update azure-container-instances.md --------- Co-authored-by: Sachin Magar <[email protected]> Co-authored-by: Jagadisha V <[email protected]> Co-authored-by: Sachin Magar <[email protected]>
1 parent dd6db08 commit b52e5b9

File tree

2 files changed

+36
-150
lines changed

2 files changed

+36
-150
lines changed

docs/integrations/microsoft-azure/azure-container-instances.md

Lines changed: 23 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -24,100 +24,15 @@ For more information on supported dimensions, refer to the [Azure documentation]
2424
## Setup
2525

2626
* Set up application logs collection using fluent-bit sidecar container using the [http output plugin](https://docs.fluentbit.io/manual/1.5/pipeline/outputs/http) and the [tail input plugin](https://docs.fluentbit.io/manual/1.5/pipeline/inputs/tail). You must explicitly enable fluent-bit collection for each container group which you want to monitor.
27-
* Set up metrics collection using Azure Metrics Source.
27+
* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
2828

2929
:::note
3030
Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive.
3131
:::
32-
33-
### Configure field in field schema
34-
35-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
36-
1. Search for the following fields:
37-
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
38-
- `location`. The region to which the resource name belongs to.
39-
- `subscription_id`. ID associated with a subscription where the resource is present.
40-
- `resource_group`. The resource group name where the Azure resource is present.
41-
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
42-
- `resource_type`. Azure resource type (for example, storage accounts).
43-
- `resource_name`. The name of the resource (for example, storage account name).
44-
- `service_type`. Type of the service that can be accessed with a Azure resource.
45-
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances service is Subscriptions).
46-
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
47-
48-
### Configure field extraction rules
49-
50-
Create the following Field Extraction Rule(s) (FER) for Azure Storage by following the instructions in [Create a Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule/).
51-
52-
#### Azure location extraction FER
53-
54-
```sql
55-
Rule Name: AzureLocationExtractionFER
56-
Applied at: Ingest Time
57-
Scope (Specific Data): tenant_name=*
58-
```
59-
60-
```sql title="Parse Expression"
61-
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
62-
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
63-
| if (!isBlank(resourceLocation), resourceLocation, location) as location
64-
| if (!isBlank(service_region), service_region, location) as location
65-
| if (isBlank(location), "global", location) as location
66-
| fields location
67-
```
68-
69-
#### Resource ID extraction FER
70-
71-
```sql
72-
Rule Name: AzureResourceIdExtractionFER
73-
Applied at: Ingest Time
74-
Scope (Specific Data): tenant_name=*
75-
```
76-
77-
```sql title="Parse Expression"
78-
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
79-
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
80-
| toUpperCase(resourceId) as resourceId
81-
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
82-
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
83-
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
84-
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
85-
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
86-
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
87-
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
88-
```
89-
90-
### Configure metric rules
91-
92-
Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule).
93-
94-
#### Azure observability metadata extraction container instance level
95-
96-
```sql
97-
Rule Name: AzureObservabilityMetadataExtractionAzureContainerInstanceLevel
98-
```
99-
100-
```sql title="Metric match expression"
101-
resourceId=resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.CONTAINERINSTANCE/*/* tenant_name=*
102-
```
103-
| Fields extracted | Metric rule |
104-
|:------------------|:----------------------------|
105-
| subscription_id | $resourceId._1 |
106-
| resource_group | $resourceId._2 |
107-
| provider_name | MICROSOFT.CONTAINERINSTANCE |
108-
| resource_type | $resourceId._3 |
109-
| resource_name | $resourceId._4 |
11032

11133
### Configure metrics collection
11234

113-
:::note
114-
Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive.
115-
:::
116-
117-
In the Sumo Logic Azure Metrics source configuration,
118-
119-
- To set up the Azure Metrics source in Sumo Logic, refer to the shared beta documentation.
120-
- Configure namespaces as `Microsoft.ContainerInstance/containerGroups`. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/azure-container-instance-namespaces.png')} alt="Azure Container Instance Namespaces" style={{border: '1px solid gray'}} width="500" />
35+
To set up the Azure Metrics source in Sumo Logic, refer to [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
12136

12237
### Configure logs collection
12338

@@ -170,6 +85,18 @@ import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2
17085

17186
<AppInstallNoDataSourceV2/>
17287

88+
As part of the app installation process, the following fields will be created by default:
89+
90+
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
91+
- `location`. The region to which the resource name belongs to.
92+
- `subscription_id`. ID associated with a subscription where the resource is present.
93+
- `resource_group`. The resource group name where the Azure resource is present.
94+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
95+
- `resource_type`. Azure resource type (for example, storage accounts).
96+
- `resource_name`. The name of the resource (for example, storage account name).
97+
- `service_type`. Type of the service that can be accessed with a Azure resource.
98+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
99+
173100
## Viewing the Azure Container Instances dashboards
174101

175102
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
@@ -214,6 +141,15 @@ Use this dashboard to:
214141

215142
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/Azure-Container-Instances-Policy-and-Recommendations.png')} alt="Azure Container Instances - Policy and Recommendations" style={{border: '1px solid gray'}} width="800" />
216143

144+
### Azure Container Instances alerts
145+
146+
These alerts are metric based and will work for all Azure Container Instances.
147+
148+
| Alert Name | Description | Alert Condition | Recover Condition |
149+
|:-- |:-- |:--|:---------------------|
150+
| `Azure Container Instances - Memory Usage` | This alert is triggered when memory usage is greater than 20 MB. Also warning alert is triggered when the memory usage exceeds 15 MB. | Data volume > 20MB | Data volume < = 20MB |
151+
| `Azure Container Instances - CPU Usage` | This alert is triggered when CPU usage is greater than 100 milicore. Also warning alert is triggered when the CPU usage exceeds 90 millicore. | millicores > 100 | millicores < = 100 |
152+
217153
## Troubleshooting
218154

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

docs/integrations/microsoft-azure/kubernetes.md

Lines changed: 13 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -37,63 +37,6 @@ The AKS - Control Plane app collects logs for the following [Azure Kubernetes Se
3737
* **kube-controller-manager**. The Controller Manager oversees a number of smaller controllers that perform actions, such as replicating pods and handling node operations.
3838
* **cluster-autoscaler**. The cluster autoscaler component watches for pods in your cluster that can't be scheduled because of resource constraints. When the cluster autoscaler detects issues, it scales up the number of nodes in the node pool to meet the application demands. It also regularly checks nodes for a lack of running pods and scales down the number of nodes as needed.
3939

40-
### Configure field in field schema
41-
42-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
43-
1. Search for the following fields:
44-
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
45-
- `location`. The region to which the resource name belongs to.
46-
- `subscription_id`. ID associated with a subscription where the resource is present.
47-
- `resource_group`. The resource group name where the Azure resource is present.
48-
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
49-
- `resource_type`. Azure resource type (for example, storage accounts).
50-
- `resource_name`. The name of the resource (for example, storage account name).
51-
- `service_type`. Type of the service that can be accessed with a Azure resource.
52-
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Kubernetes service is Subscriptions).
53-
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
54-
55-
### Configure field extraction rules
56-
57-
Create the following Field Extraction Rule(s) (FER) for Azure Kubernetes Service by following the instructions in [Create a Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule/).
58-
59-
#### Azure location extraction FER
60-
61-
```sql
62-
Rule Name: AzureLocationExtractionFER
63-
Applied at: Ingest Time
64-
Scope (Specific Data): tenant_name=*
65-
```
66-
67-
```sql title="Parse Expression"
68-
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
69-
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
70-
| if (!isBlank(resourceLocation), resourceLocation, location) as location
71-
| if (!isBlank(service_region), service_region, location) as location
72-
| if (isBlank(location), "global", location) as location
73-
| fields location
74-
```
75-
76-
#### Resource ID extraction FER
77-
78-
```sql
79-
Rule Name: AzureResourceIdExtractionFER
80-
Applied at: Ingest Time
81-
Scope (Specific Data): tenant_name=*
82-
```
83-
84-
```sql title="Parse Expression"
85-
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
86-
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
87-
| toUpperCase(resourceId) as resourceId
88-
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
89-
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
90-
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
91-
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
92-
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
93-
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
94-
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
95-
```
96-
9740
### Sample log messages
9841

9942
```json title="kube-audit"
@@ -254,12 +197,7 @@ tenant_name={{tenant_name}} subscription_id={{subscription_id}} resource_group={
254197

255198
### Configure metrics collection
256199

257-
:::note
258-
Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive.
259-
:::
260-
261-
- To set up the Azure Metrics source in Sumo Logic, refer to the shared beta documentation.
262-
- Configure the namespaces as `Microsoft.ContainerService/managedClusters`, `microsoft.kubernetes/connectedClusters`, `microsoft.kubernetesconfiguration/extensions`, and `microsoft.hybridcontainerservice/provisionedClusters`. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/azure-kubernetes-service-namespaces.png')} alt="Azure Container Instance Namespaces" style={{border: '1px solid gray'}} width="500" />
200+
To set up the Azure Metrics source in Sumo Logic, refer to [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
263201

264202
### Collecting logs for the Azure Kubernetes Cluster
265203

@@ -294,6 +232,18 @@ import AppInstall from '../../reuse/apps/app-install.md';
294232

295233
<AppInstall/>
296234

235+
As part of the app installation process, the following fields will be created by default:
236+
237+
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
238+
- `location`. The region to which the resource name belongs to.
239+
- `subscription_id`. ID associated with a subscription where the resource is present.
240+
- `resource_group`. The resource group name where the Azure resource is present.
241+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
242+
- `resource_type`. Azure resource type (for example, storage accounts).
243+
- `resource_name`. The name of the resource (for example, storage account name).
244+
- `service_type`. Type of the service that can be accessed with a Azure resource.
245+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
246+
297247
## Viewing the Azure Kubernetes Service dashboards
298248

299249
### Overview

0 commit comments

Comments
 (0)