Skip to content

Commit df95d1d

Browse files
authored
Merge pull request #249 from xiaomi7732/dev/saars/update-readme-for-ai-sdk-3
Update README for 3.0.2 release and Application Insights SDK 2.x guidance
2 parents 92a9ab4 + 2653751 commit df95d1d

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,22 @@
55

66
## Announcement
77

8-
* Upgrade to [2.7.0](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.7.0). Reduced the telemetry noise. Check out the details in the [release notes](https://github.com/microsoft/ApplicationInsights-Profiler-AspNetCore/releases/tag/v2.7.0).
9-
10-
* Running inside Azure Fucntion? Follow [this example](./examples/EnableServiceProfilerForAzureFunction).
8+
* [3.0.2](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/3.0.2) is now available. Starting from this version, only Application Insights SDK 2.x is supported. If you are using Application Insights SDK 3.x (OpenTelemetry-based), please use [Azure Monitor OpenTelemetry Profiler for .NET](https://github.com/Azure/azuremonitor-opentelemetry-profiler-net) instead.
119

1210
## Previous announcements
1311

12+
* Upgrade to [2.7.0](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.7.0). Reduced the telemetry noise. Check out the details in the [release notes](https://github.com/microsoft/ApplicationInsights-Profiler-AspNetCore/releases/tag/v2.7.0).
13+
14+
* Running inside Azure Function? Follow [this example](./examples/EnableServiceProfilerForAzureFunction).
15+
1416
* Worker service support is in beta testing now.
1517
* Check out [the example](./examples/ServiceProfilerInWorkerNet6/Readme.md) for package info and the instructions.
1618

1719
## Description
1820

1921
Welcome to the home page of `Microsoft Application Insights Profiler for ASP.NET Core`. Enable profiler, integrate seamlessly with your Application Insights resource, and unlock powerful [Code Optimizations](https://learn.microsoft.com/azure/azure-monitor/insights/code-optimizations-profiler-overview#code-optimizations) for your .NET applications.
2022

21-
> ⭐ Not sure which `Profiler Agent` is right for you? Check out our [Profiler Agent Selection Guide](https://github.com/Azure/azuremonitor-opentelemetry-profiler-net/blob/main/docs/ProfilerAgentSelectionGuide.md) to help you choose the best option for your needs.
23+
> ⚠️ **This package supports Application Insights SDK 2.x only.** If you are using Application Insights SDK 3.x (OpenTelemetry-based), use [Azure Monitor OpenTelemetry Profiler for .NET](https://github.com/Azure/azuremonitor-opentelemetry-profiler-net) instead. See the [Profiler Agent Selection Guide](https://github.com/Azure/azuremonitor-opentelemetry-profiler-net/blob/main/docs/ProfilerAgentSelectionGuide.md) for details.
2224
2325
![Profiler Traces](./media/profiler-traces.png)
2426

@@ -57,7 +59,7 @@ Welcome to the home page of `Microsoft Application Insights Profiler for ASP.NET
5759

5860
1. **Optionally, Add a Bottleneck**
5961

60-
* Add a reference to `HeavyArrayForcast`, for example, in [QuickStart3_1.csproj](examples/QuickStart3_1/QuickStart3_1.csproj):
62+
* Add a reference to `HeavyArrayForecast`, for example, in [QuickStart3_1.csproj](examples/QuickStart3_1/QuickStart3_1.csproj):
6163

6264
```xml
6365
<ItemGroup>
@@ -130,7 +132,7 @@ Welcome to the home page of `Microsoft Application Insights Profiler for ASP.NET
130132

131133
_Note that it may take a few hours for Code Optimizations to appear._
132134

133-
![Code Optiizations](./media/CodeOptimizations.png)
135+
![Code Optimizations](./media/CodeOptimizations.png)
134136

135137
For more information, refer to the [Code Optimizations Documentation](https://aka.ms/CodeOptimizations/Docs).
136138

@@ -140,10 +142,10 @@ Welcome to the home page of `Microsoft Application Insights Profiler for ASP.NET
140142

141143
## Next Steps
142144

143-
* [Profiler Configurations](./Configurations.md) - Customize profiler settings.
145+
* [Profiler Configurations](./Configurations.md) - Customize profiler settings.
144146
* [Dockerize with Profiler](./examples/QuickStart3_0/Readme2.md)
145147
* [Profiler Sessions](./ProfilerSessions.md) - Details on profiler operations.
146-
* [Trace Analysis](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-profiler-overview?toc=/azure/azure-monitor/toc.json#view-profiler-data) - Learn about trace analysis. For example, what does `AWAIT TIME`, `Blocked time`, `Unmanaged Async` means, etc.
148+
* [Trace Analysis](https://learn.microsoft.com/en-us/azure/application-insights/app-insights-profiler-overview?toc=/azure/azure-monitor/toc.json#view-profiler-data) - Learn about trace analysis. For example, what do `AWAIT TIME`, `Blocked time`, `Unmanaged Async` mean, etc.
147149
* [Diagnosing High CPU Usage](https://github.com/Azure/azure-diagnostics-tools/blob/master/Profiler/TriggerProfiler.md).
148150
* [Call tree filter](https://github.com/Azure/azure-diagnostics-tools/blob/master/Profiler/CallTreeFilter.md).
149151

@@ -163,7 +165,7 @@ Refer to the [Support Matrix](./SupportMatrix.md) to determine the appropriate p
163165

164166
## References
165167

166-
* [Profile ASP.NET Core Azure Linux web apps with Application Insights Profiler](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-profiler-aspnetcore-linux)
168+
* [Profile ASP.NET Core Azure Linux web apps with Application Insights Profiler](https://learn.microsoft.com/en-us/azure/application-insights/app-insights-profiler-aspnetcore-linux)
167169

168170
## CAUTION
169171

0 commit comments

Comments
 (0)