open-telemetry
/
opentelemetry-dotnet-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Better styling for notes and warnings (#2287)

This commit is contained in:
Piotr Kiełkowicz 2023-03-03 17:16:54 +01:00 committed by GitHub
parent c61d8fa549
commit 41ef36178c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README.md
View File

@ -96,6 +96,7 @@ the executable.
Download and extract the appropriate binaries from Download and extract the appropriate binaries from
[the latest release](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest). [the latest release](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest).
> **Note**
> The path where you put the binaries is referenced as `$INSTALL_DIR` > The path where you put the binaries is referenced as `$INSTALL_DIR`
### Instrument a .NET application ### Instrument a .NET application

3
docs/config.md
View File

@ -253,7 +253,8 @@ Important environment variables include:
### Prometheus ### Prometheus
> ⚠️ **Do NOT use in production.** > **Warning**
> **Do NOT use in production.**
> >
> Prometheus exporter is intended for the inner dev loop. > Prometheus exporter is intended for the inner dev loop.
> Production environments can use a combination of OTLP exporter > Production environments can use a combination of OTLP exporter

4
docs/developing.md
View File

@ -153,7 +153,8 @@ You can also find the exported telemetry in `dev/log` directory.
### Instrument an application ### Instrument an application
> *Warning:* Make sure to build and prepare the test environment beforehand. > **Warning**
> Make sure to build and prepare the test environment beforehand.
You can reuse [`instrument.sh`](../instrument.sh) to export profiler You can reuse [`instrument.sh`](../instrument.sh) to export profiler
environmental variables to your current Shell session: environmental variables to your current Shell session:
@ -200,6 +201,7 @@ To update set of the version modify [`PackageVersionDefinitions.cs`](../tools/Li
execute [`LibraryVersionsGenerator`](../tools/LibraryVersionsGenerator/LibraryVersionsGenerator.csproj), execute [`LibraryVersionsGenerator`](../tools/LibraryVersionsGenerator/LibraryVersionsGenerator.csproj),
and commit generated files. and commit generated files.
> **Note**
> `TestApplication.AspNet.NetFramework` is an exception to this strategy > `TestApplication.AspNet.NetFramework` is an exception to this strategy
> as it would not work well, because of multiple dependent packages. > as it would not work well, because of multiple dependent packages.
> `TestApplication.AspNet.NetFramework` references the latest versions > `TestApplication.AspNet.NetFramework` references the latest versions

5
docs/iis-instrumentation.md
View File

@ -16,10 +16,12 @@ Install-OpenTelemetryCore
Register-OpenTelemetryForIIS Register-OpenTelemetryForIIS
``` ```
⚠️ `Register-OpenTelemetryForIIS` performs IIS restart. > **Warning**
> `Register-OpenTelemetryForIIS` performs IIS restart.
### Add TelemetryHttpModule ASP.NET HTTP module ### Add TelemetryHttpModule ASP.NET HTTP module
> **Note**
> This is NOT required for ASP.NET Core deployments. > This is NOT required for ASP.NET Core deployments.
This step is necessary only for ASP.NET (.NET Framework). This step is necessary only for ASP.NET (.NET Framework).
@ -62,6 +64,7 @@ to set it for all ASP.NET application running in Integrated Pipeline Mode:
## Configuration ## Configuration
> **Note**
> Remember to restart IIS after making configuration changes. > Remember to restart IIS after making configuration changes.
> You can do it by executing `iisreset.exe`. > You can do it by executing `iisreset.exe`.

4
docs/windows-service-instrumentation.md
View File

@ -16,10 +16,12 @@ Install-OpenTelemetryCore
Register-OpenTelemetryForWindowsService -WindowsServiceName "WindowsServiceName" -OTelServiceName "MyServiceDisplayName" Register-OpenTelemetryForWindowsService -WindowsServiceName "WindowsServiceName" -OTelServiceName "MyServiceDisplayName"
``` ```
⚠️ `Register-OpenTelemetryForWindowsService` performs a service restart. > **Warning**
> `Register-OpenTelemetryForWindowsService` performs a service restart.
## Configuration ## Configuration
> **Note**
> Remember to restart the Windows Service after making configuration changes. > Remember to restart the Windows Service after making configuration changes.
> You can do it by executing > You can do it by executing
> `Restart-Service -Name $WindowsServiceName -Force` in PowerShell. > `Restart-Service -Name $WindowsServiceName -Force` in PowerShell.