Skip to content

Commit e3d035a

Browse files
wu-shengclaude
andcommitted
docs: simplify README and link to the documentation site
Point the README at the published docs site (https://skyapm.github.io/SkyAPM-dotnet/) for full guides, and trim the duplicated Getting Started / How to use / Configuration / Features sections that now live there. Also fixes the README's stale `docs/...` relative links (the docs were moved under `content/` for the Hugo site). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent f7e3a5c commit e3d035a

1 file changed

Lines changed: 21 additions & 85 deletions

File tree

README.md

Lines changed: 21 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
SkyAPM C#/.NET instrument agent
22
==========
33

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

66
**SkyAPM-dotnet** is a community, open-source C#/.NET auto-instrumentation agent for the .NET ecosystem. It provides distributed tracing, application topology, and metrics for ASP.NET Core and .NET applications, and reports the collected telemetry to an [Apache SkyWalking](https://skywalking.apache.org/) backend over the `sw8` / `v8` protocol. It is an independent project and is not affiliated with or endorsed by the Apache Software Foundation.
77

@@ -10,112 +10,48 @@ SkyAPM C#/.NET instrument agent
1010
[![releases](https://img.shields.io/github/release/skyapm/skyapm-dotnet.svg?style=flat-square)](https://github.com/SkyAPM/SkyAPM-dotnet/releases)
1111
[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=flat-square&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
1212

13+
## 📖 Documentation
14+
15+
**Full documentation lives at [skyapm.github.io/SkyAPM-dotnet](https://skyapm.github.io/SkyAPM-dotnet/)** — getting started, installation & activation, the complete configuration reference (EN / 中文), transports (gRPC / Kafka), the supported-component list, plugins, logging, the CLI, and troubleshooting.
16+
1317
## CI Build Status
1418

1519
[![NET CI AND IT](https://github.com/SkyAPM/SkyAPM-dotnet/actions/workflows/net-ci-it.yml/badge.svg)](https://github.com/SkyAPM/SkyAPM-dotnet/actions/workflows/net-ci-it.yml)
1620

17-
## Nuget Packages
21+
## NuGet Packages
1822

1923
| Package Name | NuGet | Downloads |
2024
|--------------| ------- | ---- |
2125
| SkyAPM.Agent.AspNetCore | [![nuget](https://img.shields.io/nuget/v/SkyAPM.Agent.AspNetCore.svg?style=flat-square)](https://www.nuget.org/packages/SkyAPM.Agent.AspNetCore) | [![stats](https://img.shields.io/nuget/dt/SkyAPM.Agent.AspNetCore.svg?style=flat-square)](https://www.nuget.org/stats/packages/SkyAPM.Agent.AspNetCore?groupby=Version) |
2226
| SkyAPM.Agent.GeneralHost | [![nuget](https://img.shields.io/nuget/v/SkyAPM.Agent.GeneralHost.svg?style=flat-square)](https://www.nuget.org/packages/SkyAPM.Agent.GeneralHost) | [![stats](https://img.shields.io/nuget/dt/SkyAPM.Agent.GeneralHost.svg?style=flat-square)](https://www.nuget.org/stats/packages/SkyAPM.Agent.GeneralHost?groupby=Version) |
2327

24-
# Supported
25-
- This project currently supports apps targeting net8.0 and net10.0 (the active .NET LTS releases). Apps on newer runtimes (e.g. net9.0) are covered via the net8.0 assemblies.
26-
- [Supported middlewares, frameworks and libraries.](docs/Supported-list.md)
27-
28-
# Features
29-
A quick list of the SkyAPM .NET agent's capabilities:
30-
- Application Topology
31-
- Distributed Tracing over the SkyWalking sw8 (v8) protocol
32-
- ASP.NET Core and ASP.NET diagnostics
33-
- HttpClient and gRPC client/server diagnostics
34-
- EntityFrameworkCore diagnostics (SqlServer, Sqlite, PostgreSQL/Npgsql, Pomelo MySQL)
35-
- SqlClient and MySqlConnector peer formatters
36-
- MongoDB, SmartSql, FreeSql, FreeRedis, MassTransit and CAP diagnostics
37-
- Microsoft.Extensions.Logging (MSLogging) integration
38-
39-
For the full plugin set, see [Supported middlewares, frameworks and libraries](docs/Supported-list.md). Browse all guides from the [docs index](docs/README.md).
40-
41-
# Getting Started
42-
43-
## Deploy SkyWalking Backend And UI
44-
45-
#### Requirements
46-
Start with v1.0.0, SkyAPM .NET Core Agent only supports SkyWalking 8.0 or higher. The SkyWalking doc is [here](https://skywalking.apache.org/docs/).
47-
48-
## Install SkyWalking .NET Core Agent
49-
50-
You can run the following command to install the SkyWalking .NET Core Agent in your project.
51-
52-
```
53-
dotnet add package SkyAPM.Agent.AspNetCore
54-
```
55-
56-
## How to use
57-
Set the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` environment variable to support the activation of the SkyAPM .NET Core Agent.
58-
59-
- Add the assembly name of `SkyAPM.Agent.AspNetCore` to the `ASPNETCORE_HOSTINGSTARTUPASSEMBLIES` environment variable.
60-
61-
### Examples
62-
- On windows
63-
64-
```
65-
dotnet new mvc -n sampleapp
66-
cd sampleapp
67-
dotnet add package SkyAPM.Agent.AspNetCore
68-
set ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore
69-
set SKYWALKING__SERVICENAME=sample_app
70-
dotnet run
71-
```
28+
## Quick start
7229

73-
- On macOS/Linux
30+
Supported runtimes: **net8.0** and **net10.0**.
7431

75-
```
76-
dotnet new mvc -n sampleapp
77-
cd sampleapp
78-
dotnet add package SkyAPM.Agent.AspNetCore
79-
export ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore
80-
export SKYWALKING__SERVICENAME=sample_app
32+
```bash
33+
dotnet add package SkyApm.Agent.AspNetCore
34+
export ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyApm.Agent.AspNetCore
35+
export SKYWALKING__SERVICENAME=my_service
8136
dotnet run
8237
```
8338

84-
## Configuration
85-
86-
Install `SkyAPM.DotNet.CLI`
87-
88-
```
89-
dotnet tool install -g SkyAPM.DotNet.CLI
90-
```
91-
92-
For 2.2.x or older, use `dotnet skyapm config [your_service_name] [your_servers]` to generate config file.
93-
94-
```
95-
dotnet skyapm config sample_app 192.168.0.1:11800
96-
```
97-
98-
For 2.3.x or newer, use `dotnet skyapm config ${your_service_name} [--reporter=grpc|kafka] [--grpcservers=...] [--kafkaservers=...]` to generate config file.
39+
See [**Getting Started**](https://skyapm.github.io/SkyAPM-dotnet/docs/guides/getting-started/) for the full walkthrough, and the [**Configuration reference**](https://skyapm.github.io/SkyAPM-dotnet/docs/guides/skyapm_config/) for every option.
9940

100-
```
101-
# grpc
102-
dotnet skyapm config sample_app --reporter=grpc --grpcservers=192.168.0.1:11800
41+
## Contributing
10342

104-
# kafka
105-
dotnet skyapm config sample_app --reporter=kafka --kafkaservers=192.168.0.1:9092
106-
```
43+
See [Contributing to SkyAPM-dotnet](./CONTRIBUTING.md).
10744

108-
# Contributing
109-
This section is in progress here: [Contributing to SkyAPM-dotnet](./CONTRIBUTING.md)
45+
## Contact Us
11046

111-
# Contact Us
112-
* Submit an issue
47+
* Submit an issue on this repository for questions about the **.NET agent**.
11348

114-
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.
49+
For questions about the **SkyWalking protocol or its backend/UI**, use the official Apache SkyWalking channels (these are not suitable for the .NET agent):
11550
* Submit an official Apache SkyWalking [issue](https://github.com/apache/skywalking/issues).
11651
* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.
117-
* Join `skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY). If the link is not working, find the latest one at [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
52+
* Join the `skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY). If the link is not working, find the latest one at the [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
11853
* QQ Group: 392443393(2000/2000, not available), 901167865(available)
11954

120-
# License
55+
## License
56+
12157
[Apache 2.0 License.](/LICENSE)

0 commit comments

Comments
 (0)