Skip to content

Commit cdbeb23

Browse files
authored
Merge pull request #232740 from paulth1/app-articles-batch-21
[AQ] edit pass: App articles batch 21
2 parents 9f3db9a + 1933b09 commit cdbeb23

10 files changed

+229
-224
lines changed

articles/azure-monitor/app/data-model-complete.md

Lines changed: 81 additions & 80 deletions
Large diffs are not rendered by default.

articles/azure-monitor/app/javascript-feature-extensions.md

Lines changed: 82 additions & 78 deletions
Large diffs are not rendered by default.

articles/azure-monitor/app/opencensus-python-dependency.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ conn.close()
8181
Track your outgoing Django requests with the OpenCensus `django` integration.
8282

8383
> [!NOTE]
84-
> The only outgoing Django requests that are tracked are calls made to a database. For requests made to the Django application, see [incoming requests](./opencensus-python-request.md#tracking-django-applications).
84+
> The only outgoing Django requests that are tracked are calls made to a database. For requests made to the Django application, see [incoming requests](./opencensus-python-request.md#track-django-applications).
8585
8686
Download and install `opencensus-ext-django` from [PyPI](https://pypi.org/project/opencensus-ext-django/) and add the following line to the `MIDDLEWARE` section in the Django `settings.py` file.
8787

articles/azure-monitor/app/opencensus-python-request.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Incoming Request Tracking in Azure Application Insights with OpenCensus Python | Microsoft Docs
2+
title: Incoming request tracking in Application Insights with OpenCensus Python | Microsoft Docs
33
description: Monitor request calls for your Python apps via OpenCensus Python.
44
ms.topic: conceptual
55
ms.date: 03/22/2023
@@ -10,15 +10,15 @@ ms.reviewer: mmcc
1010

1111
# Track incoming requests with OpenCensus Python
1212

13-
OpenCensus Python and its integrations collect incoming request data. Track incoming request data sent to your web applications built on top of the popular web frameworks `django`, `flask` and `pyramid`. Application Insights receives the data as `requests` telemetry
13+
OpenCensus Python and its integrations collect incoming request data. You can track incoming request data sent to your web applications built on top of the popular web frameworks Django, Flask, and Pyramid. Application Insights receives the data as `requests` telemetry.
1414

15-
First, instrument your Python application with latest [OpenCensus Python SDK](./opencensus-python.md).
15+
First, instrument your Python application with the latest [OpenCensus Python SDK](./opencensus-python.md).
1616

17-
## Tracking Django applications
17+
## Track Django applications
1818

19-
1. Download and install `opencensus-ext-django` from [PyPI](https://pypi.org/project/opencensus-ext-django/) and instrument your application with the `django` middleware. Incoming requests sent to your `django` application will be tracked.
19+
1. Download and install `opencensus-ext-django` from [PyPI](https://pypi.org/project/opencensus-ext-django/). Instrument your application with the `django` middleware. Incoming requests sent to your Django application are tracked.
2020

21-
2. Include `opencensus.ext.django.middleware.OpencensusMiddleware` in your `settings.py` file under `MIDDLEWARE`.
21+
1. Include `opencensus.ext.django.middleware.OpencensusMiddleware` in your `settings.py` file under `MIDDLEWARE`.
2222

2323
```python
2424
MIDDLEWARE = (
@@ -28,8 +28,7 @@ First, instrument your Python application with latest [OpenCensus Python SDK](./
2828
)
2929
```
3030

31-
3. Make sure AzureExporter is configured properly in your `settings.py` under `OPENCENSUS`. For requests from urls that you don't wish to track, add them to `EXCLUDELIST_PATHS`.
32-
31+
1. Make sure AzureExporter is configured properly in your `settings.py` under `OPENCENSUS`. For requests from URLs that you don't want to track, add them to `EXCLUDELIST_PATHS`.
3332

3433
```python
3534
OPENCENSUS = {
@@ -43,10 +42,11 @@ First, instrument your Python application with latest [OpenCensus Python SDK](./
4342
}
4443
```
4544

46-
You can find a Django sample application in the sample Azure Monitor OpenCensus Python samples repository located [here](https://github.com/Azure-Samples/azure-monitor-opencensus-python/tree/master/azure_monitor/django_sample).
47-
## Tracking Flask applications
45+
You can find a Django sample application in the [Azure Monitor OpenCensus Python samples repository](https://github.com/Azure-Samples/azure-monitor-opencensus-python/tree/master/azure_monitor/django_sample).
46+
47+
## Track Flask applications
4848

49-
1. Download and install `opencensus-ext-flask` from [PyPI](https://pypi.org/project/opencensus-ext-flask/) and instrument your application with the `flask` middleware. Incoming requests sent to your `flask` application will be tracked.
49+
1. Download and install `opencensus-ext-flask` from [PyPI](https://pypi.org/project/opencensus-ext-flask/). Instrument your application with the `flask` middleware. Incoming requests sent to your Flask application are tracked.
5050

5151
```python
5252

@@ -71,7 +71,7 @@ You can find a Django sample application in the sample Azure Monitor OpenCensus
7171

7272
```
7373

74-
2. You can also configure your `flask` application through `app.config`. For requests from urls that you don't wish to track, add them to `EXCLUDELIST_PATHS`.
74+
1. You can also configure your `flask` application through `app.config`. For requests from URLs that you don't want to track, add them to `EXCLUDELIST_PATHS`.
7575

7676
```python
7777
app.config['OPENCENSUS'] = {
@@ -86,13 +86,13 @@ You can find a Django sample application in the sample Azure Monitor OpenCensus
8686
```
8787

8888
> [!NOTE]
89-
> To run Flask under uWSGI in a Docker environment, you must first add `lazy-apps = true` to the uWSGI configuration file (uwsgi.ini). For more information, see the [issue description](https://github.com/census-instrumentation/opencensus-python/issues/660).
90-
91-
You can find a Flask sample application that tracks requests in the Azure Monitor OpenCensus Python samples repository located [here](https://github.com/Azure-Samples/azure-monitor-opencensus-python/tree/master/azure_monitor/flask_sample).
89+
> To run Flask under uWSGI in a Docker environment, you must first add `lazy-apps = true` to the uWSGI configuration file (uwsgi.ini). For more information, see the [issue description](https://github.com/census-instrumentation/opencensus-python/issues/660).
9290

93-
## Tracking Pyramid applications
91+
You can find a Flask sample application that tracks requests in the [Azure Monitor OpenCensus Python samples repository](https://github.com/Azure-Samples/azure-monitor-opencensus-python/tree/master/azure_monitor/flask_sample).
9492

95-
1. Download and install `opencensus-ext-django` from [PyPI](https://pypi.org/project/opencensus-ext-pyramid/) and instrument your application with the `pyramid` tween. Incoming requests sent to your `pyramid` application will be tracked.
93+
## Track Pyramid applications
94+
95+
1. Download and install `opencensus-ext-django` from [PyPI](https://pypi.org/project/opencensus-ext-pyramid/). Instrument your application with the `pyramid` tween. Incoming requests sent to your Pyramid application are tracked.
9696

9797
```python
9898
def main(global_config, **settings):
@@ -102,7 +102,7 @@ You can find a Flask sample application that tracks requests in the Azure Monito
102102
'.pyramid_middleware.OpenCensusTweenFactory')
103103
```
104104

105-
2. You can configure your `pyramid` tween directly in the code. For requests from urls that you don't wish to track, add them to `EXCLUDELIST_PATHS`.
105+
1. You can configure your `pyramid` tween directly in the code. For requests from URLs that you don't want to track, add them to `EXCLUDELIST_PATHS`.
106106

107107
```python
108108
settings = {
@@ -119,19 +119,19 @@ You can find a Flask sample application that tracks requests in the Azure Monito
119119
config = Configurator(settings=settings)
120120
```
121121

122-
## Tracking FastAPI applications
122+
## Track FastAPI applications
123123

124-
OpenCensus doesn't have an extension for FastAPI. To write your own FastAPI middleware, complete the following steps:
124+
OpenCensus doesn't have an extension for FastAPI. To write your own FastAPI middleware:
125125

126-
1. The following dependencies are required:
126+
1. The following dependencies are required:
127127
- [fastapi](https://pypi.org/project/fastapi/)
128128
- [uvicorn](https://pypi.org/project/uvicorn/)
129-
129+
130130
In a production setting, we recommend that you deploy [uvicorn with gunicorn](https://www.uvicorn.org/deployment/#gunicorn).
131131

132-
2. Add [FastAPI middleware](https://fastapi.tiangolo.com/tutorial/middleware/). Make sure that you set the span kind server: `span.span_kind = SpanKind.SERVER`.
132+
1. Add [FastAPI middleware](https://fastapi.tiangolo.com/tutorial/middleware/). Make sure that you set the span kind server: `span.span_kind = SpanKind.SERVER`.
133133

134-
3. Run your application. Calls made to your FastAPI application should be automatically tracked and telemetry should be logged directly to Azure Monitor.
134+
1. Run your application. Calls made to your FastAPI application should be automatically tracked. Telemetry should be logged directly to Azure Monitor.
135135

136136
```python
137137
# Opencensus imports
@@ -184,6 +184,5 @@ OpenCensus doesn't have an extension for FastAPI. To write your own FastAPI midd
184184
* [Application Map](./app-map.md)
185185
* [Availability](./availability-overview.md)
186186
* [Search](./diagnostic-search.md)
187-
* [Log (Analytics) query](../logs/log-query-overview.md)
188-
* [Transaction diagnostics](./transaction-diagnostics.md)
189-
187+
* [Log Analytics query](../logs/log-query-overview.md)
188+
* [Transaction diagnostics](./transaction-diagnostics.md)

articles/azure-monitor/app/resource-manager-app-resource.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Resource Manager template samples for Application Insights Resources
2+
title: Resource Manager template samples for Application Insights resources
33
description: Sample Azure Resource Manager templates to deploy Application Insights resources in Azure Monitor.
44
ms.topic: sample
55
ms.date: 11/14/2022
@@ -271,6 +271,6 @@ resource component 'Microsoft.Insights/components@2020-02-02' = {
271271

272272
## Next steps
273273

274-
* [Get other sample templates for Azure Monitor](../resource-manager-samples.md).
275-
* [Learn more about classic Application Insights resources](/previous-versions/azure/azure-monitor/app/create-new-resource).
276-
* [Learn more about workspace-based Application Insights resources](../app/create-workspace-resource.md).
274+
* Get other [sample templates for Azure Monitor](../resource-manager-samples.md).
275+
* Learn more about [classic Application Insights resources](/previous-versions/azure/azure-monitor/app/create-new-resource).
276+
* Learn more about [workspace-based Application Insights resources](../app/create-workspace-resource.md).

articles/azure-monitor/app/statsbeat.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
---
2-
title: Statsbeat in Azure Application Insights | Microsoft Docs
2+
title: Statsbeat in Application Insights | Microsoft Docs
33
description: Statistics about Application Insights SDKs and Auto-Instrumentation
44
ms.topic: conceptual
55
ms.date: 08/24/2022
66
ms.custom: references_regions
77
ms.reviwer: heya
88
---
99

10-
# Statsbeat in Azure Application Insights
10+
# Statsbeat in Application Insights
1111

12-
Statsbeat collects essential and non-essential [custom metric](../essentials/metrics-custom-overview.md) about Application Insights SDKs and auto-instrumentation. Statsbeat serves three benefits for Azure Monitor Application Insights customers:
13-
- Service Health and Reliability (outside-in monitoring of connectivity to ingestion endpoint)
14-
- Support Diagnostics (self-help insights and CSS insights)
15-
- Product Improvement (insights for design optimizations)
12+
Statsbeat collects essential and nonessential [custom metrics](../essentials/metrics-custom-overview.md) about Application Insights SDKs and autoinstrumentation. Statsbeat serves three benefits for Azure Monitor Application Insights customers:
13+
- Service health and reliability (outside-in monitoring of connectivity to ingestion endpoint)
14+
- Support diagnostics (self-help insights and CSS insights)
15+
- Product improvement (insights for design optimizations)
1616

17-
Statsbeat data is stored in a Microsoft data store. It doesn't impact customers' overall monitoring volume and cost.
17+
Statsbeat data is stored in a Microsoft data store. It doesn't affect customers' overall monitoring volume and cost.
1818

19-
Statsbeat doesn't support [Azure Private Link](../../automation/how-to/private-link-security.md).
19+
Statsbeat doesn't support [Azure Private Link](../../automation/how-to/private-link-security.md).
2020

2121
## What data does Statsbeat collect?
2222

23-
Statsbeat collects essential and non-essential metrics.
23+
Statsbeat collects essential and nonessential metrics.
2424

2525
## Supported languages
2626

2727
| C# | Java | JavaScript | Node.js | Python |
2828
|---------------------------|-----------------|---------------------------|-----------------|-----------------|
29-
| Currently Not supported | Supported | Currently Not supported | Supported | Supported |
29+
| Currently not supported | Supported | Currently not supported | Supported | Supported |
3030

31-
## Supported EU Regions
31+
## Supported EU regions
3232

3333
#### [Java](#tab/eu-java)
3434

3535
Statsbeat supports EU Data Boundary for Application Insights resources in the following regions:
3636

37-
| Geo Name | Region Name |
37+
| Geo name | Region name |
3838
|---------------------------|------------------------|
3939
| Europe | North Europe |
4040
| Europe | West Europe |
@@ -53,7 +53,7 @@ Statsbeat supports EU Data Boundary for Application Insights resources in the fo
5353

5454
Statsbeat supports EU Data Boundary for Application Insights resources in the following regions:
5555

56-
| Geo Name | Region Name |
56+
| Geo name | Region name |
5757
|---------------------------|------------------------|
5858
| Europe | North Europe |
5959
| Europe | West Europe |
@@ -72,7 +72,7 @@ Statsbeat supports EU Data Boundary for Application Insights resources in the fo
7272

7373
Statsbeat supports EU Data Boundary for Application Insights resources in the following regions:
7474

75-
| Geo Name | Region Name |
75+
| Geo name | Region name |
7676
|---------------------------|------------------------|
7777
| Europe | North Europe |
7878
| Europe | West Europe |
@@ -87,40 +87,40 @@ Statsbeat supports EU Data Boundary for Application Insights resources in the fo
8787
| United Kingdom | United Kingdom South |
8888
| United Kingdom | United Kingdom West |
8989

90-
9190
---
9291

9392
### Essential Statsbeat
9493

9594
#### Network Statsbeat
9695

97-
|Metric Name|Unit|Supported dimensions|
96+
|Metric name|Unit|Supported dimensions|
9897
|-----|-----|-----|
9998
|Request Success Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`, `Endpoint`, `Host`|
10099
|Requests Failure Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`, `Endpoint`, `Host`, `Status Code`|
101100
|Request Duration|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`, `Endpoint`, `Host`|
102-
|Retry Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`, `Endpoint`, `Host`, , `Status Code`|
101+
|Retry Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`, `Endpoint`, `Host`, `Status Code`|
103102
|Throttle Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`, `Endpoint`, `Host`, `Status Code`|
104103
|Exception Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`, `Endpoint`, `Host`, `Exception Type`|
105104

106105
[!INCLUDE [azure-monitor-log-analytics-rebrand](../../../includes/azure-monitor-instrumentation-key-deprecation.md)]
106+
107107
#### Attach Statsbeat
108108

109-
|Metric Name|Unit|Supported dimensions|
109+
|Metric name|Unit|Supported dimensions|
110110
|-----|-----|-----|
111111
|Attach|Count| `Resource Provider`, `Resource Provider Identifier`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`|
112112

113113
#### Feature Statsbeat
114114

115-
|Metric Name|Unit|Supported dimensions|
115+
|Metric name|Unit|Supported dimensions|
116116
|-----|-----|-----|
117117
|Feature|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Feature`, `Type`, `Operating System`, `Language`, `Version`|
118118

119-
### Non-essential Statsbeat
119+
### Nonessential Statsbeat
120120

121-
Track the Disk I/O failure when using disk persistence for reliable telemetry.
121+
Track the Disk I/O failure when you use disk persistence for reliable telemetry.
122122

123-
|Metric Name|Unit|Supported dimensions|
123+
|Metric name|Unit|Supported dimensions|
124124
|-----|-----|-----|
125125
|Read Failure Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`|
126126
|Write Failure Count|Count| `Resource Provider`, `Attach Type`, `Instrumentation Key`, `Runtime Version`, `Operating System`, `Language`, `Version`|
@@ -129,7 +129,7 @@ Track the Disk I/O failure when using disk persistence for reliable telemetry.
129129

130130
#### [Java](#tab/java)
131131

132-
To disable non-essential Statsbeat, add the below configuration to your config file.
132+
To disable nonessential Statsbeat, add the following configuration to your config file:
133133

134134
```json
135135
{
@@ -141,7 +141,7 @@ To disable non-essential Statsbeat, add the below configuration to your config f
141141
}
142142
```
143143

144-
You can also disable this feature by setting the environment variable `APPLICATIONINSIGHTS_STATSBEAT_DISABLED` to true (which will then take precedence over disabled specified in the json configuration).
144+
You can also disable this feature by setting the environment variable `APPLICATIONINSIGHTS_STATSBEAT_DISABLED` to `true`. This setting then takes precedence over `disabled`, which is specified in the JSON configuration.
145145

146146
#### [Node](#tab/node)
147147

articles/azure-monitor/app/usage-heart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ These dimensions are measured independently, but they interact with each other a
6060
*Use the [Click Analytics Auto collection plugin](javascript-feature-extensions.md) via npm to emit these attributes.
6161

6262
>[!TIP]
63-
> To understand how to effectively use the Click Analytics plugin, please refer to [this section](javascript-feature-extensions.md#how-to-effectively-use-the-plugin).
63+
> To understand how to effectively use the Click Analytics plugin, please refer to [this section](javascript-feature-extensions.md#use-the-plug-in).
6464
6565
### Open the workbook
6666
The workbook can be found in the gallery under 'public templates'. The workbook will be shown in the section titled **"Product Analytics using the Click Analytics Plugin"** as shown in the following image:

includes/application-insights-data-model-measurements.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ ms.topic: include
55
ms.date: 11/09/2018
66
ms.author: mbullwin
77
---
8-
Collection of custom measurements: Use this collection to report named measurements associated with the telemetry item. Typical use cases are:
9-
- The size of the Dependency telemetry payload.
10-
- The number of queue items processed by Request telemetry.
11-
- The time that a customer took to finish the wizard step completing Event telemetry.
8+
**Collection of custom measurements:** Use this collection to report named measurements associated with the telemetry item. Typical use cases are:
9+
10+
- The size of the dependency telemetry payload.
11+
- The number of queue items processed by request telemetry.
12+
- The time that a customer took to finish the wizard step completing event telemetry.
1213

1314
You can query custom measurements in Application Analytics:
1415

@@ -19,6 +20,6 @@ customEvents
1920
```
2021

2122
> [!NOTE]
22-
> Custom measurements are associated with the telemetry item they belong to. They're subject to sampling with the telemetry item that contains those measurements. To track a measurement that has a value independent from other telemetry types, use [Metric telemetry](../articles/azure-monitor/app/api-custom-events-metrics.md).
23+
> Custom measurements are associated with the telemetry item they belong to. They're subject to sampling with the telemetry item that contains those measurements. To track a measurement that has a value independent from other telemetry types, use [metric telemetry](../articles/azure-monitor/app/api-custom-events-metrics.md).
2324
2425
**Maximum key length**: 150

0 commit comments

Comments
 (0)