/ApplicationInsights-dotnet-server

Microsoft Application Insights for .NET Web Applications

Primary LanguageC#MIT LicenseMIT

Build Status codecov.io

NuGet packages

Visual Studio Application Insights SDK for .NET Web Applications

The code in this repository is the .NET web application SDK for Application Insights. Application Insights is a service that lets you monitor your live application's performance and usage. This SDK sends telemetry to the service. It collects data such as web request timings and success rates, dependency calls, exceptions, and server performance counters. You can also use the SDK to send your own telemetry and add modules to collect logs. You can use this SDK in any .NET web application, hosted either on your own servers or on Microsoft Azure.

Get the SDK

The SDK is installed on each project by the Application Insights tools in Visual Studio (2013 and later).

To add Application Insights to your project in Visual Studio:

  • If you're creating a new project, check Add Application Insights in the New Project dialog.
  • If it's an existing project, right-click your project in Solution Explorer and select Add Application Insights or Update Application Insights.
  • If these options aren't available for your project type, use Extension Manager in Visual Studio to install or update the NuGet package. Create a new Application Insights resource in the Azure portal, obtain its instrumentation key, and insert that in ApplicationInsights.config.

Run your project, and then open your Application Insights resource in the Azure Preview Portal and look for events.

To upgrade to the latest SDK

  • After you upgrade, you'll need to merge back any customizations you made to ApplicationInsights.config. If you're unsure whether you customized it, create a new project, add Application Insights to it, and compare your .config file with the one in the new project. Make a note of any differences.
  • In Solution Explorer, right-click your project and choose Manage NuGet packages.
  • Set the filter to show Updates.
  • Select Microsoft.ApplicationInsights.Web and choose Update. (This will also upgrade all the dependent packages.)
  • Compare ApplicationInsights.config with the old copy. Most of the changes you'll see are because we removed some modules and made others parameterizable. Reinstate any customizations you made to the old file.
  • Rebuild your solution.

To build

Follow contributor's guide

Branches

  • master contains the latest published release located on NuGet.
  • develop contains the code for the next release.

Shared Projects

Our projects target multiple frameworks (ex: Net45 & NetCore). We have framework specific projects and a shared project for common files between them. (ex: Perf.Net45, Perf.NetCore, Perf.Shared). If a file is used by both frameworks, we prefer to store that file in a Shared project and use preprocessor directives to separate framework specific code (ex: #if NETCORE, #if !NETCORE). We also use a conditional ItemGroup to assign files to a framework (ex: ItemGroup Condition=" '$(TargetFramework)' != 'netcoreapp1.0' ").

We've found that this makes our projects easier to maintain because it keeps Framework assignments in a single project. As an added bonus our Framework specific projects can include a single Shared project instead of individual files, which keeps our project files neat and clean.

Contributing

We strongly welcome and encourage contributions to this project. Please read the contributor's guide. If making a large change we request that you open an issue first. If we agree that an issue is a bug, we'll add the "bug" label, and issues that we plan to fix are labeled with an iteration number. We follow the Git Flow approach to branching.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.