Skip to content

Commit d03e10b

Browse files
authored
Update opentelemetry-enable.md
- Raised Acrolinx score. - Please note that Acrolinx incorrectly flags Statsbeat as a Correctness issue. We cannot do anything about this.
1 parent c4540db commit d03e10b

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

articles/azure-monitor/app/opentelemetry-enable.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Consider whether this preview is right for you. It *enables distributed tracing,
3737
- [Instrumentation libraries](#instrumentation-libraries) support on Azure Functions
3838
- [Status](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status) only supports statuscode(unset,ok,error) and status-description. "Status Description" is ignored by Azure Monitor Exporters.
3939

40-
If you require a full-feature experience, use the existing Application Insights [ASP.NET](asp-net.md) or [ASP.NET Core](asp-net-core.md) SDK until the OpenTelemetry-based offering matures.
40+
If you require a full-feature experience, use the existing Application Insights [ASP.NET](asp-net.md), or [ASP.NET Core](asp-net-core.md) SDK until the OpenTelemetry-based offering matures.
4141

4242
### [Node.js](#tab/nodejs)
4343

@@ -395,14 +395,14 @@ For information on standard attributes for resources, see [Resource Semantic Con
395395

396396
## Enable Sampling
397397

398-
You may want to enable sampling to reduce your data ingestion volume which reduces your cost. Azure Monitor provides a custom *fixed-rate* sampler that populates events with a "sampling ratio", which Application Insights converts to "ItemCount". This ensures accurate experiences and event counts. The sampler is designed to preserve your traces across services, and it's interoperable with older Application Insights SDKs. The sampler expects a sample rate of between 0 and 1 inclusive. A rate of 0.1 means approximately 10% of your traces will be sent. For more information, see [Learn More about sampling](sampling.md#brief-summary).
398+
You may want to enable sampling to reduce your data ingestion volume, which reduces your cost. Azure Monitor provides a custom *fixed-rate* sampler that populates events with a "sampling ratio", which Application Insights converts to "ItemCount". The *fixed-rate* sampler ensures accurate experiences and event counts. The sampler is designed to preserve your traces across services, and it's interoperable with older Application Insights SDKs. The sampler expects a sample rate of between 0 and 1 inclusive. A rate of 0.1 means approximately 10% of your traces will be sent. For more information, see [Learn More about sampling](sampling.md#brief-summary).
399399

400400
> [!NOTE]
401401
> Metrics are unaffected by sampling.
402402
403403
#### [.NET](#tab/net)
404404

405-
In this example, we utilize the `ApplicationInsightsSampler` which offers compatibility with Application Insights SDKs.
405+
In this example, we utilize the `ApplicationInsightsSampler`, which offers compatibility with Application Insights SDKs.
406406

407407
```dotnetcli
408408
dotnet add package --prerelease OpenTelemetry.Extensions.AzureMonitor
@@ -442,7 +442,7 @@ provider.register();
442442

443443
#### [Python](#tab/python)
444444

445-
In this example, we utilize the `ApplicationInsightsSampler` which offers compatibility with Application Insights SDKs.
445+
In this example, we utilize the `ApplicationInsightsSampler`, which offers compatibility with Application Insights SDKs.
446446

447447
```python
448448
from opentelemetry import trace
@@ -963,7 +963,7 @@ This section explains how to collect custom telemetry from your application.
963963

964964
You may want to collect metrics beyond what is collected by [instrumentation libraries](#instrumentation-libraries).
965965

966-
The OpenTelemetry API offers six metric "instruments" to cover a variety of metric scenarios and you'll need to pick the correct "Aggregation Type" when visualizing metrics in Metrics Explorer. This requirement is true when using the OpenTelemetry Metric API to send metrics and when using an instrumentation library.
966+
The OpenTelemetry API offers six metric "instruments" to cover various metric scenarios and you'll need to pick the correct "Aggregation Type" when visualizing metrics in Metrics Explorer. This requirement is true when using the OpenTelemetry Metric API to send metrics and when using an instrumentation library.
967967

968968
The following table shows the recommended [aggregation types](/essentials/metrics-aggregation-explained.md#aggregation-types) for each of the OpenTelemetry Metric Instruments.
969969

@@ -1275,8 +1275,8 @@ input()
12751275
### Add Custom Exceptions
12761276

12771277
Select instrumentation libraries automatically support exceptions to Application Insights.
1278-
However, you may want to manually report exceptions beyond what instrumention libraries report.
1279-
For instance, exceptions caught by your code are *not* ordinarily not reported, and you may wish to report them
1278+
However, you may want to manually report exceptions beyond what instrumentation libraries report.
1279+
For instance, exceptions caught by your code *aren't* ordinarily not reported, and you may wish to report them
12801280
and thus draw attention to them in relevant experiences including the failures blade and end-to-end transaction view.
12811281

12821282
#### [.NET](#tab/net)
@@ -1430,7 +1430,7 @@ You might want to enable the OpenTelemetry Protocol (OTLP) Exporter alongside yo
14301430

14311431
### Offline Storage and Automatic Retries
14321432

1433-
To improve reliability and resiliency, Azure Monitor OpenTelemetry-based offerings write to offline/local storage by default when an application loses its connection with Application Insights. It saves the application telemetry for 48 hours and periodically tries to send it again. In addition to exceeding the allowable time, telemetry will occasionally be dropped in high-load applications when the maximum file size is exceeded or the SDK does not have an opportunity to clear out the file. If we need to choose, the product will save more recent events over old ones. In some cases, you may wish to disable this feature to optimize application performance. [Learn More](data-retention-privacy.md#does-the-sdk-create-temporary-local-storage)
1433+
To improve reliability and resiliency, Azure Monitor OpenTelemetry-based offerings write to offline/local storage by default when an application loses its connection with Application Insights. It saves the application telemetry for 48 hours and periodically tries to send it again. In addition to exceeding the allowable time, telemetry will occasionally be dropped in high-load applications when the maximum file size is exceeded or the SDK doesn't have an opportunity to clear out the file. If we need to choose, the product will save more recent events over old ones. In some cases, you may wish to disable this feature to optimize application performance. [Learn More](data-retention-privacy.md#does-the-sdk-create-temporary-local-storage)
14341434

14351435
#### [.NET](#tab/net)
14361436

@@ -1444,7 +1444,7 @@ By default, the AzureMonitorExporter uses one of the following locations for off
14441444
- /var/tmp/Microsoft/AzureMonitor
14451445
- /tmp/Microsoft/AzureMonitor
14461446

1447-
To override the default directory you should set `AzureMonitorExporterOptions.StorageDirectory`.
1447+
To override the default directory, you should set `AzureMonitorExporterOptions.StorageDirectory`.
14481448

14491449
For example:
14501450
```csharp
@@ -1456,7 +1456,7 @@ var tracerProvider = Sdk.CreateTracerProviderBuilder()
14561456
.Build();
14571457
```
14581458

1459-
To disable this feature you should set `AzureMonitorExporterOptions.DisableOfflineStorage = true`.
1459+
To disable this feature, you should set `AzureMonitorExporterOptions.DisableOfflineStorage = true`.
14601460

14611461
#### [Node.js](#tab/nodejs)
14621462

@@ -1468,7 +1468,7 @@ By default, the AzureMonitorExporter uses one of the following locations for off
14681468
- %TMPDIR%/Microsoft/AzureMonitor
14691469
- /var/tmp/Microsoft/AzureMonitor
14701470

1471-
To override the default directory you should set `storageDirectory`.
1471+
To override the default directory, you should set `storageDirectory`.
14721472

14731473
For example:
14741474
```typescript
@@ -1480,15 +1480,15 @@ const exporter = new AzureMonitorTraceExporter({
14801480
});
14811481
```
14821482

1483-
To disable this feature you should set `disableOfflineStorage = true`.
1483+
To disable this feature, you should set `disableOfflineStorage = true`.
14841484

14851485
#### [Python](#tab/python)
14861486

14871487
By default, the Azure Monitor exporters will use the following path:
14881488

14891489
`<tempfile.gettempdir()>/Microsoft/AzureMonitor/opentelemetry-python-<your-instrumentation-key>`
14901490

1491-
To override the default directory you should set `storage_directory` to the directory you want.
1491+
To override the default directory, you should set `storage_directory` to the directory you want.
14921492

14931493
For example:
14941494
```python
@@ -1498,7 +1498,7 @@ exporter = AzureMonitorTraceExporter(connection_string="your-connection-string",
14981498

14991499
```
15001500

1501-
To disable this feature you should set `disable_offline_storage` to `True`. Defaults to `False`.
1501+
To disable this feature, you should set `disable_offline_storage` to `True`. Defaults to `False`.
15021502

15031503
For example:
15041504
```python
@@ -1535,7 +1535,7 @@ provider.register();
15351535

15361536
#### [Python](#tab/python)
15371537

1538-
The Azure Monitor Exporter uses the Python standard logging [library](https://docs.python.org/3/library/logging.html) for its own internal logging. OpenTelemetry API and Azure Monitor Exporter logs are usually logged at the severity level of WARNING or ERROR for irregular activity. The INFO severity level is used for regular or successful activity. By default, the Python logging library sets the severity level to WARNING, so you must change the severity level to see logs under this severity setting. The following example shows how to output logs of *all* severity levels to the console *and* a file:
1538+
The Azure Monitor Exporter uses the Python standard logging [library](https://docs.python.org/3/library/logging.html) for its own internal logging. OpenTelemetry API and Azure Monitor Exporter logs are logged at the severity level of WARNING or ERROR for irregular activity. The INFO severity level is used for regular or successful activity. By default, the Python logging library sets the severity level to WARNING, so you must change the severity level to see logs under this severity setting. The following example shows how to output logs of *all* severity levels to the console *and* a file:
15391539
15401540
```python
15411541
...

0 commit comments

Comments
 (0)