Skip to content

Commit c79a27e

Browse files
sachin-sumologicjpipkin1kimsauceJV0812
authored
updated setup collection section (#5118)
* updated setup collection section * Updates from review * Update docs/integrations/microsoft-azure/azure-container-instances.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * updated Configure metrics collection section * Update azure-container-instances.md * Minor updates * minor fixes * minor formatting --------- Co-authored-by: John Pipkin <[email protected]> Co-authored-by: Kim (Sumo Logic) <[email protected]> Co-authored-by: Jagadisha V <[email protected]>
1 parent d3c3d00 commit c79a27e

File tree

1 file changed

+47
-40
lines changed

1 file changed

+47
-40
lines changed

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

Lines changed: 47 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,20 @@ For Azure Container Instances, you can collect the following logs and metrics:
1616

1717
* **Audit Logs**. The activity log contains subscription-level events that track operations for each Azure resource as seen from outside that resource. For more details, refer to the [Azure Documentation](https://learn.microsoft.com/en-us/azure/container-instances/monitor-azure-container-instances#azure-activity-log).
1818
* **Resource Logs**. Capture container creation, execution, and failure logs. Refer to the [Microsoft Documentation](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-monitor#resource-logs) to know about the schema for resource logs.
19-
* **Metrics**. Metrics for Azure Container Instances are in the following namespaces:
19+
* **Metrics**. Metrics for Azure Container Instances are in the following namespace:
2020
* [Microsoft.ContainerInstance/containerGroups](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-containerinstance-containergroups-metrics)
2121

22-
For more information on supported dimensions, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-monitor#metrics).
22+
For more information on supported dimensions, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-monitor#metrics).
2323

2424
## Setup
2525

26-
Azure service sends monitoring data to Azure Monitor, which can then [stream data to an event hub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/stream-monitoring-data-event-hubs). Sumo Logic supports:
27-
28-
* 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/).
29-
* 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.
30-
31-
You must explicitly enable diagnostic settings for each domain, namespaces, custom topic, and system topic 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).
32-
33-
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/AzureContainerInstances/Logs`, `Azure/AzureContainerInstances/Metrics`.
34-
26+
* 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.
28+
29+
:::note
30+
Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive.
31+
:::
32+
3533
### Configure field in field schema
3634

3735
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**.
@@ -111,39 +109,48 @@ Create the following metrics rules by following the instructions in [Create a me
111109
| resource_name | $resourceId._4 |
112110
113111
### Configure metrics collection
114-
115-
For metrics collection follow guidelines in [Azue Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source/).
116-
117-
While you configure metrics collection you need to tag the location field in the source with right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Container Instance Tag Location" style={{border: '1px solid gray'}} width="400" />
118-
119-
Also you need to configure namespaces as shown below. <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" />
112+
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+
- Tag the location field in the source with correct Azure resource location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Container Instance Tag Location" style={{border: '1px solid gray'}} width="400" />
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" />
120121
121122
### Configure logs collection
122123
124+
:::note Prerequisite
125+
Use existing resource group or create a new one for deploying Azure container instances.
126+
:::
127+
123128
1. Add a hosted collector and [HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
124-
2. Create and push a custom image using a <a href="https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/Dockerfile" target="_blank">Docker file</a> and <a href="https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/output_conf.yaml" target="_blank">output_conf.yaml</a> onto a Docker hub.
125-
3. Use existing resource group or create a new one in Azure.
126-
4. Update the <a href="https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/logging-sidecar-deploy.yaml" target="_blank">**logging-sidecar-deploy.yaml**</a> file with your own application image whose logs you want to collect. In the file we have used nginx application as an example whose log files(access logs and error logs) are created in a shared volume(/var/log/nginx).
127-
4. Deploy the <a href="/files/logging-sidecar-deploy.yaml" target="_blank">**logging-sidecar-deploy.yaml**</a> Azure template.
128-
* parameter - `/fluent-bit/bin/fluent-bit` is fluent-bit executable path.
129-
* parameter - `-c /root/output_conf.yaml` is fluent-bit configuration file path.
130-
* Inputs parameters in the `output_conf.yaml` file.
131-
* **tail**. Read logs command name.
132-
* **path**. Log file path from where fluent bit collector is collecting logs.
133-
* Outputs parameters in the `output_conf.yaml` file.
134-
* **name*. HTTP output collector. By default, the name key will be assigned with *http* as value.
135-
* **format**. Data format by which you can send logs to Sumo Logic. By default, the format key will be assigned with *json_lines* as value.
136-
* **compress**. Payload compression mechanism. The recommended file type from Sumo Logic is `gzip`.
137-
* **match**. Log matching rule.
138-
* **host**. Sumo Logic collector host.
139-
* **port**. Sumo Logic collector port.
140-
* **tls=on**. By default, *on* value will be assigned to enable the TLS support.
141-
* **tls.verify**. By default, *off* value will be assigned to disable the certificate validation.
142-
* **URI**. Sumo Logic HTTP collector URI.
143-
* **json_date_key**. Name of the date field in output.
144-
* **header**. X-Sumo-Fields header used to tag fields during logs collection.
145-
146-
To learn more details on how to deploy azure container instance, refer to the [Azure Documentation](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-quickstart).
129+
1. Download and update the [output_conf.yaml](https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/output_conf.yaml) file with the following configurations:
130+
* Inputs pipeline uses the [tail input plugin](https://docs.fluentbit.io/manual/pipeline/inputs/tail). Update the path parameter value with the pattern specifying a specific log file or multiple ones through the use of common wildcards.
131+
:::info
132+
Multiple patterns separated by commas are also allowed.
133+
:::
134+
* Outputs pipeline uses the [http output plugin](https://docs.fluentbit.io/manual/pipeline/outputs/http). Follow the below steps to update other outputs pipeline parameters:
135+
* **format**. Data format by which you can send logs to Sumo Logic. By default, the format key will be assigned with *json_lines*.
136+
* **compress**. Payload compression mechanism. By default, the compression is enabled and uses `gzip`.
137+
* **host**. Update the host depending on your [Sumo Logic Orgs deployment](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security).
138+
* **tls**. This field will be in *on* condition to enable the TLS support. By default, Sumo Logic only supports **tls** in *on* condition.
139+
* **tls.verify**. This field will be in *off* condition to disable the certificate validation. By default, Sumo Logic only supports **tls.verify** in *off* condition.
140+
* **URI**. Update the `[PrivateKey]` with the path present in the HTTP source endpoint as configured in the Step 1.
141+
* **header**. Update the X-Sumo-Fields header and replace the following values to enrich the logs with additional metadata, which helps with panel queries.
142+
- `resource_name`. Name of the Azure container instances resource.
143+
- `resource_group`. Name of the resource group where the Azure container instances resource is present. Ensure that you use the same resource group created in the prerequisite section.
144+
- `subscription_id`. ID associated with a subscription where the Azure container instances resource is present.
145+
- `location`. The region to which the Azure container instances resource name belongs to.
146+
1. Create and push a custom fluentbit image using a [Docker file](https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/Dockerfile) and [output_conf.yaml](https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/output_conf.yaml) to any container repository.
147+
1. Download and update the [logging-sidecar-deploy.yaml](https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/logging-sidecar-deploy.yaml) file with the following configurations:
148+
- Update the `location` value with the region where the Azure container instances resource will be deployed.
149+
- Update the `name` value with the name of the Azure container instances resource. Ensure that this value is same as the `resource_name` in the `output_conf.yaml` file.
150+
- Update the `nginx` container with your own application image whose logs you want to collect. For example, in the `logging-sidecar-deploy.yaml` file we have used nginx application as an example whose log files are created in a shared volume (/var/log/nginx).
151+
- In the `fluentbit` container, replace the `{custom-fluentbit-image-path}` with the custom fluentbit image path that you created in the Step 2.
152+
- In the `imageRegistryCredentials` property, enter your image repository server, username, and password.
153+
1. Deploy the [logging-sidecar-deploy.yaml](https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-Container-Instances/logging-sidecar-deploy.yaml) Azure template, refer to the [Azure Documentation](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-multi-container-yaml#deploy-the-container-group).
147154
148155
#### Activity Logs
149156

0 commit comments

Comments
 (0)