Commit 9800a38f authored by Liuhaoyang's avatar Liuhaoyang

Update README.md

parent d049ef48
# Contributing to skywalking-csharp
\ No newline at end of file
# Contributing to skywalking-netcore
One of the easiest ways to contribute is to participate in discussions and discuss issues. You can also contribute by submitting pull requests with code changes.
## General feedback and discussions?
Please start a discussion on the [issue tracker](https://github.com/OpenSkywalking/skywalking-netcore/issues).
\ No newline at end of file
......@@ -3,20 +3,86 @@ SkyWalking C#/.NET instrument agent
<img src="https://skywalkingtest.github.io/page-resources/3.0/skywalking.png" alt="Sky Walking logo" height="90px" align="right" />
Apache SkyWalking is an APM designed for microservices, cloud native and container-based (Docker, K8s, Mesos) architectures. **SkyWalking-csharp** provides a compatible agent in C# and .NET platform.
[Apache SkyWalking](https://github.com/apache/incubator-skywalking) is an APM designed for microservices, cloud native and container-based (Docker, K8s, Mesos) architectures. **SkyWalking-netcore** provides a compatible agent in C# and .NETStandard platform.
[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
[![Build status](https://ci.appveyor.com/api/projects/status/fl6vucwfn1vu94dv/branch/master?svg=true)](https://ci.appveyor.com/project/wu-sheng/skywalking-csharp/branch/master)
# Status
[@lemon](https://github.com/liuhaoyang) is working with Apache SkyWalking official PMC team for our first release. Welcome anyone to join us.
# Supported .NET versions
This project currently supports apps targeting netstandard2.0 or higher.
# Contributing Guide
This section is in progress here: [Contributing to skywalking-csharp](/CONTIBUTING.md)
# Features
A quick list of SkyWalking .NET Core Agent's capabilities
- Application Topology
- Distributed Tracing
- ASP.NET Core Diagnostics
- HttpClientFactory Diagnostics
# Getting Started
### Deploy SkyWalking Collector
#### Requirements
- JDK 8+
#### Download
- [apache-skywalking-for-netcore-0.1](https://github.com/OpenSkywalking/skywalking-netcore/releases)
#### Deploy
- [Deploy-backend-in-standalone-mode](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-backend-in-standalone-mode.md#quick-start)
### Install SkyWalking .NET Core Agent
You can run the following command to install the SkyWalking .NET Core Agent in your project.
```
PM> Install-Package SkyWalking.AspNetCore
```
### Configuration
First,You need to config SkyWalking in your Startup.cs:
```
public void ConfigureServices(IServiceCollection services)
{
//......
services.AddSkyWalking(option =>
{
// Application code is showed in sky-walking-ui
option.DirectServers = "localhost:11800";
//Collector agent_gRPC/grpc service addresses.
option.ApplicationCode = "Your_ApplicationName";
});
}
```
### HttpClientFactory
```
[Route("api/[controller]")]
public class ValuesController : Controller
{
[HttpGet("{id}")]
public async Task<string> Get(int id, [FromServices] IHttpClientFactory httpClientFactory)
{
var httpClient = httpClientFactory.CreateClient("sw-tracing");
return await httpClient.GetStringAsync("http://api.xxx.com/values");
}
}
```
# Contributing
This section is in progress here: [Contributing to skywalking-netcore](/CONTIBUTING.md)
# Roadmap
Expect to release 0.1 compatible with SkyWalking 5.0.0-alpha in May. 2018
Expect to release 0.2 compatible in May. 2018
#### Support Framework
- [EntityFrameworkCore](https://github.com/aspnet/EntityFrameworkCore)
- [.NET Core BCL types (HttpClient and SqlClient)](https://github.com/dotnet/corefx)
- [CAP](https://github.com/dotnetcore/CAP)
# Contact Us
* Submit an issue
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment