easeagent-sdk-net

• easeagent-sdk-net
  • Overview
    • Principles
  • Features
  • QuickStart
    • 1. Installing via dotnet
    • 2. Init Agent
    • 3. Http Server Span
  • Documentation
  • Example
  • About MegaEase Cloud
  • Community
  • Licenses

A lightweight & opening .NET SDK for Cloud-Native and APM system

Overview

• EaseAgent SDK can collect distributed application tracing, which could be used in the APM system and improve the observability of a distributed system. for the tracing, EaseAgent SDK follows the Google Dapper paper and use zipkin4net core library.
• EaseAgent SDK also can work with Cloud-Native architecture.
• EaseAgent SDK also can work with MegaEase Cloud. For example, it can monitor for service by .NET Docker APP.

Principles

• Safe to .NET application/service.
• Highly extensible, users can easily do extensions through the api
• Design for Micro-Service architecture, collecting the data from a service perspective.

Features

• Easy to use. It is right out of the box for Http Server Tracing.

  • Collecting Tracing Logs.
    • Http Server
    • Client
  • Decorate the Span API for Middleware

• Data Reports

  • Console Reporter.
  • Http Reporter.

• Standardization

  • The tracing data format is fully compatible with the Zipkin data format.

QuickStart

First production ready, simple and full Easeagent SDK implementation without dependencies.

1. Installing via dotnet

easeagent-sdk-net can be installed via dotnet:

$ dotnet add package easeagent --version 0.0.1

2. Init Agent

// register tracing agent from yaml file.
// If you want to publish the `docker app` through the `cloud of megaease` and send the monitoring data to the `cloud`, 
// please obtain the configuration file path through the environment variable `EASEAGENT_CONFIG`.
// We will pass it to you the `cloud configuration` file path.
easeagent.Agent.RegisterFromYaml(Environment.GetEnvironmentVariable("EASEAGENT_CONFIG"));//by default: Console Reporter

//On shutdown
easeagent.Agent.Stop();

3. Http Server Span

using zipkin4net.Middleware;
app.UseTracing(easeagent.Agent.GetServiceName());

Documentation

About Config

Example

Obs. for a more complete frontend/backend example.

About MegaEase Cloud

1. Use SDK in MegaEase Cloud
2. Get MegaEase Cloud Config. About MegaEase Cloud Config
3. Decorate the Span. please use api: Agent.RecordMiddleware for decorate Span.

Community

• Github Issues
• Join Slack Workspace for requirement, issue and development.
• MegaEase on Twitter

If you have any questions, welcome to discuss them in our community. Welcome to join!

Licenses

EaseAgent .NET SDK is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.