https://github.com/apache/skywalking-satellite
The Sidecar Project of Apache SkyWalking
https://github.com/apache/skywalking-satellite
apm dapper distributed-tracing observability service-mesh sidecar skywalking
Last synced: 11 months ago
JSON representation
The Sidecar Project of Apache SkyWalking
- Host: GitHub
- URL: https://github.com/apache/skywalking-satellite
- Owner: apache
- License: apache-2.0
- Created: 2020-10-31T09:52:07.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T01:31:43.000Z (11 months ago)
- Last Synced: 2025-04-01T08:44:38.435Z (11 months ago)
- Topics: apm, dapper, distributed-tracing, observability, service-mesh, sidecar, skywalking
- Language: Go
- Homepage: https://skywalking.apache.org/
- Size: 1.3 MB
- Stars: 110
- Watchers: 46
- Forks: 49
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
Apache SkyWalking Satellite
==========
**SkyWalking Satellite**: A lightweight collector/sidecar could be deployed closer to the target monitored system, to collect metrics, traces, and logs. Also, it provides advanced features, such as, local cache, format transform, sampling.
[](https://github.com/apache/skywalking)
[](https://twitter.com/AsfSkyWalking)
# Documentation
- [Official documentation](https://skywalking.apache.org/docs/#SkyWalkingSatellite)
- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0.
NOTICE, SkyWalking Satellite uses [v3 protocols](https://github.com/apache/skywalking/blob/master/docs/en/protocols/README.md). They are incompatible with previous SkyWalking releases before SkyWalking 8.0.
# Download
Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS, Linux and Windows. Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. Check [the corresponding documentation](./docs/en/guides/compile/How-to-compile.md) to see whether the plugin is available on Windows.
# Compile
As SkyWalking Satellite is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project.
```shell script
git clone https://github.com/apache/skywalking-satellite
cd skywalking-satellite
make build
```
If you want to know more details about compiling, please read [the doc](./docs/en/guides/compile/How-to-compile.md).
# Commands
| Commands| Flags | Description |
| ---- | ---- |---- |
| start | --config FILE, -c FILE | Load configuration from FILE. (default: "configs/satellite_config.yaml" or read value from *SATELLITE_CONFIG* env).|
| start | ---shutdown_hook_time TIME, -t TIME | The hook TIME for graceful shutdown, and the time unit is seconds. (default: "5" or read value from *SATELLITE_SHUTDOWN_HOOK_TIME* env).|
| start | --help, -h | Show help.|
| docs | --output PATH, -o PATH | The document output root path. (default: "docs" or read value from *SATELLITE_DOC_PATH* env) |
| docs | --menu PATH, -m PATH | The menu file path. (default: "/menu.yml" or read value from *SATELLITE_MENU_PATH* env) |
| docs | --plugins PATH, -p PATH | The plugin list dir. (default: "/plugins" or read value from *SATELLITE_PLUGIN_PATH* env) |
| docs | --help, -h | Show help.|
# Contact Us
* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.
* Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in.
* For Chinese speaker, send `[CN] Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in.
* Twitter, [ASFSkyWalking](https://twitter.com/AsfSkyWalking)
* [bilibili B站 视频](https://space.bilibili.com/390683219)
# License
[Apache 2.0 License.](/LICENSE)