2829bd7ff2
Move ApplicationInsightsExtensions to Microsoft.Framework.DependencyInjection namespace |
||
|---|---|---|
| src/Microsoft.ApplicationInsights.AspNet | ||
| test | ||
| .gitattributes | ||
| .gitignore | ||
| ApplicationInsights.AspNet.sln | ||
| LICENSE | ||
| NuGet.config | ||
| Readme.md | ||
| global.json | ||
Readme.md
Microsoft Application Insights for Asp.Net vNext applications
This repository has a code for Application Insights monitoring of Asp.Net vNext applications. Read about contrubution policies on Application Insights Home repository
Getting Started
For standard Asp.Net template you need to modify four files (this will be the default template instrumentation in future).
project.json Add new reference:
"Microsoft.ApplicationInsights.AspNet": "0.30.0.1-beta"
config.json Configure instrumentation key:
"ApplicationInsights": {
"InstrumentationKey": "11111111-2222-3333-4444-555555555555"
}
Startup.cs Add service:
services.AddApplicationInsightsTelemetry(Configuration);
Add middleware and configure developer mode:
// Add Application Insights monitoring to the request pipeline as a very first middleware.
app.UseApplicationInsightsRequestTelemetry();
...
// Add the following to the request pipeline only in development environment.
if (string.Equals(env.EnvironmentName, "Development", StringComparison.OrdinalIgnoreCase))
{
app.SetApplicationInsightsTelemetryDeveloperMode();
}
...
// Add Application Insights exceptions handling to the request pipeline.
app.UseApplicationInsightsExceptionTelemetry();
_Layout.cshtml Define using and injection:
@using Microsoft.ApplicationInsights.AspNet
@inject Microsoft.ApplicationInsights.DataContracts.RequestTelemetry RequestTelelemtry
And insert HtmlHelper to the end of <head> section:
@Html.ApplicationInsightsJavaScriptSnippet(RequestTelelemtry.Context.InstrumentationKey);
</head>
Repository structure
root\
ApplicationInsights.AspNet.sln - Main Solution
src\
ApplicationInsights.AspNet - Application Insights package
test\
ApplicationInsights.AspNet.Tests - Unit tests
FunctionalTestUtils - test utilities for functional tests
SampleWebAppIntegration - functional MVC test application
Developing
- Repository (private now): https://github.com/microsoft/AppInsights-aspnetv5
- Asp.Net information: https://github.com/aspnet/home
- SDK is build with beta4 asp.net nuget packages so it cannot run with Visual Studio 2015 CTP6. You'll need to use dnx directly like explained in this article. Please note, that recently "k" was renamed to "dnx" - you'll need to adjust instructions accordingly.
Running and writing tests
There are two sets of tests unit tests and functional tests. Please use unit tests for all features testing. The purpose of functional tests is just end-to-end validation of functionality on sample applications.
Functional tests Functional tests are regular web applications with unit tests integrated into them. Application can be compiled as a regular web application as well as set of tests. Typical functional test will do the following:
- Host the current project in In-Proc server.
- Initialize application insights telemetry channel.
- Initiate request to self hosted web application using HttpClient.
- Check data received in telemetry channel.
Those are modifications made for regular web application to make it work this way:
Add dependencies to project.json:
"FunctionalTestUtils": "1.0.0-*",
"xunit.runner.aspnet": "2.0.0-aspnet-beta5-*",
and test command:
"test": "xunit.runner.aspnet"
Add this initialization logic to Startup.cs:
services.AddFunctionalTestTelemetryChannel();
Running Tests Open a developer command prompt, navigate to project folder and run:
dnx . test