You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
**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.
**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
+
13
17
## CI Build Status
14
18
15
19
[](https://github.com/SkyAPM/SkyAPM-dotnet/actions/workflows/net-ci-it.yml)
- 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
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
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.
See [Contributing to SkyAPM-dotnet](./CONTRIBUTING.md).
107
44
108
-
# Contributing
109
-
This section is in progress here: [Contributing to SkyAPM-dotnet](./CONTRIBUTING.md)
45
+
## Contact Us
110
46
111
-
# Contact Us
112
-
* Submit an issue
47
+
* Submit an issue on this repository for questions about the **.NET agent**.
113
48
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):
115
50
* Submit an official Apache SkyWalking [issue](https://github.com/apache/skywalking/issues).
116
51
* 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).
118
53
* QQ Group: 392443393(2000/2000, not available), 901167865(available)
0 commit comments