Skip to content

Commit 0a34c60

Browse files
committed
Update README.md
1 parent 8ef3ab8 commit 0a34c60

File tree

1 file changed

+34
-23
lines changed

1 file changed

+34
-23
lines changed

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,16 @@ Installation and Usage Instructions
3232
------
3333
1. Requirement: Java JDK 8, or the one specified by in pom.xml if changed during build time.
3434

35-
2. Unzip myperfserver-server.zip to desired installation directory. If intend to install on Windows host, please review two shell scripts and create Windows equivalent.
35+
2. Unzip myperfserver-server.zip to the desired installation directory. If you intend to install on Windows host, please review two shell scripts and create Windows equivalent.
3636

37-
3. For more formal installation, it is recommended to have a MySQL database server to store the metrics.
38-
Otherwise, use built in derby db.
37+
3. For a more formal installation, it is recommended to have a MySQL database server to store the metrics.
38+
Otherwise, use the built-in derby db.
3939
a. Create a database, for example, named as metrics, with the MySQL database server.
40-
b. Create a MySQL user (for example, 'metrics'@'my_host', here my_host is the machine to install this MySQL perf analyzer) with all privileges on above schema.
41-
c. Above information will be required when first login to the analyzer to setup metrics gathering.
40+
b. Create a MySQL user (for example, 'metrics'@'my_host' -> here my_host is the machine where you MySQL perf analyzer) with all privileges on above schema.
41+
c. The above information will be required when you first login to the analyzer to setup metrics gathering.
4242

43-
4. Review script start_myperf.sh to see if you need modify any command line settings. Usually, port number is the only one you need change
44-
-j: jetteyHome, leave as it is
43+
4. Review script start_myperf.sh to see if you need to modify any command line settings. Usually, port number is the only one you need change
44+
-j: jettyHome, leave it as it is
4545
-p: http port to be used, 9092 by default
4646
-w: war (web archive) file, has to be myperf.war
4747
-k: working directory, if not specified, it will use ./work
@@ -56,32 +56,43 @@ Installation and Usage Instructions
5656
6. Shutdown:
5757
./stop_myperf.sh
5858

59-
7. Fisrt login and setup
60-
After startup, point your bwoser to http://your_host:9092/myperf (or the port number you changed).
59+
7. First time Login and Setup
60+
After startup, point your browser to http://your_host:9092/myperf (or the port number you changed).
6161
The initial login user and credential are myperf/change.
62-
After login, you will be directed to setup page:
63-
You can add notification email. The email uses OS "mailx" command.
64-
Configure the metrics storage database, using the one created earlier.
65-
1 minute or 5 minutes metrics scan interval is good enough.
66-
If use builtin derbydb, choose short retention days.
67-
After configuration is done, you need start the scanner (the "Start Scanner" button on the page top).
68-
Everytime you change the configuration, you need restart the scanner.
69-
If the scanner does not work as expected, restart the analyzer (./stop_myperf.sh, then ./start_myperf.sh)
70-
71-
8. For each database server to monitor, you need create a MySQL user with the following privileges
62+
63+
After login, you will be directed to setup page:
64+
65+
You can add an email address for notifications. The email uses OS "mailx" command.
66+
67+
Configure the metrics storage database, using the one that you created in the earlier steps.
68+
A metrics scan interval of 1 or 5 minutes should be good enough.
69+
70+
If use built-in derbydb, choose short retention days.
71+
72+
73+
After configuration is done, you need to start the scanner ("Start Scanner" button on top of the page).
74+
75+
Everytime you change the configuration, you need to restart the scanner.
76+
77+
If the scanner does not work as expected, restart the analyzer
78+
./stop_myperf.sh
79+
then
80+
./start_myperf.sh
81+
82+
8. For each database server you want to monitor, you need to create a MySQL user with the following privileges:
7283
a. process
7384
b. replication client
7485
c. show databases
7586
d. show view
76-
e. select on all (if you want to use it to check data dictionary or run explain plan)
87+
e. select on all (if you want to use it to check data dictionary or run explain plans)
7788

7889
9. The analyzer relies on Linux SNMP to gather OS level data. Check snmpd service status.
7990

8091
Known Limitations
8192
------
82-
1. snmpd is based on Linux specification.
83-
2. Email notification uses Linux "mailx" command.
93+
1. snmpd is based on the Linux specification.
94+
2. Email notification uses Linux's "mailx" command.
8495

8596
License
8697
------
87-
Code licensed under the Apache license. See LICENSE file for terms.
98+
This code licensed under the Apache license. See the LICENSE file for terms.

0 commit comments

Comments
 (0)