Fortinet Document Library

Version:


Table of Contents

User Guide

21.4.0
Copy Link

MySQL

The MySQL plugin allows you to monitor a number of metrics about the MySQL database instances running on your server. If you can not find this plugin in the /usr/lib/panopta-agent/plugins folder, then your version of the Agent is out of date and you should update it to gain access to this feature.

Agent Configuration 

In order to use this plugin you will need to add the usernames and passwords for all of your MySQL instances to the /etc/panopta-agent/panopta_agent.cfg file. If you have multiple MySQL instances running on the server, use comma-separated values as shown below

[agent]
[mysql]
host = 127.0.0.1, 127.0.0.1
port = 3306, 3307
username = USERNAME1, USERNAME2
password = PASSWORD1, PASSWORD2

The host is optional and defaults to 127.0.0.1.

Replace USERNAME and PASSWORD with the appropriate username and password for a user that has local MySQL access. We recommend setting up a monitoring user that is used only for this purpose. In order to access replication status information, the user needs to be granted either SUPER or REPLICATION CLIENT permissions.

You would also need to have both MySQL and MySQLD or MySQLD-safe installed onto the server you were trying to configure this type of monitoring for.

Control Panel Configuration 

After making this change, give the Agent a few minutes to sync with FortiMonitor’s servers then you should see new server resources available to add for the server in the control panel.

To add a MySQL Agent resource to your server first see Add FortiMonitor Agent checks if you have not already.

First select MySQL from the monitoring catalog.

There are a number of metrics available to monitor.

Metric

Unit

Average number of slow queries/second

queries per second

Average queries/second

queries per second

Innodb row lock current waits

waits

Innodb row lock time avg

ms

MySQL connections

connections

MySQL query cache amount free (KB)

KB

MySQL query cache percent free

%

MySQL slave server is connected to the master

boolean

MySQL slave server is replicating

boolean

MySQL slave server latency (seconds)

seconds

Query cache amount free

KB

Threads connected

threads

Threads created

threads

Threads running

threads

Uptime

seconds


There is a lot you can do with this plugin, so feel free to add as many MySQL Agent resources to your server as you would like.

If you would like to inspect the MySQL plugin in more detail you can find the python script for it in /usr/lib/panopta-agent/plugins/mysql.py.

Optional Metrics 

If there are MySQL metrics that you would like monitor that are not included with our standard package, then you can use the panopta_agent.cfg file to add additional metrics. First edit the /etc/panopta-agent/panopta_agent.cfg file and add an extended_metrics line to your [mysql] block. Your MySQL block should now look something like this:

[mysql]
username = USERNAME
password = PASSWORD
extended_metrics =

You can then fill out the extended_metrics field with a comma-separated list of metrics. The following list will give you all of the possible metrics to monitor.

  • Aborted_clients

  • Aborted_connects

  • Binlog_cache_disk_use

  • Binlog_cache_use

  • Binlog_stmt_cache_disk_use

  • Binlog_stmt_cache_use

  • Bytes_received

  • Bytes_sent

  • Com_admin_commands

  • Com_assign_to_keycache

  • Com_alter_db

  • Com_alter_db_upgrade

  • Com_alter_event

  • Com_alter_function

  • Com_alter_procedure

  • Com_alter_server

  • Com_alter_table

  • Com_alter_tablespace

  • Com_analyze

  • Com_begin

  • Com_binlog

  • Com_call_procedure

  • Com_change_db

  • Com_change_master

  • Com_check

  • Com_checksum

  • Com_commit

  • Com_create_db

  • Com_create_event

  • Com_create_function

  • Com_create_index

  • Com_create_procedure

  • Com_create_server

  • Com_create_table

  • Com_create_trigger

  • Com_create_udf

  • Com_create_user

  • Com_create_view

  • Com_dealloc_sql

  • Com_delete

  • Com_delete_multi

  • Com_do

  • Com_drop_db

  • Com_drop_event

  • Com_drop_function

  • Com_drop_index

  • Com_drop_procedure

  • Com_drop_server

  • Com_drop_table

  • Com_drop_trigger

  • Com_drop_user

  • Com_drop_view

  • Com_empty_query

  • Com_execute_sql

  • Com_flush

  • Com_grant

  • Com_ha_close

  • Com_ha_open

  • Com_ha_read

  • Com_help

  • Com_insert

  • Com_insert_select

  • Com_install_plugin

  • Com_kill

  • Com_load

  • Com_lock_tables

  • Com_optimize

  • Com_preload_keys

  • Com_prepare_sql

  • Com_purge

  • Com_purge_before_date

  • Com_release_savepoint

  • Com_rename_table

  • Com_rename_user

  • Com_repair

  • Com_replace

  • Com_replace_select

  • Com_reset

  • Com_resignal

  • Com_revoke

  • Com_revoke_all

  • Com_rollback

  • Com_rollback_to_savepoint

  • Com_savepoint

  • Com_select

  • Com_set_option

  • Com_signal

  • Com_show_authors

  • Com_show_binlog_events

  • Com_show_binlogs

  • Com_show_charsets

  • Com_show_collations

  • Com_show_contributors

  • Com_show_create_db

  • Com_show_create_event

  • Com_show_create_func

  • Com_show_create_proc

  • Com_show_create_table

  • Com_show_create_trigger

  • Com_show_databases

  • Com_show_engine_logs

  • Com_show_engine_mutex

  • Com_show_engine_status

  • Com_show_events

  • Com_show_errors

  • Com_show_fields

  • Com_show_function_status

  • Com_show_grants

  • Com_show_keys

  • Com_show_master_status

  • Com_show_open_tables

  • Com_show_plugins

  • Com_show_privileges

  • Com_show_procedure_status

  • Com_show_processlist

  • Com_show_profile

  • Com_show_profiles

  • Com_show_relaylog_events

  • Com_show_slave_hosts

  • Com_show_slave_status

  • Com_show_status

  • Com_show_storage_engines

  • Com_show_table_status

  • Com_show_tables

  • Com_show_triggers

  • Com_show_variables

  • Com_show_warnings

  • Com_slave_start

  • Com_slave_stop

  • Com_stmt_close

  • Com_stmt_execute

  • Com_stmt_fetch

  • Com_stmt_prepare

  • Com_stmt_reprepare

  • Com_stmt_reset

  • Com_stmt_send_long_data

  • Com_truncate

  • Com_uninstall_plugin

  • Com_unlock_tables

  • Com_update

  • Com_update_multi

  • Com_xa_commit

  • Com_xa_end

  • Com_xa_prepare

  • Com_xa_recover

  • Com_xa_rollback

  • Com_xa_start

  • Compression

  • Connections

  • Created_tmp_disk_tables

  • Created_tmp_files

  • Created_tmp_tables

  • Delayed_errors

  • Delayed_insert_threads

  • Delayed_writes

  • Flush_commands

  • Handler_commit

  • Handler_delete

  • Handler_discover

  • Handler_prepare

  • Handler_read_first

  • Handler_read_key

  • Handler_read_last

  • Handler_read_next

  • Handler_read_prev

  • Handler_read_rnd

  • Handler_read_rnd_next

  • Handler_rollback

  • Handler_savepoint

  • Handler_savepoint_rollback

  • Handler_update

  • Handler_write

  • Innodb_buffer_pool_pages_data

  • Innodb_buffer_pool_bytes_data

  • Innodb_buffer_pool_pages_dirty

  • Innodb_buffer_pool_bytes_dirty

  • Innodb_buffer_pool_pages_flushed

  • Innodb_buffer_pool_pages_free

  • Innodb_buffer_pool_pages_misc

  • Innodb_buffer_pool_pages_total

  • Innodb_buffer_pool_read_ahead_rnd

  • Innodb_buffer_pool_read_ahead

  • Innodb_buffer_pool_read_ahead_evicted

  • Innodb_buffer_pool_read_requests

  • Innodb_buffer_pool_reads

  • Innodb_buffer_pool_wait_free

  • Innodb_buffer_pool_write_requests

  • Innodb_data_fsyncs

  • Innodb_data_pending_fsyncs

  • Innodb_data_pending_reads

  • Innodb_data_pending_writes

  • Innodb_data_read

  • Innodb_data_reads

  • Innodb_data_writes

  • Innodb_data_written

  • Innodb_dblwr_pages_written

  • Innodb_dblwr_writes

  • Innodb_have_atomic_builtins

  • Innodb_log_waits

  • Innodb_log_write_requests

  • Innodb_log_writes

  • Innodb_os_log_fsyncs

  • Innodb_os_log_pending_fsyncs

  • Innodb_os_log_pending_writes

  • Innodb_os_log_written

  • Innodb_page_size

  • Innodb_pages_created

  • Innodb_pages_read

  • Innodb_pages_written

  • Innodb_row_lock_current_waits

  • Innodb_row_lock_time

  • Innodb_row_lock_time_avg

  • Innodb_row_lock_time_max

  • Innodb_row_lock_waits

  • Innodb_rows_deleted

  • Innodb_rows_inserted

  • Innodb_rows_read

  • Innodb_rows_updated

  • Innodb_truncated_status_writes

  • Key_blocks_not_flushed

  • Key_blocks_unused

  • Key_blocks_used

  • Key_read_requests

  • Key_reads

  • Key_write_requests

  • Key_writes

  • Last_query_cost

  • Max_used_connections

  • Not_flushed_delayed_rows

  • Open_files

  • Open_streams

  • Open_table_definitions

  • Open_tables

  • Opened_files

  • Opened_table_definitions

  • Opened_tables

  • Performance_schema_cond_classes_lost

  • Performance_schema_cond_instances_lost

  • Performance_schema_file_classes_lost

  • Performance_schema_file_handles_lost

  • Performance_schema_file_instances_lost

  • Performance_schema_locker_lost

  • Performance_schema_mutex_classes_lost

  • Performance_schema_mutex_instances_lost

  • Performance_schema_rwlock_classes_lost

  • Performance_schema_rwlock_instances_lost

  • Performance_schema_table_handles_lost

  • Performance_schema_table_instances_lost

  • Performance_schema_thread_classes_lost

  • Performance_schema_thread_instances_lost

  • Prepared_stmt_count

  • Qcache_free_blocks

  • Qcache_free_memory

  • Qcache_hits

  • Qcache_inserts

  • Qcache_lowmem_prunes

  • Qcache_not_cached

  • Qcache_queries_in_cache

  • Qcache_total_blocks

  • Queries

  • Questions

  • Rpl_status

  • Select_full_join

  • Select_full_range_join

  • Select_range

  • Select_range_check

  • Select_scan

  • Slave_heartbeat_period

  • Slave_open_temp_tables

  • Slave_received_heartbeats

  • Slave_retried_transactions

  • Slave_running

  • Slow_launch_threads

  • Slow_queries

  • Sort_merge_passes

  • Sort_range

  • Sort_rows

  • Sort_scan

  • Ssl_accept_renegotiates

  • Ssl_accepts

  • Ssl_callback_cache_hits

  • Ssl_cipher

  • Ssl_cipher_list

  • Ssl_client_connects

  • Ssl_connect_renegotiates

  • Ssl_ctx_verify_depth

  • Ssl_ctx_verify_mode

  • Ssl_default_timeout

  • Ssl_finished_accepts

  • Ssl_finished_connects

  • Ssl_session_cache_hits

  • Ssl_session_cache_misses

  • Ssl_session_cache_mode

  • Ssl_session_cache_overflows

  • Ssl_session_cache_size

  • Ssl_session_cache_timeouts

  • Ssl_sessions_reused

  • Ssl_used_session_cache_entries

  • Ssl_verify_depth

  • Ssl_verify_mode

  • Ssl_version

  • Table_locks_immediate

  • Table_locks_waited

  • Tc_log_max_pages_used

  • Tc_log_page_size

  • Tc_log_page_waits

  • Threads_cached

  • Threads_connected

  • Threads_created

  • Threads_running

  • Uptime

  • Uptime_since_flush_status

MySQL

The MySQL plugin allows you to monitor a number of metrics about the MySQL database instances running on your server. If you can not find this plugin in the /usr/lib/panopta-agent/plugins folder, then your version of the Agent is out of date and you should update it to gain access to this feature.

Agent Configuration 

In order to use this plugin you will need to add the usernames and passwords for all of your MySQL instances to the /etc/panopta-agent/panopta_agent.cfg file. If you have multiple MySQL instances running on the server, use comma-separated values as shown below

[agent]
[mysql]
host = 127.0.0.1, 127.0.0.1
port = 3306, 3307
username = USERNAME1, USERNAME2
password = PASSWORD1, PASSWORD2

The host is optional and defaults to 127.0.0.1.

Replace USERNAME and PASSWORD with the appropriate username and password for a user that has local MySQL access. We recommend setting up a monitoring user that is used only for this purpose. In order to access replication status information, the user needs to be granted either SUPER or REPLICATION CLIENT permissions.

You would also need to have both MySQL and MySQLD or MySQLD-safe installed onto the server you were trying to configure this type of monitoring for.

Control Panel Configuration 

After making this change, give the Agent a few minutes to sync with FortiMonitor’s servers then you should see new server resources available to add for the server in the control panel.

To add a MySQL Agent resource to your server first see Add FortiMonitor Agent checks if you have not already.

First select MySQL from the monitoring catalog.

There are a number of metrics available to monitor.

Metric

Unit

Average number of slow queries/second

queries per second

Average queries/second

queries per second

Innodb row lock current waits

waits

Innodb row lock time avg

ms

MySQL connections

connections

MySQL query cache amount free (KB)

KB

MySQL query cache percent free

%

MySQL slave server is connected to the master

boolean

MySQL slave server is replicating

boolean

MySQL slave server latency (seconds)

seconds

Query cache amount free

KB

Threads connected

threads

Threads created

threads

Threads running

threads

Uptime

seconds


There is a lot you can do with this plugin, so feel free to add as many MySQL Agent resources to your server as you would like.

If you would like to inspect the MySQL plugin in more detail you can find the python script for it in /usr/lib/panopta-agent/plugins/mysql.py.

Optional Metrics 

If there are MySQL metrics that you would like monitor that are not included with our standard package, then you can use the panopta_agent.cfg file to add additional metrics. First edit the /etc/panopta-agent/panopta_agent.cfg file and add an extended_metrics line to your [mysql] block. Your MySQL block should now look something like this:

[mysql]
username = USERNAME
password = PASSWORD
extended_metrics =

You can then fill out the extended_metrics field with a comma-separated list of metrics. The following list will give you all of the possible metrics to monitor.

  • Aborted_clients

  • Aborted_connects

  • Binlog_cache_disk_use

  • Binlog_cache_use

  • Binlog_stmt_cache_disk_use

  • Binlog_stmt_cache_use

  • Bytes_received

  • Bytes_sent

  • Com_admin_commands

  • Com_assign_to_keycache

  • Com_alter_db

  • Com_alter_db_upgrade

  • Com_alter_event

  • Com_alter_function

  • Com_alter_procedure

  • Com_alter_server

  • Com_alter_table

  • Com_alter_tablespace

  • Com_analyze

  • Com_begin

  • Com_binlog

  • Com_call_procedure

  • Com_change_db

  • Com_change_master

  • Com_check

  • Com_checksum

  • Com_commit

  • Com_create_db

  • Com_create_event

  • Com_create_function

  • Com_create_index

  • Com_create_procedure

  • Com_create_server

  • Com_create_table

  • Com_create_trigger

  • Com_create_udf

  • Com_create_user

  • Com_create_view

  • Com_dealloc_sql

  • Com_delete

  • Com_delete_multi

  • Com_do

  • Com_drop_db

  • Com_drop_event

  • Com_drop_function

  • Com_drop_index

  • Com_drop_procedure

  • Com_drop_server

  • Com_drop_table

  • Com_drop_trigger

  • Com_drop_user

  • Com_drop_view

  • Com_empty_query

  • Com_execute_sql

  • Com_flush

  • Com_grant

  • Com_ha_close

  • Com_ha_open

  • Com_ha_read

  • Com_help

  • Com_insert

  • Com_insert_select

  • Com_install_plugin

  • Com_kill

  • Com_load

  • Com_lock_tables

  • Com_optimize

  • Com_preload_keys

  • Com_prepare_sql

  • Com_purge

  • Com_purge_before_date

  • Com_release_savepoint

  • Com_rename_table

  • Com_rename_user

  • Com_repair

  • Com_replace

  • Com_replace_select

  • Com_reset

  • Com_resignal

  • Com_revoke

  • Com_revoke_all

  • Com_rollback

  • Com_rollback_to_savepoint

  • Com_savepoint

  • Com_select

  • Com_set_option

  • Com_signal

  • Com_show_authors

  • Com_show_binlog_events

  • Com_show_binlogs

  • Com_show_charsets

  • Com_show_collations

  • Com_show_contributors

  • Com_show_create_db

  • Com_show_create_event

  • Com_show_create_func

  • Com_show_create_proc

  • Com_show_create_table

  • Com_show_create_trigger

  • Com_show_databases

  • Com_show_engine_logs

  • Com_show_engine_mutex

  • Com_show_engine_status

  • Com_show_events

  • Com_show_errors

  • Com_show_fields

  • Com_show_function_status

  • Com_show_grants

  • Com_show_keys

  • Com_show_master_status

  • Com_show_open_tables

  • Com_show_plugins

  • Com_show_privileges

  • Com_show_procedure_status

  • Com_show_processlist

  • Com_show_profile

  • Com_show_profiles

  • Com_show_relaylog_events

  • Com_show_slave_hosts

  • Com_show_slave_status

  • Com_show_status

  • Com_show_storage_engines

  • Com_show_table_status

  • Com_show_tables

  • Com_show_triggers

  • Com_show_variables

  • Com_show_warnings

  • Com_slave_start

  • Com_slave_stop

  • Com_stmt_close

  • Com_stmt_execute

  • Com_stmt_fetch

  • Com_stmt_prepare

  • Com_stmt_reprepare

  • Com_stmt_reset

  • Com_stmt_send_long_data

  • Com_truncate

  • Com_uninstall_plugin

  • Com_unlock_tables

  • Com_update

  • Com_update_multi

  • Com_xa_commit

  • Com_xa_end

  • Com_xa_prepare

  • Com_xa_recover

  • Com_xa_rollback

  • Com_xa_start

  • Compression

  • Connections

  • Created_tmp_disk_tables

  • Created_tmp_files

  • Created_tmp_tables

  • Delayed_errors

  • Delayed_insert_threads

  • Delayed_writes

  • Flush_commands

  • Handler_commit

  • Handler_delete

  • Handler_discover

  • Handler_prepare

  • Handler_read_first

  • Handler_read_key

  • Handler_read_last

  • Handler_read_next

  • Handler_read_prev

  • Handler_read_rnd

  • Handler_read_rnd_next

  • Handler_rollback

  • Handler_savepoint

  • Handler_savepoint_rollback

  • Handler_update

  • Handler_write

  • Innodb_buffer_pool_pages_data

  • Innodb_buffer_pool_bytes_data

  • Innodb_buffer_pool_pages_dirty

  • Innodb_buffer_pool_bytes_dirty

  • Innodb_buffer_pool_pages_flushed

  • Innodb_buffer_pool_pages_free

  • Innodb_buffer_pool_pages_misc

  • Innodb_buffer_pool_pages_total

  • Innodb_buffer_pool_read_ahead_rnd

  • Innodb_buffer_pool_read_ahead

  • Innodb_buffer_pool_read_ahead_evicted

  • Innodb_buffer_pool_read_requests

  • Innodb_buffer_pool_reads

  • Innodb_buffer_pool_wait_free

  • Innodb_buffer_pool_write_requests

  • Innodb_data_fsyncs

  • Innodb_data_pending_fsyncs

  • Innodb_data_pending_reads

  • Innodb_data_pending_writes

  • Innodb_data_read

  • Innodb_data_reads

  • Innodb_data_writes

  • Innodb_data_written

  • Innodb_dblwr_pages_written

  • Innodb_dblwr_writes

  • Innodb_have_atomic_builtins

  • Innodb_log_waits

  • Innodb_log_write_requests

  • Innodb_log_writes

  • Innodb_os_log_fsyncs

  • Innodb_os_log_pending_fsyncs

  • Innodb_os_log_pending_writes

  • Innodb_os_log_written

  • Innodb_page_size

  • Innodb_pages_created

  • Innodb_pages_read

  • Innodb_pages_written

  • Innodb_row_lock_current_waits

  • Innodb_row_lock_time

  • Innodb_row_lock_time_avg

  • Innodb_row_lock_time_max

  • Innodb_row_lock_waits

  • Innodb_rows_deleted

  • Innodb_rows_inserted

  • Innodb_rows_read

  • Innodb_rows_updated

  • Innodb_truncated_status_writes

  • Key_blocks_not_flushed

  • Key_blocks_unused

  • Key_blocks_used

  • Key_read_requests

  • Key_reads

  • Key_write_requests

  • Key_writes

  • Last_query_cost

  • Max_used_connections

  • Not_flushed_delayed_rows

  • Open_files

  • Open_streams

  • Open_table_definitions

  • Open_tables

  • Opened_files

  • Opened_table_definitions

  • Opened_tables

  • Performance_schema_cond_classes_lost

  • Performance_schema_cond_instances_lost

  • Performance_schema_file_classes_lost

  • Performance_schema_file_handles_lost

  • Performance_schema_file_instances_lost

  • Performance_schema_locker_lost

  • Performance_schema_mutex_classes_lost

  • Performance_schema_mutex_instances_lost

  • Performance_schema_rwlock_classes_lost

  • Performance_schema_rwlock_instances_lost

  • Performance_schema_table_handles_lost

  • Performance_schema_table_instances_lost

  • Performance_schema_thread_classes_lost

  • Performance_schema_thread_instances_lost

  • Prepared_stmt_count

  • Qcache_free_blocks

  • Qcache_free_memory

  • Qcache_hits

  • Qcache_inserts

  • Qcache_lowmem_prunes

  • Qcache_not_cached

  • Qcache_queries_in_cache

  • Qcache_total_blocks

  • Queries

  • Questions

  • Rpl_status

  • Select_full_join

  • Select_full_range_join

  • Select_range

  • Select_range_check

  • Select_scan

  • Slave_heartbeat_period

  • Slave_open_temp_tables

  • Slave_received_heartbeats

  • Slave_retried_transactions

  • Slave_running

  • Slow_launch_threads

  • Slow_queries

  • Sort_merge_passes

  • Sort_range

  • Sort_rows

  • Sort_scan

  • Ssl_accept_renegotiates

  • Ssl_accepts

  • Ssl_callback_cache_hits

  • Ssl_cipher

  • Ssl_cipher_list

  • Ssl_client_connects

  • Ssl_connect_renegotiates

  • Ssl_ctx_verify_depth

  • Ssl_ctx_verify_mode

  • Ssl_default_timeout

  • Ssl_finished_accepts

  • Ssl_finished_connects

  • Ssl_session_cache_hits

  • Ssl_session_cache_misses

  • Ssl_session_cache_mode

  • Ssl_session_cache_overflows

  • Ssl_session_cache_size

  • Ssl_session_cache_timeouts

  • Ssl_sessions_reused

  • Ssl_used_session_cache_entries

  • Ssl_verify_depth

  • Ssl_verify_mode

  • Ssl_version

  • Table_locks_immediate

  • Table_locks_waited

  • Tc_log_max_pages_used

  • Tc_log_page_size

  • Tc_log_page_waits

  • Threads_cached

  • Threads_connected

  • Threads_created

  • Threads_running

  • Uptime

  • Uptime_since_flush_status