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
    SkyAPM.Agent.GeneralHost nuget myget

    MyGet feed URL



    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


    • 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.


    • On windows
    dotnet new mvc -n sampleapp
    cd sampleapp
    dotnet add package 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 SKYWALKING__SERVICENAME=sample_app
    dotnet run


    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


    What are we going to do next?


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

    Contact Us

    • Submit an issue

    If you have issues about SkyWalking protocol, its official backend, ask questions at their Apache official channels. All following channels are not suitable for .net agent, but good if you are facing backend/UI issues.

    • Submit an official Apache SkyWalking issue.
    • Mail list: Mail to, follow the reply to subscribe the mail list.
    • Join skywalking channel at Apache Slack. If the link is not working, find the latest one at Apache INFRA WIKI.
    • QQ Group: 392443393(2000/2000, not available), 901167865(available)


    Apache 2.0 License.


    The .NET/.NET Core instrument agent for Apache SkyWalking



    贡献者 19



    • C# 98.6 %
    • PowerShell 1.4 %
    • CoffeeScript 0.0 %