qpc-github/skywalking-satellite

The Sidecar Project of Apache SkyWalking

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.

Documentation

• Official documentation
• Blog about the design of Satellite 0.1.0.

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

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

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: [email protected]. Mail to [email protected], follow the reply to subscribe the mail list.
• Join skywalking channel at Apache Slack. If the link is not working, find the latest one at Apache INFRA WIKI.
• Twitter, ASFSkyWalking
• QQ Group: 901167865(Recommended), 392443393
• bilibili B站 视频

License

Apache 2.0 License.