Skip to content

Commit 4c66c2d

Browse files
committed
Acrolinx fixes for OTel
1 parent 410eb60 commit 4c66c2d

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
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: 1 addition & 1 deletion
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

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).

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ There are two methods to instrument your application:
2929
- [Application Insights SDKs](asp-net-core.md)
3030
- [Azure Monitor OpenTelemetry Distros](opentelemetry-enable.md).
3131

32-
While we see OpenTelemetry as our future direction, we have no plans to stop collecting data from older SDKs. We still have a way to go before our Azure OpenTelemetry Distros [reach feature parity with our Application Insights SDKs](../faq.yml#what-s-the-current-release-state-of-features-within-the-azure-monitor-opentelemetry-distro-). In many cases, customers will continue to choose to use Application Insights SDKs for quite some time.
32+
While we see OpenTelemetry as our future direction, we have no plans to stop collecting data from older SDKs. We still have a way to go before our Azure OpenTelemetry Distros [reach feature parity with our Application Insights SDKs](../faq.yml#what-s-the-current-release-state-of-features-within-the-azure-monitor-opentelemetry-distro-). In many cases, customers continue to choose to use Application Insights SDKs for quite some time.
3333

3434
> [!IMPORTANT]
3535
> "Manual" doesn't mean you'll be required to write complex code to define spans for distributed traces, although it remains an option. Instrumentation Libraries packaged into our Distros enable you to effortlessly capture telemetry signals across common frameworks and libraries. We're actively working to [instrument the most popular Azure Service SDKs using OpenTelemetry](https://devblogs.microsoft.com/azure-sdk/introducing-experimental-opentelemetry-support-in-the-azure-sdk-for-net/) so these signals are available to customers who use the Azure Monitor OpenTelemetry Distro.
@@ -77,11 +77,11 @@ Microsoft worked with project stakeholders from two previously popular open-sour
7777

7878
For terminology, see the [glossary](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md) in the OpenTelemetry specifications.
7979

80-
Some legacy terms in Application Insights are confusing because of the industry convergence on OpenTelemetry. The following table highlights these differences. Eventually, OpenTelemetry terms will replace Application Insights terms.
80+
Some legacy terms in Application Insights are confusing because of the industry convergence on OpenTelemetry. The following table highlights these differences. OpenTelemetry terms are replacing Application Insights terms.
8181

8282
Application Insights | OpenTelemetry
8383
------ | ------
84-
Auto-collectors | Instrumentation libraries
84+
Autocollectors | Instrumentation libraries
8585
Channel | Exporter
8686
Codeless / Agent-based | Autoinstrumentation
8787
Traces | Logs

0 commit comments

Comments
 (0)