Skip to content
The .NET/.NET Core instrument agent for Apache SkyWalking
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add GitHub template (#27) Apr 23, 2018
benchmark/SkyApm.Benchmark
build Feature (#189) Apr 10, 2019
docs Add how-to-build docs (#172) Mar 27, 2019
sample Feature/clr metrics (#185) Apr 9, 2019
scripts
src Use ReadOnlySpan<char> Improve performance after .netcoreapp2.1 (#192) Apr 15, 2019
test/SkyApm.Core.Tests
.gitignore
.gitmodules
CONTIBUTING.md Change copyright and the link (#148) Feb 16, 2019
LICENSE Initial commit Feb 6, 2018
NuGet.config
README.md
appveyor.yml
build.cake
skyapm-dotnet.sln

README.md

SkyAPM C#/.NET instrument agent

Sky Walking logo

Apache SkyWalking is an APM designed for microservices, cloud native and container-based (Docker, K8s, Mesos) architectures. SkyAPM-dotnet provides the native support agent in C# and .NETStandard platform, with the helps from Apache SkyWalking committer team.

issues pulls releases Gitter Twitter Follow

CI Build Status

Platform Build Server Master Status
AppVeyor Windows/Linux Build status

Nuget Packages

Package Name NuGet MyGet Downloads
SkyAPM.Agent.AspNetCore nuget myget stats
SkyAPM.Agent.AspNet nuget myget

MyGet feed URL https://www.myget.org/F/skyapm-dotnet/api/v3/index.json

Supported

Features

A quick list of SkyWalking .NET Core Agent's capabilities

  • Application Topology
  • Distributed Tracing
  • ASP.NET Core Diagnostics
  • HttpClient Diagnostics
  • EntityFrameworkCore Diagnostics

Getting Started

Deploy SkyWalking Collector

Requirements

  • SkyWalking Collector 5.0.0-beta or higher. See SkyWalking backend deploy docs.
  • SkyWalking 6 backend is compatible too. The deployment doc is here. If you are new user, recommand you to read the whole official documents

Install SkyWalking .NET Core Agent

You can run the following command to install the SkyWalking .NET Core Agent in your project.

dotnet add package SkyAPM.Agent.AspNetCore

How to use

Set the ASPNETCORE_HOSTINGSTARTUPASSEMBLIES environment variable to support the activation of the SkyAPM .NET Core Agent.

  • Add the assembly name of SkyAPM.Agent.AspNetCore to the ASPNETCORE_HOSTINGSTARTUPASSEMBLIES environment variable.

Examples

  • On windows
dotnet new mvc -n sampleapp
cd sampleapp
dotnet add package SkyAPM.Agent.AspNetCore
set ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore
set SKYWALKING__SERVICENAME=sample_app
dotnet run
  • On macOS/Linux
dotnet new mvc -n sampleapp
cd sampleapp
dotnet add package SkyAPM.Agent.AspNetCore
export ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore
export SKYWALKING__SERVICENAME=sample_app
dotnet run

Configuration

Install SkyAPM.DotNet.CLI

dotnet tool install -g SkyAPM.DotNet.CLI

Use dotnet skyapm config [your_service_name] [your_servers] to generate config file.

dotnet skyapm config sample_app 192.168.0.1:11800

Roadmap

What are we going to do next?

Contributing

This section is in progress here: Contributing to SkyAPM-dotnet

Contact Us

  • Submit an issue
  • Gitter English
  • QQ Group(cn): 392443393

License

Apache 2.0 License.

You can’t perform that action at this time.