Falcon+

Documentations

• Installation and Usage
• Open-Faclon API

Get Started

before start , please make sure you prepared this ready.

And then

# set $GOPATH and $GOROOT

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
cd falcon-plus/

Compilation

# all modules
make all

# specified module
make agent

# pack all modules
make pack

• after make pack you will got open-falcon-vx.x.x.tar.gz
• if you want to edit configure file for each module, you can edit config/xxx.json before you do make pack
• if you got dependencies fetch error on golang.org/x/*, please run sh fix_gosrouce_fetch_error.sh before you compile it.

Unpack and Decompose

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

Run Open-Falcon Commands

for example:

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

./open-falcon check
        falcon-graph         UP           79292
          falcon-hbs         UP           79295
        falcon-judge         UP           79301
     falcon-transfer         UP           79304
       falcon-nodata         UP           79307
         falcon-task         UP           79310
   falcon-aggregator         UP           79313
        falcon-agent         UP           79316
      falcon-gateway         UP           79319
          falcon-api         UP           98421
        falcon-alarm         UP           86388

• For debugging , You can check $WorkDir/$moduleName/log/logs/xxx.log

Package Management

How-to

Make sure you're using Go 1.5+ and GO15VENDOREXPERIMENT=1 env var is exported. (You can ignore GO15VENDOREXPERIMENT using Go 1.6+.)

0. Install trash by go get github.com/rancher/trash.
1. Edit trash.yml file to your needs. See the example as follow.
2. Run trash --keep to download the dependencies.

trash file example:

package: github.com/open-falcon/falcon-plus

import:
- package: github.com/open-falcon/common              # package name
  version: origin/develop                        # tag, commit, or branch
  repo:    https://github.com/open-falcon/common.git  # (optional) git URL

Package Release

make clean all pack

Q&A

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