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

Commit c4c6853

Browse files
committed
Make requested changes
1 parent c27c2d0 commit c4c6853

File tree

2 files changed

+31
-8
lines changed

2 files changed

+31
-8
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Verify platform compatibility
1414

1515
#. Verify that you are using a supported processor architecture. See :ref:`dotnet-otel-requirements`.
1616

17-
#. If you are instrumenting a Kubernetes cluster, verify that you are using a supported Kubernetes distribution. See :ref:`helm-chart-supported-distros`.
17+
#. If you are instrumenting applications in a Kubernetes cluster, verify that you are using a supported Kubernetes distribution. See :ref:`helm-chart-supported-distros`.
1818

19-
#. If you are instrumenting a Kubernetes cluster, review the prerequisites and requirements for installing the instrumentation using the Helm chart. See :new-page:`Auto-instrumentation <https://github.com/signalfx/splunk-otel-collector-chart/blob/d08f989180bcb0e1ec79b63805d8951472b8d230/docs/auto-instrumentation-install.md#steps-for-setting-up-auto-instrumentation>` in the Splunk OpenTelemetry Collector for Kubernetes repository on GitHub.
19+
#. If you are instrumenting applications in a Kubernetes cluster, review the prerequisites and requirements for installing the instrumentation using the Helm chart. See :new-page:`Auto-instrumentation <https://github.com/signalfx/splunk-otel-collector-chart/blob/d08f989180bcb0e1ec79b63805d8951472b8d230/docs/auto-instrumentation-install.md#steps-for-setting-up-auto-instrumentation>` in the Splunk OpenTelemetry Collector for Kubernetes repository on GitHub.
2020

2121
Verify .NET runtime compatibility
2222
=================================
@@ -26,7 +26,7 @@ Verify that you are using a supported version of .NET. See :ref:`dotnet-otel-ver
2626
Verify automatic discovery compatibility
2727
========================================
2828

29-
#. If you are instrumenting a Kubernetes cluster, verify automatic discovery compatibility between Kubernetes and .NET. See :ref:`k8s-backend-requirements`.
29+
#. If you are instrumenting applications in a Kubernetes cluster, verify automatic discovery compatibility between Kubernetes and .NET. See :ref:`k8s-backend-requirements`.
3030

3131
#. Verify automatic discovery Windows back-end compatibility. See :ref:`windows-backend-auto-discovery`.
3232

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

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,31 @@ The Splunk Distribution of OpenTelemetry .NET automatically instruments .NET app
1111

1212
You can install the .NET instrumentation manually or using the NuGet packages. The manual instructions include the option to use a guided setup. The NuGet packages are the best method for avoiding dependency version conflicts, but are not well-suited for instrumenting multiple applications running on the same machine. Review the :ref:`pre-checks <dotnet-pre-checks>` and the various installation procedures on this page to identify the best installation method for your application environment.
1313

14-
To learn about automatic discovery, see :ref:`discovery_mode`.
15-
1614
.. _otel-dotnet-nuget-pkg:
1715

1816
Install the OpenTelemetry .NET instrumentation using the NuGet packages
1917
=======================================================================
2018

2119
You can deploy the Splunk Distribution of the OpenTelemetry .NET instrumentation automatically using the official NuGet packages. Your instrumented application project must support NuGet packages.
2220

21+
NuGet package installation considerations
22+
-----------------------------------------
23+
2324
The following scenarios are ideal for using the NuGet packages:
2425

2526
* You control the application build but not the machine or container where the application is running.
2627
* 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.
2728
* You want to facilitate developer experimentation with automatic instrumentation through NuGet packages.
2829
* You need to solve version conflicts between the dependencies used by the application and the automatic instrumentation.
2930

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

3233
* You're unable to add the NuGet packages to the application project. This can be the case when instrumenting a third-party application.
3334
* You can't accommodate the increased disk use required by installing the NuGet packages separately for each instrumented application running on the same machine.
3435
* 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.
3536

37+
To install the distribution manually, see :ref:`otel-dotnet-manual-install`.
38+
3639
.. note::
3740

3841
For advanced configuration of the .NET automatic instrumentation, such as changing trace propagation formats or changing the endpoint URLs, see :ref:`advanced-dotnet-otel-configuration`.
@@ -64,7 +67,7 @@ Alternatively, you can set the ``SkippedInstrumentation`` property from the term
6467
6568
dotnet build -p:SkippedInstrumentations=StackExchange.Redis%3BMongoDB.Driver.Core
6669
67-
To distribute the appropriate native runtime components with your .NET application, specify a Runtime Identifier (RID) to build the application using ``dotnet build`` or ``dotnet publish``.
70+
To distribute the appropriate native runtime components with your .NET application, specify a Runtime Identifier (RID) to build the application using ``dotnet build`` or ``dotnet publish``. For more information, see :new-page:`.NET RID Catalog <https://learn.microsoft.com/en-us/dotnet/core/rid-catalog>` in the .NET documentation.
6871

6972
Both self-contained and framework-dependent applications are compatible with automatic instrumentation. See :new-page:`.NET application publishing overview <https://learn.microsoft.com/en-us/dotnet/core/deploying/>` in the .NET documentation for more information.
7073

@@ -93,15 +96,35 @@ The instrumentation procedure in the previous section produces launch scripts in
9396
- Windows: ``splunk-launch.cmd dotnet <application>``.
9497
- Linux: ``splunk-launch.sh dotnet <application>``.
9598

99+
.. _otel-dotnet-manual-install:
100+
96101
Install the Splunk Distribution of OpenTelemetry .NET manually
97102
==============================================================
98103

99104
You can deploy the Splunk Distribution of OpenTelemetry .NET instrumentation manually, using either the guided setup or the step-by-step instructions below.
100105

101-
The primary benefit to installing manually is that doing so enables you to instrument multiple .NET applications that run in the same environment. The primary limitation is that there is an increased likelihood of version conflicts between the dependencies used by the application and the automatic instrumentation.
106+
Manual installation considerations
107+
----------------------------------
108+
109+
The following scenarios are ideal for manually installing the .NET instrumentation:
110+
111+
* You're unable to add the NuGet packages to the application project. This can be the case when instrumenting a third-party application.
112+
* You can't accommodate the increased disk use required by installing the NuGet packages separately for each instrumented application running on the same machine.
113+
* 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.
114+
115+
However, you should consider using the NuGet packages if any of the following apply to your environment:
116+
117+
* You control the application build but not the machine or container where the application is running.
118+
* 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.
119+
* You want to facilitate developer experimentation with automatic instrumentation through NuGet packages.
120+
* You need to solve version conflicts between the dependencies used by the application and the automatic instrumentation.
102121

103122
To install the distribution using the official NuGet packages, see :ref:`otel-dotnet-nuget-pkg`.
104123

124+
.. note::
125+
126+
For advanced configuration of the .NET automatic instrumentation, such as changing trace propagation formats or changing the endpoint URLs, see :ref:`advanced-dotnet-otel-configuration`.
127+
105128
Generate customized instructions using the guided setup
106129
-------------------------------------------------------
107130

0 commit comments

Comments
 (0)