Contributing

Please join us to improve this project.

The backend is written by Golang, and the front-end is written by Vue.

For beginner

You might need to know the following tech before get started.

Setup development environment

This project uses make as a build tool and has a very powerful make command system. You can see all the available commands by running make help.

It’s highly recommended you to configure the git pre-commit hook. It will force to run unit tests before commit. Run the following command:

make install-precheck

Print the code of lines:

git ls-files | xargs cloc

pprof

go tool pprof -http=:9999 http://localhost:8080/debug/pprof/heap

Other usage of this:

• /debug/pprof/heap?gc=1
• /debug/pprof/heap?seconds=10
• /debug/pprof/goroutine/?debug=0

SkyWalking

docker run -p 12800:12800 -p 9412:9412 docker.io/apache/skywalking-oap-server:9.0.0
docker run -p 8080:8080 -e SW_OAP_ADDRESS=http://172.11.0.6:12800 -e SW_ZIPKIN_ADDRESS=http://172.11.0.6:9412 docker.io/apache/skywalking-ui:9.0.0

make build

export SW_AGENT_NAME=atest
export SW_AGENT_REPORTER_GRPC_BACKEND_SERVICE=172.11.0.6:30689
export SW_AGENT_PLUGIN_CONFIG_HTTP_SERVER_COLLECT_PARAMETERS=true
export SW_AGENT_METER_COLLECT_INTERVAL=3
export SW_AGENT_LOG_TYPE=std
export SW_AGENT_REPORTER_DISCARD=true
./bin/atest server --local-storage 'bin/*.yaml' --http-port 8082 --port 7072 --console-path console/atest-ui/dist/

Run SkyWalking with BanYanDB:

docker run -p 17912:17912 -p 17913:17913 apache/skywalking-banyandb:latest  standalone

docker run -p 12800:12800 -p 9412:9412 \
    -e SW_STORAGE=banyandb \
    -e SW_STORAGE_BANYANDB_HOST=192.168.1.98 \
    docker.io/apache/skywalking-oap-server

First contribution

For developers contributing code to this project for the first time, you should run the following command in your local development environment:

make test

This will help you to check for and fix any bugs that you encounter at commit time, as well as reduce the complexity of the review.

FAQ

• Got sum missing match error of go.
  • Run command: go clean -modcache && go mod tidy