by open-falcon

open-falcon / falcon-plus

An open-source and enterprise-level monitoring system.

6.2K Stars 1.4K Forks Last release: over 1 year ago (v0.3) Apache License 2.0 1.1K Commits 3 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:



Build Status codecov GoDoc Code Issues Go Report Card License Backers on Open Collective Sponsors on Open Collective



  • Git >= 1.7.5
  • Go >= 1.6

Getting Started


Please refer to ./docker/README.md.

Build from source

before start, please make sure you prepared this:

yum install -y redis
yum install -y mysql-server

NOTE: be sure to check redis and mysql-server have successfully started.

And then

# Please make sure that you have set `$GOPATH` and `$GOROOT` correctly.
# If you have not golang in your host, please follow [https://golang.org/doc/install] to install golang.

mkdir -p $GOPATH/src/github.com/open-falcon cd $GOPATH/src/github.com/open-falcon git clone https://github.com/open-falcon/falcon-plus.git

And do not forget to init the database first (if you have not loaded the database schema before)

cd $GOPATH/src/github.com/open-falcon/falcon-plus/scripts/mysql/db_schema/
mysql -h -u root -p < 1_uic-db-schema.sql
mysql -h -u root -p < 2_portal-db-schema.sql
mysql -h -u root -p < 3_dashboard-db-schema.sql
mysql -h -u root -p < 4_graph-db-schema.sql
mysql -h -u root -p < 5_alarms-db-schema.sql

NOTE: if you are upgrading from v0.1 to v0.2.0(or above),then. More upgrading instruction

mysql -h -u root -p < 5_alarms-db-schema.sql


cd $GOPATH/src/github.com/open-falcon/falcon-plus/

make all modules

make all

make specified module

make agent

pack all modules

make pack

  • after
    make pack
    you will got
  • if you want to edit configure file for each module, you can edit
    before you do
    make pack

Unpack and Decompose

export WorkDir="$HOME/open-falcon"
mkdir -p $WorkDir
tar -xzvf open-falcon-vx.x.x.tar.gz -C $WorkDir
cd $WorkDir

Start all modules in single host

cd $WorkDir
./open-falcon start

check modules status

./open-falcon check

Run More Open-Falcon Commands

for example:

# ./open-falcon [start|stop|restart|check|monitor|reload] module
./open-falcon start agent

./open-falcon check falcon-graph UP 53007 falcon-hbs UP 53014 falcon-judge UP 53020 falcon-transfer UP 53026 falcon-nodata UP 53032 falcon-aggregator UP 53038 falcon-agent UP 53044 falcon-gateway UP 53050 falcon-api UP 53056 falcon-alarm UP 53063

  • For debugging , You can check

Install Frontend Dashboard

NOTE: if you want to use grafana as the dashboard, please check this.

Package Management

We use govendor to manage the golang packages. Please install

before compilation.
go get -u github.com/kardianos/govendor

Most depended packages are saved under

dir. If you want to add or update a package, just run
govendor fetch [email protected]
govendor fetch [email protected]
, then you will find the package have been placed in

Package Release

make clean all pack

API Standard


  • Any issue or question is welcome, Please feel free to open github issues :)
  • FAQ


This project exists thanks to all the people who contribute. [Contribute].

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.