Skip to content

Commit f21836a

Browse files
committed
modify readme for more details
1 parent aa2f136 commit f21836a

File tree

1 file changed

+75
-3
lines changed

1 file changed

+75
-3
lines changed

README

Lines changed: 75 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,78 @@
1-
tsar is Taobao monitor tool for collect system activity status, and report it.
2-
It have a plugin system that is easy for collect plugin development. and may
3-
setup different output target such as local logfile and remote nagios host.
1+
* Introduce
2+
Tsar is Taobao monitor tool for collect system activity status, and report it. It have a plugin system that is easy for collect plugin development. and may setup different output target such as local logfile and remote nagios host.
3+
4+
NAME
5+
tsar - Taobao System Activity Reporter
6+
7+
SYNOPSIS
8+
tsar [options] --tsar main function
9+
10+
tsardevel [modname] --develop new mod
11+
12+
DESCRIPTION
13+
tsar is a monitor tool for collect system activity status and apps.
14+
15+
tsar reads and logs messages to the log files,It support different output target such as local console or remote db/nagios host.It
16+
have a plugin system that is easy for collect plugin development.
17+
18+
OPTIONS
19+
-check , -check
20+
display last record for alert,it is just used for taobao inner alert
21+
22+
-C , --check
23+
display last record for alert.example:tsar --check / tsar --check --cpu --io
24+
25+
-c , --cron
26+
run in cron mode, output data to file,default is /var/log/tsar.data
27+
28+
-l ,--live
29+
running print live mode which module will print
30+
31+
-i , --interval
32+
specify intervals numbers, if not with --live,it is in minutes;if with --live, it is in seconds
33+
34+
-m , --merge
35+
merge multiply item to one
36+
37+
-L , --list
38+
list enabled modules
39+
40+
-n , --ndays
41+
show the value for the past days (default: 1)
42+
43+
-d , --date
44+
special one day to display,support formate YYYYMMDD or int for somedays ago
45+
46+
-f , --file
47+
special tsar.data for tsar to read
48+
49+
-n , --ndays
50+
show the value for the past days (default: 1)
51+
52+
-d , --date
53+
special one day to display,support formate YYYYMMDD or int for somedays ago
54+
55+
-f , --file
56+
special tsar.data for tsar to read
57+
58+
-n , --ndays
59+
show the value for the past days (default: 1)
60+
61+
-h , --help
62+
print help info
63+
64+
DIAGNOSTICS
65+
It is expected that tsar will run as root
66+
67+
FILES
68+
/etc/tsar/tsar.conf
69+
Configuration file for tsar.output mod list for differnt type
70+
71+
/etc/tsar/cron.d/*.conf
72+
extrat config file, usually tsar devel modules config
73+
74+
BUGS
75+
If you find any, please send email to the kongjian@taobao.com
476

577
* Get and deploy tsar
678

0 commit comments

Comments
 (0)