The Sidecar Project of Apache SkyWalking

Clone this repo:
  1. 6f23cf3 Support generate plugin configuration (#73) by mrproliu · 20 hours ago main
  2. 1f3c08a Fix wrong Docker registry (#72) by kezhenxu94 · 2 days ago
  3. fbd92ab Fix branch name (#71) by 吴晟 Wu Sheng · 2 days ago
  4. a3ce2ec Add publish docker when each PR merged (#70) by mrproliu · 2 days ago
  5. 6292e2f Support load-balance GRPC client with Kubenetes selector (#69) by mrproliu · 5 days ago

Apache SkyWalking Satellite

SkyWalking Satellite: A lightweight collector/sidecar could be deployed closing to the target monitored system, to collect metrics, traces, and logs. Also, it provides advanced features, such as, local cache, format transform, sampling.

GitHub stars Twitter Follow

Documentation

NOTICE, SkyWalking Satellite uses v3 protocols. They are incompatible with previous SkyWalking releases before SkyWalking 8.0.

Performance

  • 0.5 core supported 3000 ops throughput with memory queue.
  • 0.5 core supported 1500 ops throughput with the memory mapped queue(Ensure data stability).

Please read the doc to get more details.

Download

Go to the download page 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 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.

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.

Commands

CommandsFlagsDescription
start--config FILE, -c FILELoad configuration from FILE. (default: “configs/satellite_config.yaml” or read value from SATELLITE_CONFIG env).
start---shutdown_hook_time TIME, -t TIMEThe hook TIME for graceful shutdown, and the time unit is seconds. (default: “5” or read value from SATELLITE_SHUTDOWN_HOOK_TIME env).
start--help, -hShow help.
docs--output PATH, -o PATHThe document output root path. (default: “docs” or read value from SATELLITE_DOC_PATH env)
docs--menu PATH, -m PATHThe menu file path. (default: “/menu.yml” or read value from SATELLITE_MENU_PATH env)
docs--plugins PATH, -p PATHThe plugin list dir. (default: “/plugins” or read value from SATELLITE_PLUGIN_PATH env)
docs--help, -hShow help.

Contact Us

License

Apache 2.0 License.