Skip to content

Commit a92ff5b

Browse files
Merge pull request #250755 from AaronMaxwell/aaronmax-otel-acrolinx-fixes
Acrolinx fixes for OTel
2 parents 19c2f1a + c16e237 commit a92ff5b

File tree

4 files changed

+31
-31
lines changed

4 files changed

+31
-31
lines changed

articles/azure-monitor/app/opentelemetry-add-modify.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To learn more about OpenTelemetry concepts, see the [OpenTelemetry overview](ope
1818

1919
## Automatic data collection
2020

21-
The distros automatically collect data by bundling OpenTelemetry "instrumentation libraries".
21+
The distros automatically collect data by bundling OpenTelemetry instrumentation libraries.
2222

2323
### Included instrumentation libraries
2424

@@ -33,9 +33,9 @@ Dependencies
3333
- [SqlClient](https://github.com/open-telemetry/opentelemetry-dotnet/blob/1.0.0-rc9.14/src/OpenTelemetry.Instrumentation.SqlClient/README.md) <sup>[1](#FOOTNOTEONE)</sup>
3434

3535
Logging
36-
- ILogger
36+
- `ILogger`
3737

38-
For more information about ILogger, see [Logging in C# and .NET](/dotnet/core/extensions/logging) and [code examples](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/logs).
38+
For more information about `ILogger`, see [Logging in C# and .NET](/dotnet/core/extensions/logging) and [code examples](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/logs).
3939

4040
#### [.NET](#tab/net)
4141

@@ -168,8 +168,8 @@ Requests
168168
Dependencies
169169
- [Psycopg2](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-psycopg2)
170170
- [Requests](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-requests) <sup>[1](#FOOTNOTEONE)</sup> <sup>[2](#FOOTNOTETWO)</sup>
171-
- [Urllib](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-urllib) <sup>[1](#FOOTNOTEONE)</sup> <sup>[2](#FOOTNOTETWO)</sup>
172-
- [Urllib3](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-urllib3) <sup>[1](#FOOTNOTEONE)</sup> <sup>[2](#FOOTNOTETWO)</sup>
171+
- [`Urllib`](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-urllib) <sup>[1](#FOOTNOTEONE)</sup> <sup>[2](#FOOTNOTETWO)</sup>
172+
- [`Urllib3`](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-urllib3) <sup>[1](#FOOTNOTEONE)</sup> <sup>[2](#FOOTNOTETWO)</sup>
173173

174174
Logs
175175
- [Python logging library](https://docs.python.org/3/howto/logging.html) <sup>[4](#FOOTNOTEFOUR)</sup>
@@ -288,12 +288,12 @@ The following table represents the currently supported custom telemetry types:
288288
|-------------------------------------------|---------------|----------------|--------------|------------|------------|----------|--------|
289289
| **ASP.NET Core** | | | | | | | |
290290
| &nbsp;&nbsp;&nbsp;OpenTelemetry API | | Yes | Yes | Yes | | Yes | |
291-
| &nbsp;&nbsp;&nbsp;ILogger API | | | | | | | Yes |
291+
| &nbsp;&nbsp;&nbsp;`ILogger` API | | | | | | | Yes |
292292
| &nbsp;&nbsp;&nbsp;AI Classic API | | | | | | | |
293293
| | | | | | | | |
294294
| **Java** | | | | | | | |
295295
| &nbsp;&nbsp;&nbsp;OpenTelemetry API | | Yes | Yes | Yes | | Yes | |
296-
| &nbsp;&nbsp;&nbsp;Logback, Log4j, JUL | | | | Yes | | | Yes |
296+
| &nbsp;&nbsp;&nbsp;Logback, `Log4j`, JUL | | | | Yes | | | Yes |
297297
| &nbsp;&nbsp;&nbsp;Micrometer Metrics | | Yes | | | | | |
298298
| &nbsp;&nbsp;&nbsp;AI Classic API | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
299299
| | | | | | | | |
@@ -735,7 +735,7 @@ to draw attention in relevant experiences including the failures section and end
735735
}
736736
}
737737
```
738-
- To log an Exception using ILogger:
738+
- To log an Exception using `ILogger`:
739739
```csharp
740740
var logger = loggerFactory.CreateLogger(logCategoryName);
741741

@@ -771,7 +771,7 @@ to draw attention in relevant experiences including the failures section and end
771771
}
772772
}
773773
```
774-
- To log an Exception using ILogger:
774+
- To log an Exception using `ILogger`:
775775
```csharp
776776
var logger = loggerFactory.CreateLogger("ExceptionExample");
777777

@@ -1546,12 +1546,12 @@ span._attributes["enduser.id"] = "<User ID>"
15461546

15471547
#### [ASP.NET Core](#tab/aspnetcore)
15481548

1549-
OpenTelemetry uses .NET's ILogger.
1549+
OpenTelemetry uses .NET's `ILogger`.
15501550
Attaching custom dimensions to logs can be accomplished using a [message template](/dotnet/core/extensions/logging?tabs=command-line#log-message-template).
15511551

15521552
#### [.NET](#tab/net)
15531553

1554-
OpenTelemetry uses .NET's ILogger.
1554+
OpenTelemetry uses .NET's `ILogger`.
15551555
Attaching custom dimensions to logs can be accomplished using a [message template](/dotnet/core/extensions/logging?tabs=command-line#log-message-template).
15561556

15571557
#### [Java](#tab/java)
@@ -1564,7 +1564,7 @@ Logback, Log4j, and java.util.logging are [autoinstrumented](#logs). Attaching c
15641564

15651565
#### [Node.js](#tab/nodejs)
15661566

1567-
Attributes could be added only when calling manual track APIs only. Log attributes for console, bunyan and winston are currently not supported.
1567+
Attributes could be added only when calling manual track APIs only. Log attributes for console, bunyan and Winston are currently not supported.
15681568

15691569
```javascript
15701570
const config = new ApplicationInsightsConfig();
@@ -1904,7 +1904,7 @@ Get the request trace ID and the span ID in your code:
19041904
### [Node.js](#tab/nodejs)
19051905

19061906
- To review the source code, see the [Application Insights Beta GitHub repository](https://github.com/microsoft/ApplicationInsights-node.js/tree/beta).
1907-
- To install the npm package and check for updates, see the [applicationinsights npm Package](https://www.npmjs.com/package/applicationinsights/v/beta) page.
1907+
- To install the npm package and check for updates, see the [`applicationinsights` npm Package](https://www.npmjs.com/package/applicationinsights/v/beta) page.
19081908
- To become more familiar with Azure Monitor Application Insights and OpenTelemetry, see the [Azure Monitor Example Application](https://github.com/Azure-Samples/azure-monitor-opentelemetry-node.js).
19091909
- To learn more about OpenTelemetry and its community, see the [OpenTelemetry JavaScript GitHub repository](https://github.com/open-telemetry/opentelemetry-js).
19101910
- To enable usage experiences, [enable web or browser user monitoring](javascript.md).

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A connection string in Application Insights defines the target location for send
2323

2424
Use one of the following three ways to configure the connection string:
2525

26-
- Add `UseAzureMonitor()` to your application startup. Depending on your version of .NET, this will be in either your `startup.cs` or `program.cs` class.
26+
- Add `UseAzureMonitor()` to your application startup. Depending on your version of .NET, it is in either your `startup.cs` or `program.cs` class.
2727
```csharp
2828
var builder = WebApplication.CreateBuilder(args);
2929

@@ -235,13 +235,13 @@ useAzureMonitor(options);
235235

236236
Set the Cloud Role Name and the Cloud Role Instance via [Resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#resource-sdk) attributes. Cloud Role Name uses `service.namespace` and `service.name` attributes, although it falls back to `service.name` if `service.namespace` isn't set. Cloud Role Instance uses the `service.instance.id` attribute value. For information on standard attributes for resources, see [Resource Semantic Conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md).
237237
238-
Set Resource attributes using the `OTEL_RESOURCE_ATTRIBUTES` and/or `OTEL_SERVICE_NAME` environment variables. `OTEL_RESOURCE_ATTRIBUTES` takes series of comma-separated key-value pairs. For example, to set the Cloud Role Name to "my-namespace.my-helloworld-service" and set Cloud Role Instance to "my-instance", you can set `OTEL_RESOURCE_ATTRIBUTES` and `OTEL_SERVICE_NAME` as such:
238+
Set Resource attributes using the `OTEL_RESOURCE_ATTRIBUTES` and/or `OTEL_SERVICE_NAME` environment variables. `OTEL_RESOURCE_ATTRIBUTES` takes series of comma-separated key-value pairs. For example, to set the Cloud Role Name to `my-namespace.my-helloworld-service` and set Cloud Role Instance to `my-instance`, you can set `OTEL_RESOURCE_ATTRIBUTES` and `OTEL_SERVICE_NAME` as such:
239239
```
240240
export OTEL_RESOURCE_ATTRIBUTES="service.namespace=my-namespace,service.instance.id=my-instance"
241241
export OTEL_SERVICE_NAME="my-helloworld-service"
242242
```
243243

244-
If you do not set the `service.namespace` Resource attribute, you can alternatively set the Cloud Role Name with only the OTEL_SERVICE_NAME environment variable or the `service.name` Resource attribute. For example, to set the Cloud Role Name to "my-helloworld-service" and set Cloud Role Instance to "my-instance", you can set `OTEL_RESOURCE_ATTRIBUTES` and `OTEL_SERVICE_NAME` as such:
244+
If you don't set the `service.namespace` Resource attribute, you can alternatively set the Cloud Role Name with only the OTEL_SERVICE_NAME environment variable or the `service.name` Resource attribute. For example, to set the Cloud Role Name to `my-helloworld-service` and set Cloud Role Instance to `my-instance`, you can set `OTEL_RESOURCE_ATTRIBUTES` and `OTEL_SERVICE_NAME` as such:
245245
```
246246
export OTEL_RESOURCE_ATTRIBUTES="service.instance.id=my-instance"
247247
export OTEL_SERVICE_NAME="my-helloworld-service"
@@ -251,7 +251,7 @@ export OTEL_SERVICE_NAME="my-helloworld-service"
251251

252252
## Enable Sampling
253253

254-
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. For more information, see [Learn More about sampling](sampling.md#brief-summary).
254+
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. For more information, see [Learn More about sampling](sampling.md#brief-summary).
255255

256256
> [!NOTE]
257257
> Metrics and Logs are unaffected by sampling.
@@ -319,9 +319,9 @@ export OTEL_TRACES_SAMPLER_ARG=0.1
319319
> [!TIP]
320320
> When using fixed-rate/percentage sampling and you aren't sure what to set the sampling rate as, start at 5% (i.e., 0.05 sampling ratio) and adjust the rate based on the accuracy of the operations shown in the failures and performance blades. A higher rate generally results in higher accuracy. However, ANY sampling will affect accuracy so we recommend alerting on [OpenTelemetry metrics](opentelemetry-add-modify.md#metrics), which are unaffected by sampling.
321321

322-
## Enable Azure AD authentication
322+
## Enable Entra ID (formerly Azure AD) authentication
323323

324-
You might want to enable Azure Active Directory (Azure AD) Authentication for a more secure connection to Azure, which prevents unauthorized telemetry from being ingested into your subscription.
324+
You might want to enable Entra ID Authentication for a more secure connection to Azure, which prevents unauthorized telemetry from being ingested into your subscription.
325325

326326
#### [ASP.NET Core](#tab/aspnetcore)
327327

@@ -434,7 +434,7 @@ To improve reliability and resiliency, Azure Monitor OpenTelemetry-based offerin
434434

435435
### [ASP.NET Core](#tab/aspnetcore)
436436

437-
The Distro package includes the AzureMonitorExporter which by default uses one of the following locations for offline storage (listed in order of precedence):
437+
The Distro package includes the AzureMonitorExporter, which by default uses one of the following locations for offline storage (listed in order of precedence):
438438

439439
- Windows
440440
- %LOCALAPPDATA%\Microsoft\AzureMonitor
@@ -681,19 +681,19 @@ The following OpenTelemetry configurations can be accessed through environment v
681681

682682
| Environment variable | Description |
683683
| -------------------------- | -------------------------------------------------- |
684-
| `APPLICATIONINSIGHTS_CONNECTION_STRING` | Set this to the connection string for your Application Insights resource. |
685-
| `APPLICATIONINSIGHTS_STATSBEAT_DISABLED` | Set this to `true` to opt-out of internal metrics collection. |
686-
| `OTEL_RESOURCE_ATTRIBUTES` | Key-value pairs to be used as resource attributes. See the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. |
684+
| `APPLICATIONINSIGHTS_CONNECTION_STRING` | Set it to the connection string for your Application Insights resource. |
685+
| `APPLICATIONINSIGHTS_STATSBEAT_DISABLED` | Set it to `true` to opt-out of internal metrics collection. |
686+
| `OTEL_RESOURCE_ATTRIBUTES` | Key-value pairs to be used as resource attributes. For more information about resource attributes, see the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable). |
687687
| `OTEL_SERVICE_NAME` | Sets the value of the `service.name` resource attribute. If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES`, then `OTEL_SERVICE_NAME` takes precedence. |
688688

689689

690690
### [.NET](#tab/net)
691691

692692
| Environment variable | Description |
693693
| -------------------------- | -------------------------------------------------- |
694-
| `APPLICATIONINSIGHTS_CONNECTION_STRING` | Set this to the connection string for your Application Insights resource. |
695-
| `APPLICATIONINSIGHTS_STATSBEAT_DISABLED` | Set this to `true` to opt-out of internal metrics collection. |
696-
| `OTEL_RESOURCE_ATTRIBUTES` | Key-value pairs to be used as resource attributes. See the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. |
694+
| `APPLICATIONINSIGHTS_CONNECTION_STRING` | Set it to the connection string for your Application Insights resource. |
695+
| `APPLICATIONINSIGHTS_STATSBEAT_DISABLED` | Set it to `true` to opt-out of internal metrics collection. |
696+
| `OTEL_RESOURCE_ATTRIBUTES` | Key-value pairs to be used as resource attributes. For more information about resource attributes, see the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable). |
697697
| `OTEL_SERVICE_NAME` | Sets the value of the `service.name` resource attribute. If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES`, then `OTEL_SERVICE_NAME` takes precedence. |
698698

699699
### [Java](#tab/java)
@@ -706,7 +706,7 @@ For more information about OpenTelemetry SDK configuration, see the [OpenTelemet
706706
707707
### [Python](#tab/python)
708708

709-
For more information about OpenTelemetry SDK configuration, see the [OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/sdk-configuration). For additional details, see [Azure monitor Distro Usage](https://github.com/microsoft/ApplicationInsights-Python/tree/main/azure-monitor-opentelemetry#usage).
709+
For more information about OpenTelemetry SDK configuration, see the [OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/sdk-configuration) and [Azure monitor Distro Usage](https://github.com/microsoft/ApplicationInsights-Python/tree/main/azure-monitor-opentelemetry#usage).
710710
711711
---
712712

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ As part of using Application Insights instrumentation, we collect and send diagn
313313

314314
- For details on adding and modifying Azure Monitor OpenTelemetry, see [Add and modify Azure Monitor OpenTelemetry](opentelemetry-add-modify.md)
315315
- To review the source code, see the [Application Insights Beta GitHub repository](https://github.com/microsoft/ApplicationInsights-node.js/tree/beta).
316-
- To install the npm package and check for updates, see the [applicationinsights npm Package](https://www.npmjs.com/package/applicationinsights/v/beta) page.
316+
- To install the npm package and check for updates, see the [`applicationinsights` npm Package](https://www.npmjs.com/package/applicationinsights/v/beta) page.
317317
- To become more familiar with Azure Monitor Application Insights and OpenTelemetry, see the [Azure Monitor Example Application](https://github.com/Azure-Samples/azure-monitor-opentelemetry-node.js).
318318
- To learn more about OpenTelemetry and its community, see the [OpenTelemetry JavaScript GitHub repository](https://github.com/open-telemetry/opentelemetry-js).
319319
- To enable usage experiences, [enable web or browser user monitoring](javascript.md).

0 commit comments

Comments
 (0)