Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit a634a8e

Browse files
committed
Make changes requested by Max.
1 parent 805c26d commit a634a8e

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

gdi/get-data-in/application/otel-dotnet/instrumentation/dotnet-pre-checks.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Before installing the .NET automatic instrumentation, complete the following pre
1212
Verify platform compatibility
1313
=============================
1414

15+
Make sure that your platform is compatible with the OpenTelemetry Collector. See the following table for action items corresponding to your platform:
16+
1517
.. list-table::
1618
:widths: 25 75
1719
:width: 100
@@ -34,6 +36,8 @@ Verify that you are using a supported version of .NET. See :ref:`dotnet-otel-ver
3436
Verify automatic discovery compatibility
3537
========================================
3638

39+
Make sure that your platform is compatible with automatic discovery. See the following table for details:
40+
3741
.. list-table::
3842
:widths: 25 75
3943
:width: 100
@@ -51,13 +55,17 @@ Verify automatic discovery compatibility
5155
Review core dependencies
5256
========================
5357

58+
Make sure that your application's dependencies are compatible with the .NET instrumentation.
59+
5460
#. Verify whether your target applications have the same dependencies as the automatic instrumentation. See :new-page:`OpenTelemetry.AutoInstrumentation <https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation/OpenTelemetry.AutoInstrumentation.csproj>` and :new-page:`OpenTelemetry.AutoInstrumentation.AdditionalDeps <https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/src/OpenTelemetry.AutoInstrumentation.AdditionalDeps/Directory.Build.props>`. If there are conflicts, consider installing using the NuGet packages. Otherwise, you must resolve all the dependencies before manually installing the instrumentation.
5561

5662
#. Verify whether your target applications have the same dependencies as the NuGet packages. See the :new-page:`NuGet dependencies <https://www.nuget.org/packages/OpenTelemetry.AutoInstrumentation/#dependencies-body-tab>` in the NuGet documentation. If there are conflicts, you must resolve them before installing the instrumentation using the NuGet packages.
5763

5864
Review supported libraries
5965
==========================
6066

67+
Make sure that your target application uses supported libraries. Complete the following steps:
68+
6169
#. Review the list of automatically instrumented libraries supported by the Splunk distribution of the OpenTelemetry .NET instrumentation. See :ref:`supported-dotnet-otel-libraries`.
6270

6371
#. Review the community-supported extended list of automatically instrumented libraries in the OpenTelemetry Ecosystem. See the :new-page:`OpenTelemetry Registry <https://opentelemetry.io/ecosystem/registry/?language=dotnet&component=instrumentation>`.

gdi/get-data-in/application/otel-dotnet/instrumentation/instrument-dotnet-application.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ The following scenarios are ideal for using the NuGet packages:
2828
* You want to facilitate developer experimentation with automatic instrumentation through NuGet packages.
2929
* You need to solve version conflicts between the dependencies used by the application and the automatic instrumentation.
3030

31-
However, you shouldn't use the NuGet packages if any of the following apply to your environment:
31+
Don't use the NuGet packages if any of the following apply to your environment:
3232

3333
* You're unable to add the NuGet packages to the application project. This can be the case when instrumenting a third-party application.
3434
* You can't accommodate the increased disk use required by installing the NuGet packages separately for each instrumented application running on the same machine.
3535
* You need to instrument a legacy application that can't be migrated to the SDK-style project. To verify whether your project is SDK style, see `Identify the project format <https://learn.microsoft.com/en-us/nuget/resources/check-project-format>`__ in the NuGet documentation.
3636

37-
To install the distribution manually, see :ref:`otel-dotnet-manual-install`.
37+
If your scenario isn't compatible with NuGet package installation, install the distribution manually. See :ref:`otel-dotnet-manual-install`.
3838

3939
.. note::
4040

@@ -78,7 +78,7 @@ The instrumentation procedure in the previous section produces launch scripts in
7878

7979
#. Identify the launch script in your build output.
8080

81-
#. Optional. If you want to verify that the instrumentation is working by viewing the telemetry data output in your console, set the following environment variables to ``true``:
81+
#. (Optional) If you want to verify that the instrumentation is working by viewing the telemetry data output in your console, set the following environment variables to ``true``:
8282

8383
* ``OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED``
8484
* ``OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED``
@@ -112,7 +112,7 @@ The following scenarios are ideal for manually installing the .NET instrumentati
112112
* You can't accommodate the increased disk use required by installing the NuGet packages separately for each instrumented application running on the same machine.
113113
* You need to instrument a legacy application that can't be migrated to the SDK-style project. To verify whether your project is SDK style, see `Identify the project format <https://learn.microsoft.com/en-us/nuget/resources/check-project-format>`__ in the NuGet documentation.
114114

115-
However, you should consider using the NuGet packages if any of the following apply to your environment:
115+
Consider using the NuGet packages if any of the following apply to your environment:
116116

117117
* You control the application build but not the machine or container where the application is running.
118118
* You're instrumenting a self-contained application. See :new-page:`Publish self-contained <https://learn.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained>` in the .NET documentation.

0 commit comments

Comments
 (0)