Bug #41573 Log File Locations and other miscellaneous corrections
Submitted: 18 Dec 2008 1:25 Modified: 13 Aug 2009 8:26
Reporter: Donna Harmon Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Enterprise Monitor: Documentation Severity:S3 (Non-critical)
Version:2.0 OS:Any
Assigned to: MC Brown CPU Architecture:Any

[18 Dec 2008 1:25] Donna Harmon
Description:
Online MEM documentation and Monitor 2.0 pdf have several errors.

Various "Service Agent" mentions S/B "Monitor Agent"

Various Log File locations are incorrect or missing.

Other miscellaneous updates needed.

See Suggested Fix for details.

How to repeat:
Look at 2.0 documentation

Suggested fix:
Throughout Documentation:
Replace "MySQL Enterprise Service Agent" with "MySQL Enterprise Monitor Agent"

Replace "MySQLEnterpriseServiceAgent" with "MySQLEnterpriseMonitorAgent"

Replace "Service Agent" with "Monitor Agent"

Replace "mysqlserviceagent" with "mysqlmonitoragent"

Replace "/merlin/heartbeat" with "/heartbeat"

Replace "merlind" with "mysql-proxy"

I believe the only place you should find the word "merlin" in this doc is in the 3.2 Migrating Old data ... Removing Old Data section???

Page 8 (On-line Doc - 2.2)
http://localhost:18080/merlin/main?command=list_versions doesn't work and s/b http://localhost:18080/main?command=list_versions

Page 18,21,70 (On-line Doc - 2.2.4 #8,2.3.,Chapter 4)
Even though http://127.0.0.1:18080/merlin/Auth.action works and forwards to http://127.0.0.1:18080/Auth.action I believe it s/b updated in docs to be http://127.0.0.1:18080/Auth.action

Pages 46 & 47 (On-line Doc - 2.6.4. 2.6.5)
hostname value specified in the [merlind] s/b agent-mgmt-hostname value specified in the [mysql-proxy]

Page 48 (On-line Doc - 2.6.5)
Not sure if error says "merlin-server" and merlin/heartbeat or not???  Probably shouldn't?

Page 49 (On-line Doc - 2.7.1.1)
/apache-tomcat/webapps/merlin/mysql s/b /monitor/mysql
/apache-tomcat/webapps/merlin/mysql/data s/b monitor/mysql/data

Page 71 (On-line Doc - Chapter 4 note)
/monitor/apache-tomcat/webapps/merlin/web/resources/images/ S/B /monitor/apache-tomcat/webapps/ROOT/web/resources/images/

Page 95 (On-line Doc - 6.6)
http://localhost:18080/merlin/rest?command=blackout&server_name=SuSE:3306&blackout_state=t... s/b http://localhost:18080/rest?command=blackout&server_name=SuSE:3306&blackout_state=true

http://localhost:18080/merlin/rest?command=blackout&group_name=Finance&blackout_state=true S/B http://localhost:18080/rest?command=blackout&group_name=Finance&blackout_state=true

Page 96 (On-line Doc - 6.6.1)
/merlin/rest s/b /rest

Appendix B (B.1 and B.5) in pdf and on-line documentation:

B.1. Log Files for the MySQL Enterprise Service Manager
I would suggest you put actual file names in this section: catalina.out for Apache/Tomcat and mysql-monitor.log for Service Manager
Table B.1. Log file locations – Windows
Repository C:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\webapps\merlin\mysql\data
S/B
Repository C:\Program Files\MySQL\Enterprise\Monitor\mysql\data

Table B.1 Also Missing:
Service Manager C:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\logs\mysql-monitor.log
(These logs are also viewable via the Enterprise Dashboard, for more information see Section 5.6, “Logs”)

Table B.2. Log file locations – Unix
Repository /opt/mysql/enterprise/monitor/apache-tomcat/webapps/merlin/mysql/data
S/B
Repository /opt/mysql/enterprise/monitor/mysql/data

Table B.2 Also Missing:
Service Manager /opt/mysql/enterprise/monitor/apache-tomcat/logs/mysql-monitor.log
(These logs are also viewable via the Enterprise Dashboard, for more information see Section 5.6, “Logs”)

Table B.3. Log file locations – Mac OS X
Repository /Applications/mysql/enterprise/monitor/apache-tomcat/webapps/merlin/mysql/data
S/B
Repository /Applications/mysql/enterprise/monitor/mysql/data

Table B.3 Also Missing:
Service Manager /Applications/mysql/enterprise/monitor/apache-tomcat/logs/mysql-monitor.log
(These logs are also viewable via the Enterprise Dashboard, for more information see Section 5.6, “Logs”)

Table B.5. The config.properties file
Windows
C:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\webapps\merlin\WEB-INF S/B Windows C:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\webapps\ROOT\WEB-INF

Unix
/opt/mysql/enterprise/monitor/apache-tomcat/webapps/merlin\WEB-INF S/B /opt/mysql/enterprise/monitor/apache-tomcat/webapps/ROOT/WEB-INF

Mac OS X /Applications/
mysql/enterprise/monitor/apache-tomcat/webapps/merlin\WEB-INF S/B mysql/enterprise/monitor/apache-tomcat/webapps/ROOT/WEB-INF
[9 Jan 2009 16:20] MC Brown
Thanks for the detailed report - everything should now be fixed and in the next built version of the documentation.
[13 Aug 2009 8:26] MC Brown
I've updated the documentation, again, to address these issues. 

Some of these issues had already corrected - I do not know why we had the regression we had to the unfixed version. This may be related to a separate build issue, parts of which I fixed only yesterday. 

Some further notes: 

1) In general the PDF version and page numbers, and section/chapter numbers are not suitable for making comparisons, as the numbers are subject to change. Using the HTML online version and the explicit IDs is more useful. 

2) In general we don't change the terminology in changelog entries, but I have done in some cases. 

The files will be rebuilt, please recheck when they are ready - they should have the revision id of at least 16113.