This repository has been archived by the owner on Jan 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy path#README.md#
152 lines (103 loc) · 4.61 KB
/
#README.md#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# Falcon+
[](https://travis-ci.org/open-falcon/falcon-plus)
[](https://codecov.io/gh/open-falcon/falcon-plus)
[](https://godoc.org/github.com/open-falcon/falcon-plus)
[](https://www.quantifiedcode.com/app/project/5035c017b02c4a4a807ebc4e9f153e6f)
[](https://goreportcard.com/report/github.com/open-falcon/falcon-plus)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
# Documentations
- [Usage](http://book.open-falcon.org)
- [Open-Falcon API](http://open-falcon.org/falcon-plus)
# Prerequisite
- Git >= 1.7.5
- Go >= 1.6
# Getting Started
## Docker
Please refer to ./docker/[README.md](https://github.com/open-falcon/falcon-plus/blob/master/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 127.0.0.1 -u root -p < 1_uic-db-schema.sql
mysql -h 127.0.0.1 -u root -p < 2_portal-db-schema.sql
mysql -h 127.0.0.1 -u root -p < 3_dashboard-db-schema.sql
mysql -h 127.0.0.1 -u root -p < 4_graph-db-schema.sql
mysql -h 127.0.0.1 -u root -p < 5_alarms-db-schema.sql
```
**NOTE: if you are upgrading from v0.1 to current version v0.2.0,then**. [More upgrading instruction](http://www.jianshu.com/p/6fb2c2b4d030)
mysql -h 127.0.0.1 -u root -p < 5_alarms-db-schema.sql
# Compilation
```
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 `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`*
# 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 `$WorkDir/$moduleName/logs/xxx.log`
# Install Frontend Dashboard
- Follow [this](https://github.com/open-falcon/dashboard).
**NOTE: if you want to use grafana as the dashboard, please check [this](https://github.com/open-falcon/grafana-openfalcon-datasource).**
# Package Management
We use govendor to manage the golang packages. Please install `govendor` before compilation.
go get -u github.com/kardianos/govendor
Most depended packages are saved under `./vendor` dir. If you want to add or update a package, just run `govendor fetch xxxx@commitID` or `govendor fetch [email protected]`, then you will find the package have been placed in `./vendor` correctly.
# Package Release
```
make clean all pack
```
# API Standard
- [API Standard](https://github.com/open-falcon/falcon-plus/blob/master/api-standard.md)
# Q&A
- Any issue or question is welcome, Please feel free to open [github issues](https://github.com/open-falcon/falcon-plus/issues) :)
- [FAQ](https://book.open-falcon.org/zh_0_2/faq/)