Skip to content

Commit 93da032

Browse files
authored
Merge branch 'main' into prefer-set-with-copy_from
2 parents f15a747 + b5cff67 commit 93da032

File tree

18 files changed

+417
-80
lines changed

18 files changed

+417
-80
lines changed
Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,34 @@
11
# Azure App Service Integration
22

3-
The Azure App Service logs integration retrieves different types of logs categories from Azure App Service.
3+
## Overview
4+
45
Azure App Service provides different logging to help you track, monitor, and debug your web application.
56

7+
## What data does this integration collect?
8+
9+
This integration currently collects one data stream: App Service Logs.
10+
11+
The Azure App Service logs integration retrieves different types of logs categories from Azure App Service:
12+
613
- HTTPLogs help monitor application health, performance and usage patterns.
714
- AuditLogs provide insights when publishing users successfully log on via one of the App Service publishing protocols.
815
- IPSecAuditLogs are generated through your application and pushed to Azure Monitoring.
916
- PlatformLogs are generated through AppService platform for your application.
1017
- ConsoleLogs are generated from application or container.
11-
- AppLogs are generated through your application (ex. logging capabilities)
18+
- AppLogs are generated through your application (for example, logging capabilities).
1219

13-
## Data streams
20+
## What do I need to use this integration?
1421

15-
This integration currently collects one data stream:
16-
17-
- App Service Logs
18-
19-
## Requirements and setup
20-
Refer to the [Azure Logs](https://docs.elastic.co/integrations/azure) page for more information on how to set up and use this integration.
22+
Refer to the [Azure Logs](https://docs.elastic.co/integrations/azure) page for more information on requirements and setup instructions.
2123

2224
## App Service Logs
25+
2326
Collects different types of logs from Azure App Service via Event Hub.
2427

2528
{{event "app_service_logs"}}
2629

2730
**ECS Field Reference**
2831

29-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
32+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
3033

3134
{{fields "app_service_logs"}}

packages/azure_app_service/changelog.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# newer versions go on top
2+
- version: "0.10.2"
3+
changes:
4+
- description: Review Azure App Service Integration documentation.
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/15838
27
- version: "0.10.1"
38
changes:
49
- description: Fix dashboard summary

packages/azure_app_service/docs/README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
# Azure App Service Integration
22

3-
The Azure App Service logs integration retrieves different types of logs categories from Azure App Service.
3+
## Overview
4+
45
Azure App Service provides different logging to help you track, monitor, and debug your web application.
56

7+
## What data does this integration collect?
8+
9+
This integration currently collects one data stream: App Service Logs.
10+
11+
The Azure App Service logs integration retrieves different types of logs categories from Azure App Service:
12+
613
- HTTPLogs help monitor application health, performance and usage patterns.
714
- AuditLogs provide insights when publishing users successfully log on via one of the App Service publishing protocols.
815
- IPSecAuditLogs are generated through your application and pushed to Azure Monitoring.
916
- PlatformLogs are generated through AppService platform for your application.
1017
- ConsoleLogs are generated from application or container.
11-
- AppLogs are generated through your application (ex. logging capabilities)
18+
- AppLogs are generated through your application (for example, logging capabilities).
1219

13-
## Data streams
20+
## What do I need to use this integration?
1421

15-
This integration currently collects one data stream:
16-
17-
- App Service Logs
18-
19-
## Requirements and setup
20-
Refer to the [Azure Logs](https://docs.elastic.co/integrations/azure) page for more information on how to set up and use this integration.
22+
Refer to the [Azure Logs](https://docs.elastic.co/integrations/azure) page for more information on requirements and setup instructions.
2123

2224
## App Service Logs
25+
2326
Collects different types of logs from Azure App Service via Event Hub.
2427

2528
An example event for `app_service` looks as following:
@@ -78,7 +81,7 @@ An example event for `app_service` looks as following:
7881

7982
**ECS Field Reference**
8083

81-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
84+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
8285

8386
**Exported fields**
8487

packages/azure_app_service/manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
format_version: "3.0.2"
22
name: azure_app_service
33
title: "Azure App Service"
4-
version: "0.10.1"
4+
version: "0.10.2"
55
source:
66
license: "Elastic-2.0"
77
description: "Collect logs from Azure App Service with Elastic Agent."

packages/azure_functions/_dev/build/docs/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Azure Functions integration allows you to monitor Azure Functions. Azure Functions is an event-driven, serverless compute platform that helps you develop more efficiently using the programming language of your choice. Triggers cause a function to run. A trigger defines how a function is invoked and a function must have exactly one trigger.
44

5-
Use Azure Functions to build web APIs, respond to database changes, process IoT streams, manage message queues, and more. Refer common [Azure Functions scenarios](https://learn.microsoft.com/en-us/azure/azure-functions/functions-scenarios?pivots=programming-language-csharp) for more information.
5+
Use Azure Functions to build web APIs, respond to database changes, process IoT streams, manage message queues, and more. Refer to common [Azure Functions scenarios](https://learn.microsoft.com/en-us/azure/azure-functions/functions-scenarios?pivots=programming-language-csharp) for more information.
66

77
## Hosting plans and metrics
88

@@ -24,12 +24,13 @@ Supported log categories:
2424

2525
#### Requirements and setup
2626

27-
Refer to the [Azure Logs](https://docs.elastic.co/integrations/azure) page for more information about setting up and using this integration.
27+
Refer to the [Azure Logs](https://docs.elastic.co/integrations/azure) page for more information on how to set up and use this integration.
2828

2929
#### Configuration options
30+
3031
`eventhub` :
3132
_string_
32-
An Event Hub is a fully managed, real-time data ingestion service. Elastic recommends using only letters, numbers, and the hyphen (-) character for Event Hub names to maximize compatibility. You can use existing Event Hubs having underscores (_) in the Event Hub name; in this case, the integration will replace underscores with hyphens (-) when it uses the Event Hub name to create dependent Azure resources behind the scenes (e.g., the storage account container to store Event Hub consumer offsets). Elastic also recommends using a separate event hub for each log type as the field mappings of each log type differ.
33+
An Event Hub is a fully managed, real-time data ingestion service. Elastic recommends using only letters, numbers, and the hyphen (-) character for Event Hub names to maximize compatibility. You can use existing Event Hubs having underscores (_) in the Event Hub name; in this case, the integration will replace underscores with hyphens (-) when it uses the Event Hub name to create dependent Azure resources behind the scenes (for example, the storage account container to store Event Hub consumer offsets). Elastic also recommends using a separate event hub for each log type as the field mappings of each log type differ.
3334
Default value `insights-operational-logs`.
3435

3536
`consumer_group` :
@@ -39,25 +40,25 @@ Default value: `$Default`
3940

4041
`connection_string` :
4142
_string_
42-
The connection string is required to communicate with Event Hubs, see steps [here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string).
43+
The connection string is required to communicate with Event Hubs. For more information, check the [Azure documentation](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string).
4344

44-
A Blob Storage account is required in order to store/retrieve/update the offset or state of the eventhub messages. This means that after stopping the Azure logs package it can start back up at the spot that it stopped processing messages.
45+
A Blob Storage account is required to store/retrieve/update the offset or state of the event hub messages. This means that after the Azure logs package is stopped, the Blob Storage can resume processing messages and back up from where it left off.
4546

4647
`storage_account` :
4748
_string_
4849
The name of the storage account where the state/offsets will be stored and updated.
4950

5051
`storage_account_key` :
5152
_string_
52-
The storage account key, this key will be used to authorize access to data in your storage account.
53+
The storage account key used to authorize data access in your storage account.
5354

5455
`storage_account_container` :
5556
_string_
56-
The storage account container where the integration stores the checkpoint data for the consumer group. It is an advanced option to use with extreme care. You MUST use a dedicated storage account container for each Azure log type (activity, sign-in, audit logs, and others). DO NOT REUSE the same container name for more than one Azure log type. See [Container Names](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#container-names) for details on naming rules from Microsoft. The integration generates a default container name if not specified.
57+
The storage account container where the integration stores the checkpoint data for the consumer group. It is an advanced option to use with extreme care. You must use a dedicated storage account container for each Azure log type (activity, sign-in, audit logs, and others). Do not reuse the same container name for more than one Azure log type. Refer to [Container Names](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#container-names) for details on naming rules from Microsoft. The integration generates a default container name, if not specified.
5758

5859
`resource_manager_endpoint` :
5960
_string_
60-
Optional, by default we are using the Azure public environment, to override, users can provide a specific resource manager endpoint in order to use a different Azure environment.
61+
Optional. By default, the integration uses the Azure public environment. To override, you can provide a specific Azure environment.
6162

6263
Resource manager endpoints:
6364

@@ -79,7 +80,7 @@ https://management.usgovcloudapi.net/
7980

8081
**ECS Field Reference**
8182

82-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
83+
Check the [ECS field reference](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for more information.
8384

8485
{{fields "functionapplogs"}}
8586

@@ -88,9 +89,8 @@ Please refer to the following [document](https://www.elastic.co/guide/en/ecs/cur
8889

8990
#### Requirements
9091

91-
To use this integration you will need:
92+
* **Azure App Registration**: You need to set up an Azure App Registration to allow the Agent to access the Azure APIs. The App Registration requires the Monitoring Reader role to collect metrics from Function Apps. Check the Setup section for more details.
9293

93-
* **Azure App Registration**: You need to set up an Azure App Registration to allow the Agent to access the Azure APIs. The App Registration requires the Monitoring Reader role to access to be able to collect metrics from Function Apps. See more details in the Setup section.
9494
* **Elasticsearch and Kibana**: You need Elasticsearch to store and search your data and Kibana to visualize and manage it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, the [Native Azure Integration](https://azuremarketplace.microsoft.com/en/marketplace/apps/elastic.ec-azure-pp?tab=overview), or self-manage the Elastic Stack on your hardware.
9595

9696
#### Setup
@@ -150,7 +150,7 @@ Take note of the content in the **Value** column in the **Client secrets** table
150150
7. Select **Assign access to** > **User, group, or service principal**, and select **Select members**. This page does not display Azure AD applications in the available options by default.
151151
8. To find your application, search by name (for example, "elastic-agent") and select it from the list.
152152
9. Click the **Select** button.
153-
10. Then click the **Review + assign** button.
153+
10. Click the **Review + assign** button.
154154

155155
Take note of the following values, which you will use later when specifying settings.
156156

@@ -161,14 +161,14 @@ Your App Registration is now ready to be used with the Elastic Agent.
161161

162162
#### Additional Resources
163163

164-
If you want to learn more about this process, you can read these two general guides from Microsoft:
164+
To learn more about this process, check the following Microsoft guides:
165165

166166
* [Quickstart: Register an application with the Microsoft identity platform](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app)
167167
* [Use the portal to create an Azure AD application and service principal that can access resources](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal)
168168

169169
#### Main options
170170

171-
The settings' main section contains all the options needed to access the Azure APIs and collect the Azure Functions metrics data. You will now use all the values from [App registration](#register-a-new-app) including:
171+
The Settings main section contains all the options needed to access the Azure APIs and collect the Azure Functions metrics data. You will now use all the values from [App registration](#register-a-new-app) including:
172172

173173
`Client ID` _string_
174174
: The unique identifier of the App Registration (sometimes referred to as Application ID).
@@ -187,7 +187,7 @@ The settings' main section contains all the options needed to access the Azure A
187187
There are two additional advanced options:
188188

189189
`Resource Manager Endpoint` _string_
190-
: Optional. By default, the integration uses the Azure public environment. To override, users can provide a specific resource manager endpoint to use a different Azure environment.
190+
: Optional. By default, the integration uses the Azure public environment. To override, you can provide a specific resource manager endpoint to use a different Azure environment.
191191

192192
Examples:
193193

@@ -197,7 +197,7 @@ Examples:
197197
* `https://management.usgovcloudapi.net` for Azure USGovernmentCloud
198198

199199
`Active Directory Endpoint` _string_
200-
: Optional. By default, the integration uses the associated Active Directory Endpoint. To override, users can provide a specific active directory endpoint to use a different Azure environment.
200+
: Optional. By default, the integration uses the associated Active Directory Endpoint. To override, you can provide a specific active directory endpoint to use a different Azure environment.
201201

202202
Examples:
203203

@@ -212,6 +212,6 @@ Examples:
212212

213213
**ECS Field Reference**
214214

215-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
215+
Check the [ECS field reference](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for more information.
216216

217217
{{fields "metrics"}}

0 commit comments

Comments
 (0)