MySQL Bugs: #50430: MySQL Enterprise Monitor 2.1 documentation needs to be updated

Bug #50430	MySQL Enterprise Monitor 2.1 documentation needs to be updated
Submitted:	19 Jan 2010 0:01	Modified:	19 Jan 2010 9:02
Reporter:	Roel Van de Paar	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Enterprise Monitor: Documentation	Severity:	S2 (Serious)
Version:	2.1	OS:	Any
Assigned to:	MC Brown	CPU Architecture:	Any

Description:
The MEM 2.1 documentation needs to be updated.

Creating this bug as a placeholder to add various 'This needs updating:' additions.

How to repeat:
https://enterprise.mysql.com/docs/monitor/2.1/en/

This needs updating: 
'Figure 9.3. MySQL Enterprise Dashboard: Query Analyzer Agent/Monitor Topology' - Shows port 4040 instead of port 6446
- Apparently already discussed in bug #45678 and bug #46027 - but bugs have been closed for quite some time

This needs updating:
'2.6.1. Upgrading MySQL Enterprise Monitor' - to show changes in hosting repository elsewhere, both on the MEM server and on other servers
'2.2. Service Manager Installation' - to show correct procedures, and dangers, of doing remote monitoring of servers and having all the agents on the MEM server

This needs adding: 
- High availability scenarios including DRBD failover setups, heartbeat only setup which show examples for both single host "cluster" view and individual servers view in the dashboard.
- REST interface details and howto
- Creating custom graphs
- Creating custom advisors/rules

Please DO NOT create a single bug which you intend to continually update with additional changes - the likelihood (as in this case) is that the bug will be closed before you add any additional items.

Instead, please collect a list and post them in ONE BUG with all the items you want addressed in it. Please also double check that the items you are requesting are not already part of an outstanding bug. This will prevent the bug being continually closed and re-opened each time you have a new correction.

Figure 9.3 has now been updated, and will appear in the online and downloadable builds later today.

In response to Jonathon Coombes:

Please check that your bugs and requests have not already been added to the system before adding new ones.

Section 2.6.1 - this is already being tracked by Bug #35837
Section 2.2 - this information already exists in the documentation. If you have specific warnings or statements that you want added or updated, please provide examples.

'High availability scenarios' - this is on the roadmap for the documentation, but currently the documentation team do not have the bandwidth to investigate and document all the different systems at this time. If you want to provide the information and instructions so that the documentation can be updated, please do so.

'REST interface' - the REST interface is, according to the Enterprise tools team, is currently subject to change and modifications. Until such time as this changes, no documentation will be written, and the enterprise tools team are happy with this. Please contact the enterprise tools team for more information.

'Creating custom graphs' - this is currently handled and tracked in Bug #49598. Please post any requests and enhancements as a comment to that bug, not this one.

'Creating custom advisors and rules' - we already have a significant amount of information about this in the documentation. Please see http://dev.mysql.com/doc/mysql-monitor/2.1/en/mem-creating-advisors-and-rules.html and http://dev.mysql.com/doc/mysql-monitor/2.1/en/mem-custom-data-collection-item.html and the detailed list of already collected data items in http://dev.mysql.com/doc/mysql-monitor/2.1/en/mem-data-items.html. If you have specific changes and additions to this content, please provide a detailed list of what you want addressed in a separate bug.