The Sidecar Project of Apache SkyWalking

Clone this repo:
  1. dfb8195 Fix broken link (#35) by 吴晟 Wu Sheng · 11 days ago main website-docs/0.1.0
  2. eec01ab add release script (#34) by Evan · 11 days ago v0.1.0
  3. ed9bde5 fix release src cannot compile bug (#33) by Evan · 11 days ago
  4. efc1ed6 add website doc (#32) by Evan · 12 days ago
  5. 7f230fc plish timer fallbacker (#31) by Evan · 13 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
git submodule init
git submodule update
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 output PATH for the plugin documentation. (default: “docs” or read value from SATELLITE_DOC_PATH env)
docs--help, -hShow help.

Contact Us

License

Apache 2.0 License.