Skip to content

Commit

Permalink
Change copyright and the link (#148)
Browse files Browse the repository at this point in the history
* rename skywalking-netcore to skyapm-dotnet

* rename namespace

* rename project name

* rm

* update protocol submodule

* Update CI

* change file header

* update sample

* add config

* Add sample config file

* Update docs
  • Loading branch information
liuhaoyang committed Feb 16, 2019
1 parent e571c50 commit 4c25789
Show file tree
Hide file tree
Showing 239 changed files with 1,149 additions and 1,278 deletions.
7 changes: 4 additions & 3 deletions .gitmodules
@@ -1,3 +1,4 @@
[submodule "src/SkyWalking.Transport.Grpc.Protocol/protocol"]
path = src/SkyWalking.Transport.Grpc.Protocol/protocol
url = https://github.com/apache/incubator-skywalking-data-collect-protocol.git

[submodule "src/SkyApm.Transport.Grpc.Protocol/protocol"]
path = src/SkyApm.Transport.Grpc.Protocol/protocol
url = https://github.com/apache/incubator-skywalking-data-collect-protocol
4 changes: 2 additions & 2 deletions CONTIBUTING.md
@@ -1,6 +1,6 @@
# Contributing to skywalking-netcore
# Contributing to SkyAPM-dotnet

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).
Please start a discussion on the [issue tracker](https://github.com/SkyAPM/SkyAPM-dotnet/issues).
2 changes: 1 addition & 1 deletion NuGet.config
Expand Up @@ -2,6 +2,6 @@
<configuration>
<packageSources>
<add key="nuget" value="https://api.nuget.org/v3/index.json" />
<add key="skywalking-netcore-vnext" value="https://www.myget.org/F/skywalking/api/v3/index.json" />
<add key="skyapm-dotnet-vnext" value="https://www.myget.org/F/skyapm-dotnet/api/v3/index.json" />
</packageSources>
</configuration>
79 changes: 47 additions & 32 deletions README.md
Expand Up @@ -3,14 +3,29 @@ SkyAPM C#/.NET instrument agent

<img src="https://skyapmtest.github.io/page-resources/SkyAPM/skyapm.png" alt="Sky Walking logo" height="90px" align="right" />

[Apache SkyWalking](https://github.com/apache/incubator-skywalking) is an APM designed for microservices, cloud native and container-based (Docker, K8s, Mesos) architectures. **SkyAPM-netcore** provides the native support agent in C# and .NETStandard platform, with the helps from Apache SkyWalking committer team.
[Apache SkyWalking](https://github.com/apache/incubator-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.

[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
![](https://img.shields.io/github/issues-raw/skyapm/skyapm-dotnet.svg?style=flat-square)
![](https://img.shields.io/github/issues-pr-raw/skyapm/skyapm-dotnet.svg?style=flat-square)
![](https://img.shields.io/github/release/skyapm/skyapm-dotnet.svg?style=flat-square)
![](https://img.shields.io/gitter/room/openskywalking/lobby.svg?style=flat-square)
[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=flat-square&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)
## CI Build Status

| Platform | Build Server | Master Status |
|--------- |------------- |---------|
| AppVeyor | Windows/Linux |[![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)|

## Nuget Packages

| Package Name | Nuget | Myget | Downloads
|--------------| ------- | ------- | ----
| SkyAPM.Agent.AspNetCore | ![](https://img.shields.io/nuget/v/SkyAPM.Agent.AspNetCore.svg?style=flat-square) | ![](https://img.shields.io/myget/skyapm-dotnet/v/SkyAPM.Agent.AspNetCore.svg?style=flat-square) | ![](https://img.shields.io/nuget/dt/SkyAPM.Agent.AspNetCore.svg?style=flat-square)
| SkyAPM.Agent.AspNet | ![](https://img.shields.io/nuget/v/SkyAPM.Agent.AspNet.svg?style=flat-square) | ![](https://img.shields.io/myget/skyapm-dotnet/v/SkyAPM.Agent.AspNet.svg?style=flat-square) | ![](https://img.shields.io/nuget/dt/SkyAPM.Agent.AspNet.svg?style=flat-square)

# Supported
- This project currently supports apps targeting netcoreapp2.1 or higher.
- This project currently supports apps targeting netcoreapp2.0/.net framework4.6.1 or higher.
- [Supported middlewares, frameworks and libraries.](docs/Supported-list.md)

# Features
Expand All @@ -32,27 +47,16 @@ A quick list of SkyWalking .NET Core Agent's capabilities

## Install SkyWalking .NET Core Agent

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

```
// install SkyWalking DotNet CLI
dotnet tool install -g SkyWalking.DotNet.CLI
```
On windows, run as Administrator
```
dotnet skywalking install
```
You can run the following command to install the SkyWalking .NET Core Agent in your project.

On macOS/Linux
```
sudo dotnet skywalking install
dotnet add package SkyAPM.Agent.AspNetCore
```

## How to use
Set the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` and `DOTNET_ADDITIONAL_DEPS` environment variables to support the activation of the SkyAPM .NET Core Agent.
Set the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` environment variable to support the activation of the SkyAPM .NET Core Agent.

- Add the assembly name of `SkyWalking.Agent.AspNetCore` to the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` environment variable.
- On Windows, set the `DOTNET_ADDITIONAL_DEPS` environment variable to `%PROGRAMFILES%\dotnet\x64\additionalDeps\skywalking.agent.aspnetcore`. On macOS/Linux, set the `DOTNET_ADDITIONAL_DEPS` environment variable to `/usr/local/share/dotnet/x64/additionalDeps/skywalking.agent.aspnetcore`.
- Add the assembly name of `SkyAPM.Agent.AspNetCore` to the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` environment variable.

### Examples
- On windows
Expand All @@ -61,12 +65,13 @@ Set the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` and `DOTNET_ADDITIONAL_DEPS` envir
dotnet new mvc -n sampleapp
cd sampleapp
// enable SkyWalking.Agent.AspNetCore
set ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyWalking.Agent.AspNetCore
set DOTNET_ADDITIONAL_DEPS=%PROGRAMFILES%\dotnet\x64\additionalDeps\skywalking.agent.aspnetcore
dotnet add package SkyAPM.Agent.AspNetCore
// set Application_Code
set SKYWALKING__APPLICATIONCODE=sample_app
// enable SkyAPM.Agent.AspNetCore
set ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore
// set service_name
set SKYWALKING__SERVICENAME=sample_app
dotnet run
```
Expand All @@ -77,28 +82,38 @@ dotnet run
dotnet new mvc -n sampleapp
cd sampleapp
// enable SkyWalking.Agent.AspNetCore
export ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyWalking.Agent.AspNetCore
export DOTNET_ADDITIONAL_DEPS=/usr/local/share/dotnet/x64/additionalDeps/skywalking.agent.aspnetcore
dotnet add package SkyAPM.Agent.AspNetCore
// enable SkyAPM.Agent.AspNetCore
export ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore
// set Application_Code
export SKYWALKING__APPLICATIONCODE=sample_app
// set service_name
export SKYWALKING__SERVICENAME=sample_app
dotnet run
```

## Configuration
Use `dotnet skywalking config [your_application_code] [your_collector_server]` to generate config file. Example

Install `SkyAPM.DotNet.CLI`

```
dotnet tool install -g SkyAPM.DotNet.CLI
```

Use `dotnet skywalking config [your_service_name] [your_servers]` to generate config file.

Example

```
dotnet skywalking config sample_app 192.168.0.1:11800
dotnet skyapm config sample_app 192.168.0.1:11800
```

# Roadmap
[What are we going to do next?](/docs/roadmap.md)

# Contributing
This section is in progress here: [Contributing to SkyAPM-netcore](/CONTIBUTING.md)
This section is in progress here: [Contributing to SkyAPM-dotnet](/CONTIBUTING.md)

# Contact Us
* Submit an issue
Expand Down
2 changes: 1 addition & 1 deletion appveyor.yml
Expand Up @@ -11,7 +11,7 @@ skip_commits:
- LICENSE
install:
- git submodule update --init
- dotnet build -c Release src/SkyWalking.Transport.Grpc.Protocol
- dotnet build -c Release src/SkyApm.Transport.Grpc.Protocol
build_script:
- ps: ./scripts/build.ps1
artifacts:
Expand Down
3 changes: 3 additions & 0 deletions docs/Supported-list.md
@@ -1,6 +1,9 @@
- [ASP.NET Core](https://github.com/aspnet)
- [.NET Core BCL types (HttpClient and SqlClient)](https://github.com/dotnet/corefx)
- [EntityFrameworkCore](https://github.com/aspnet/EntityFrameworkCore)
- [EntityFrameworkCore.Sqlite](https://github.com/aspnet/EntityFrameworkCore)
- [Npgsql.EntityFrameworkCore.PostgreSQL](https://github.com/npgsql/Npgsql.EntityFrameworkCore.PostgreSQL)
- [Pomelo.EntityFrameworkCore.MySql](https://github.com/PomeloFoundation/Pomelo.EntityFrameworkCore.MySql)
- [CAP](https://github.com/dotnetcore/CAP)
- ASP.NET

12 changes: 9 additions & 3 deletions docs/roadmap.md
Expand Up @@ -4,11 +4,17 @@
- TraceContext refactoring.
- Upgrade to Skywalking 6.0 protocol.
- Fix known bugs in the issue list.
- CLR runtime monitoring.
- Support IIS monitoring and tracing.
- ASP.NET and WCF request tracing.
- ASP.NET request tracing.

## v0.9.0
- CLR runtime monitoring(need backend support).
- Support IIS monitoring and tracing.
- WCF request tracing.
- Custom Sampling Interceptor.
- Custom Configuration Loading.
- Performance optimization

## v1.0.0
- CLR Profiler(Experimental feature)
- Support plug-in.
- More third-party library support, such as mysql, redis, kafka, rabbitmq..
36 changes: 19 additions & 17 deletions docs/skywalking.json.cn.md
@@ -1,19 +1,17 @@
# SkyWalking Config 配置说明

# ApplicationCode
# ServiceName

应用名称

# SpanLimitPerSegment

每段限制
服务名称

## Sampling

采样配置节点

1. SamplePer3Secs 每3秒采样数

2. Percentage 采样百分比,例如10%采样则配置为`10`

## Logging

SkyWalking日志配置节点
Expand All @@ -26,8 +24,6 @@ SkyWalking日志配置节点
传输配置节点

1. Interval 每多少毫秒刷新
2. PendingSegmentLimit 排队限制
3. PendingSegmentTimeout 排队超时毫秒,超时时排队的数据会被丢弃

### gRPC

Expand All @@ -37,27 +33,33 @@ gRPC配置节点
2. Timeout 创建gRPC链接的超时时间,毫秒
3. ConnectTimeout gRPC最长链接时间,毫秒

# skywalking.json 示例
# skyapm.json 示例
```
{
"SkyWalking": {
"ApplicationCode": "app",
"SpanLimitPerSegment": 300,
"ServiceName": "your_service_name",
"Namespace": "",
"HeaderVersions": [
"sw6"
],
"Sampling": {
"SamplePer3Secs": -1
"SamplePer3Secs": -1,
"Percentage": -1.0
},
"Logging": {
"Level": "Information",
"FilePath": "logs\\SkyWalking-{Date}.log"
"FilePath": "logs/skyapm-{Date}.log"
},
"Transport": {
"Interval": 3000,
"PendingSegmentLimit": 30000,
"PendingSegmentTimeout": 1000,
"ProtocolVersion": "v6",
"QueueSize": 30000,
"BatchSize": 3000,
"gRPC": {
"Servers": "localhost:11800",
"Timeout": 2000,
"ConnectTimeout": 10000
"Timeout": 10000,
"ConnectTimeout": 10000,
"ReportTimeout": 600000
}
}
}
Expand Down
34 changes: 17 additions & 17 deletions docs/skywalking.json.md
@@ -1,12 +1,8 @@
# SkyWalking Configuration

# ApplicationCode
# ServiceName

App name displayed.

# SpanLimitPerSegment

"Span" Limit Per Segment Max.
Service name displayed.

## Sampling

Expand All @@ -26,8 +22,6 @@ SkyWalking Logging Configuration Section
Transport Configuration Section

1. Interval, Flush Interval Millisecond,(unit:Millisecond)
2. PendingSegmentLimit, PendingSegmentLimit Count
3. PendingSegmentTimeout, Data queued beyond this time will be discarded,(unit:Millisecond)

### gRPC

Expand All @@ -37,27 +31,33 @@ gRPC Configuration Section
2. Timeout, Timeout for creating a link,(unit:Millisecond)
3. ConnectTimeout, gRPC Connectioning timed out,(unit:Millisecond)

# skywalking.json sample
# skyapm.json sample
```
{
"SkyWalking": {
"ApplicationCode": "app",
"SpanLimitPerSegment": 300,
"ServiceName": "your_service_name",
"Namespace": "",
"HeaderVersions": [
"sw6"
],
"Sampling": {
"SamplePer3Secs": -1
"SamplePer3Secs": -1,
"Percentage": -1.0
},
"Logging": {
"Level": "Information",
"FilePath": "logs\\SkyWalking-{Date}.log"
"FilePath": "logs/skyapm-{Date}.log"
},
"Transport": {
"Interval": 3000,
"PendingSegmentLimit": 30000,
"PendingSegmentTimeout": 1000,
"ProtocolVersion": "v6",
"QueueSize": 30000,
"BatchSize": 3000,
"gRPC": {
"Servers": "localhost:11800",
"Timeout": 2000,
"ConnectTimeout": 10000
"Timeout": 10000,
"ConnectTimeout": 10000,
"ReportTimeout": 600000
}
}
}
Expand Down
19 changes: 0 additions & 19 deletions generate_protos.bat

This file was deleted.

14 changes: 0 additions & 14 deletions generate_protos_linux.sh

This file was deleted.

13 changes: 0 additions & 13 deletions generate_protos_macos.sh

This file was deleted.

0 comments on commit 4c25789

Please sign in to comment.