You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/azure_functions/_dev/build/docs/README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
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.
4
4
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.
6
6
7
7
## Hosting plans and metrics
8
8
@@ -24,12 +24,13 @@ Supported log categories:
24
24
25
25
#### Requirements and setup
26
26
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.
28
28
29
29
#### Configuration options
30
+
30
31
`eventhub` :
31
32
_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.
33
34
Default value `insights-operational-logs`.
34
35
35
36
`consumer_group` :
@@ -39,25 +40,25 @@ Default value: `$Default`
39
40
40
41
`connection_string` :
41
42
_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).
43
44
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.
45
46
46
47
`storage_account` :
47
48
_string_
48
49
The name of the storage account where the state/offsets will be stored and updated.
49
50
50
51
`storage_account_key` :
51
52
_string_
52
-
The storage account key, this key will be used to authorize access to data in your storage account.
53
+
The storage account keyused to authorize data access in your storage account.
53
54
54
55
`storage_account_container` :
55
56
_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.
57
58
58
59
`resource_manager_endpoint` :
59
60
_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.
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.
83
84
84
85
{{fields "functionapplogs"}}
85
86
@@ -88,9 +89,8 @@ Please refer to the following [document](https://www.elastic.co/guide/en/ecs/cur
88
89
89
90
#### Requirements
90
91
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.
92
93
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.
94
94
***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.
95
95
96
96
#### Setup
@@ -150,7 +150,7 @@ Take note of the content in the **Value** column in the **Client secrets** table
150
150
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.
151
151
8. To find your application, search by name (for example, "elastic-agent") and select it from the list.
152
152
9. Click the **Select** button.
153
-
10.Then click the **Review + assign** button.
153
+
10.Click the **Review + assign** button.
154
154
155
155
Take note of the following values, which you will use later when specifying settings.
156
156
@@ -161,14 +161,14 @@ Your App Registration is now ready to be used with the Elastic Agent.
161
161
162
162
#### Additional Resources
163
163
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:
165
165
166
166
*[Quickstart: Register an application with the Microsoft identity platform](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app)
167
167
*[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)
168
168
169
169
#### Main options
170
170
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:
172
172
173
173
`Client ID`_string_
174
174
: 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
187
187
There are two additional advanced options:
188
188
189
189
`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.
191
191
192
192
Examples:
193
193
@@ -197,7 +197,7 @@ Examples:
197
197
*`https://management.usgovcloudapi.net` for Azure USGovernmentCloud
198
198
199
199
`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.
201
201
202
202
Examples:
203
203
@@ -212,6 +212,6 @@ Examples:
212
212
213
213
**ECS Field Reference**
214
214
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.
0 commit comments