Documents
Product Categories
Navicat-Monitor-Window-Prod-Image
Product Categories
Navicat-Monitor-Window-Prod-Image
Navicat-Monitor-Window-Prod-Image
Jun 28, 2024: of your Navicat Monitor. You need to complete the basic configuration of
Navicat Monitor in the Welcome page.
Note: is the host name of the system that installed Navicat Monitor, and is 3000
by default. For Linux version, you need to open the browser and go to http://:
manually.
If you want to import Navicat Monitor configuration settings, see Migration / Backup for details.
14Create Superuser Account
Superuser is a local user (Manager) account which has unlimited access to Navicat Monitor functionalities.
1. In the Welcome page, click Initial Settings.
2. Enter the profile information of the superuser: Username, Password, Full Name, Email, Mobile.
3. Click Next.
Set Repository Database
Repository database stores alerts and performance metrics data for historical analysis. It can be either a MySQL
database, MariaDB database, PostgreSQL database or Amazon RDS instance. We do not recommend setting the
repository database to an instance that you plan to monitor or a production database.
Note: Manager can change the repository database anytime after the initial setup, see Repository Database for details.
1. Choose the Database Type of the repository database.
2. Enter the connection information to the database.
IP Address The host name or IP address of the database server.
Port The TCP/IP port for connecting to the database server.
Database Name The name of the repository database. It can be either an empty existing
database or a new database created by Navicat Monitor.
Username User name for connecting to the database server. The user account must
have the following privileges:
MySQL / MariaDB - SELECT, INSERT, UPDATE, DELETE, CREATE,
15DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, CREATE
VIEW on all database objects
PostgreSQL - Can login, Can create database and Superuser
Password Password for connecting to the database server.
3. Click Next.
Set Application Information
1. Edit the application information if necessary.
Port The port number that Navicat Monitor will listen.
Web URL The website URL of Navicat Monitor that will be used in Alert emails.
IP Address If the machine has been assigned multiple IP addresses, you can specify
an IP address for users to access Navicat Monitor. 0.0.0.0means all IP
addresses on the machine.
162. Click Next.
Confirm Settings
Confirm the configuration information, and click Finish. Initial configuration process may take a few minutes for setting
up the repository database.
Log in Navicat Monitor
After the configuration completed successfully, a login page will be displayed and you can log in Navicat Monitor with
the manager user account.
17User Interface
Main Toolbar
Navigation Menu
The Navigation Menu allows you to access basic features, such as Overview, Alerts, Query Analyzer, Replications and
Configurations.
Bell Icon
When an upgrade is available, a blue dot next to the bell icon lets you know there are notifications to view. Click the bell
icon to view the notification.
User Menu
The User Menu allows you to open your own profile page and log out the current user''s session. If you have enough
privileges, you can open the Activation page.
Navicat Monitor Manager
Navicat Monitor Manager is a small utility that provides quick access to Navicat Monitor, shows the status information
of the application, notifies you any changes and updates. It is only available in Windows and macOS versions.
18Status The current status of the Navicat Monitor application.
Start / Stop Start or stop the Navicat Monitor application.
Open Navicat Monitor Launch Navicat Monitor in a browser.
Check For Update Check for an update, and prompt to install the latest version if any.
About Navicat Monitor Show the version number of your Navicat Monitor.
Quit Exit Navicat Monitor Manager. It does not stop the Navicat Monitor
application.
Create Instances
Once you have finished the Initial Settings and have logged in Navicat Monitor, you can create the instances you want
to monitor. Navicat Monitor uses an agentless architecture to monitor your database servers and collect data at regular
intervals. It does not require installing any agent software on the servers being monitored.
You can create new instances on the following pages by clicking + New Instance and selecting the server type.
Overview
Configurations
In the New Instance window, enter a friendly name to best describe your instance in Instance Name and select the
Group of your instance. If you want to add a new group, click New Group. Then, provide the following information to
connect your server.
19Connect Gateway Server
Navicat Monitor can connect the database server over a secure SSH tunnel to send and receive monitoring data. It
allows you to connect your servers even remote connections are disabled or are blocked by firewalls.
1. In the Gateway Server section, enable Connect to gateway server through SSH tunnel.
2. Enter the following information:
Host Name The host name of the SSH server.
Port The port where SSH server is activated, by default it is 22.
Username A user on SSH server machine. (It is not a user of database server.)
Authentication Method The type of authentication: Password or Public Key.
Password [Password Authentication] Password for login SSH server.
Private Key [Public Key Authentication] It is used together with your public key. The
private key should be readable only by you.
Note: Put your private key file in Navicat Monitor > Private Key folder.
Passphrase [Public Key Authentication] A passphrase is exactly like a password,
except that it applies to the keys you are generating and not an account.
Enter Instance Connection Details
1. In the MySQL Server or MariaDB Server section, enter the following information:
Host Name The host name or IP address of the database server.
Port The TCP/IP port for connecting to the database server.
Username A monitoring user for connecting to the database server.
We recommend creating a separate account for the monitoring user
which does not causes load on the monitored instance. You should
grant REPLICATION CLIENT, SUPER, PROCESS and SELECT on all
database objects to the monitoring user.
Password The login password of the monitoring user.
Server Type The type of the server: Unix-like or Windows.
2. Click New.
Login SSH / SNMP to Access System Metrics
Navicat Monitor works over SSH / SNMP to access and collect server''s system performance metrics such as CPU and
memory resources. If you do not provide this login, you can still monitoring your server without the system performance
metrics shown.
Unix-like Servers
1. In the CPU & Memories section, enable Login SSH to access data of CPU & Memories.
202. Enter the following information:
Port The port where SSH server is activated, by default it is 22.
Username A user on SSH server machine. (It is not the user of database server.)
Authentication Method The SSH authentication method: Password or Public Key.
Password [Password Authentication] Password for login SSH server.
Private Key [Public Key Authentication] It is used together with your public key. The
private key should be readable only by you.
Note: Put your private key file in Navicat Monitor > Private Key folder.
Passphrase [Public Key Authentication] A passphrase is exactly like a password,
except that it applies to the keys you are generating and not an
account.
3. Click New.
Windows Type Servers
1. In the CPU & Memories section, enable Login SNMP to access data of CPU & Memories.
2. Enter the following information:
Community The SNMP community string (acts as a password) that is assigned on
the server for authentication.
3. Click New.
Note: When you connect a Windows type server using a gateway, Navicat Monitor cannot access system metrics.
21Chapter 3 - Configurations
Activation
When the trial period of an instance is finished, Navicat Monitor requires tokens to continue monitoring that instance. If
you have purchased tokens in our website, you will receive a token key for activating the purchased tokens in Navicat
Monitor. To manage your tokens and license your instances, go to Configurations -> Activation.
Activate Tokens
In the # Local Activated Tokens section, paste your token key into the Enter Token Key text box and click the
Activate button. Navicat Monitor contacts our licensing server to activate the token key. If the activation process is
successful, the token key details are displayed.
Offline Activation
Offline activation is available when your computer does not have an internet connection. You will need another
computer with an internet connection to complete this activation process.
1. In the No Internet Connection dialog, click Offline Activation.
2. Copy the Request Code in the Copy the Request Code Here: box.
3. Open web browser on a computer with an internet connection and then go to
https://customer.navicat.com/manual_activate.php.
4. Paste/Enter the Request Code into the left box.
5. Click Get Activation Code.
6. Copy the generated Activation Code in the right box.
7. Go back to the computer where you are activating Navicat Monitor.
8. Paste the Activation Code into the Paste the Activation Code Here: box.
9. Click Activate.
Allocate Tokens
In the # of # Tokens Available section, all unlicensed instances are displayed in the Unlicensed Instances list and all
licensed instances are displayed in the Licensed Instances list. You can allocate available tokens to your unlicensed
instances, select an unlicensed instance and click the License > button. If you want to release tokens for licensing
other instances, select a licensed instance and click the < Unlicense button.
22Note: When the trial period expires, Navicat Monitor stops monitoring and collecting data from all unlicensed instances,
and will not raise alerts for them.
Deactivate Tokens
In the # Local Activated Tokens section, click the Deactivate button next to the token key you want to deactivate.
Navicat Monitor contacts our licensing server to deactivate the token key. If the deactivation process is successful, the
token key details are removed from the list.
If there is not enough available tokens for deactivating your token key, you may need to unlicense your instances to
release some tokens. Otherwise, the Deactivate button will not be enabled.
Repository Database
Migrating an existing repository database to a different database can include moving to a different database type (for
example, MySQL to PostgreSQL), or migrating to a database on a different operating system (for example from
Windows to macOS).
If you want to migrate your Repository Database, follow these steps:
1. Stop the Navicat Monitor application by executing command or using the icon in the system tray / menu bar.
2. In your database management tool, copy your current repository database (all tables with both structure and
data) to your new repository database.
3. Start the Navicat Monitor application and launch Navicat Monitor in your browser.
4. Go to Configurations.
5. Click Repository Database.
6. Click Edit Settings.
237. Edit the repository database settings.
Database Type The type of the database server
IP Address The host name or IP address of the database server.
Port The TCP/IP port for connecting to the database server.
Database Name The name of the repository database.
Username User name for connecting to the database server. The user account
must have the following privileges:
MySQL / MariaDB - SELECT, INSERT, UPDATE, DELETE, CREATE,
DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, CREATE
VIEW on all database objects
PostgreSQL - Can login, Can create database and Superuser
Password Password for connecting to the database server.
8. Restart the Navicat Monitor application to resume monitoring.
Application
You can view or change the application settings of Navicat Monitor, such as Port, Web URL and IP Address. To
configure the application settings, go to Configurations -> Application.
The application settings of Navicat Monitor is listed.
Port The port number that Navicat Monitor will listen.
Web URL The website URL of Navicat Monitor that will be used in the Alert emails.
IP Address If the machine has been assigned multiple IP addresses, you can specify
an IP address for users to access Navicat Monitor. 0.0.0.0 means all IP
addresses on the machine.
Note: Once you have changed the above settings, you should restart the Navicat Monitor application for it to take
effect.
Migration / Backup
Export Monitor Settings
Exporting Navicat Monitor settings can be useful if you want to migrate application server or for backup purposes. The
exported zip file includes Token Keys, Instance Settings, Repository Database Settings and all the files necessary for
the restoration.
1. Go to Configurations.
2. Click Export Monitor Settings.
3. In the Export Monitor Settings window, click Download Monitor Settings Zip.
244. If your are migrating the application server, you must deactivate all Token Keys in the Activation page before
activating them in a new application server.
Import Monitor Settings
After you installed Navicat Monitor on a new server, you can import the Monitor Settings file (the exported zip file) in
Initial Settings.
Note: You can only migrate settings within the same major and minor release. For example, Navicat Monitor v1.1.x
only accept v1.1.y zip file.
1. Start and open Navicat Monitor.
2. Click Import Monitor Settings.
3. Drop or browse the zip file to upload it.
4. Click Unlock Monitor Settings.
5. After the settings are unlocked, click Continue.
6. Modify the repository database settings if necessary.
7. Click Restore Monitor Settings.
8. If the restoration is successful, click Continue.
9. All existing tokens are listed. Click Activate if you want to activate them now. And then, click Continue.
10. Allocate the activated tokens to licenses existing instances.
11. Click Finish.
General Settings
You can configure the security, date & time, log, LDAP and Active Directory settings. To configure the basic settings of
Navicat Monitor, go to Configurations -> General Settings.
Security
You can change the requirements of the user passwords to increase the password strength and enforce all other user
sessions to log out.
Date & Time
The date and time information of Navicat Monitor is listed. You can enable the Use a 24-hour clock to use the 24 hour
system.
Log House Keeping
25Navicat Monitor logs the detailed server errors and messages for tracking down any problems occurred in the servers.
You can control the build retention policy for logs by specifying both the Maximum size of each build and the
Maximum no. of builds to keep.
LDAP Settings
Navicat Monitor is able to authenticate users via an externally hosted LDAP server. To use LDAP authentication,
configure the following information:
LDAP Server Host Name Enter the host name, IP address or URL of your LDAP server.
Encryption Select the encryption for communicating with your LDAP server.
Port Enter the port for connecting your LDAP server.
LDAP server allows Turn on this option if your LDAP server allows anonymous binds.
anonymous bind
User Search Base Enter the search base filter to search for the user. (For example: If your
users are located in "domain.com", then the search base filter would be
dc=domain,dc=com)
User DN Enter the user distinguished name to bind to your LDAP server if it does
not allow anonymous binds. (For example: If your user name is admin,
then the User DN would be cn=admin,dc=domain,dc=com)
Password Enter the password for the User DN specified.
Test Settings Click this button to test the connection between Navicat Monitor and your
LDAP server.
Authentication mode Select the authentication mode to use for authenticating the user with your
LDAP server.
[Comparison Enter the attribute name that contains the password-based authentication
Authentication] Password mechanism name.
attribute name
[Comparison Select the password-based authentication mechanism.
Authentication] Password
digest mechanism
User Search Attribute Enter the attribute name that contains the user login name.
Microsoft AD Settings
You can configure Navicat Monitor to authenticate users with Microsoft Active Directory (AD) credentials. To use Active
Directory authentication, configure the following information:
AD Server Host Name Enter the host name or IP address of your AD server.
User Search Base Enter the search base filter to search for the user. (For example: If your
users are located in "domain.com", then the search base filter would be
dc=domain,dc=com)
User DN Enter the user distinguished name to bind to your AD server. (For example:
If your user name is admin, then the User DN would be
26cn=admin,dc=domain,dc=com)
Password Enter the password for the User DN specified.
Test Settings Click this button to test the connection between Navicat Monitor and your
AD server.
Users & Roles
Manage Users
Navicat Monitor allows creating local users, or external users using LDAP or AD authentication. Go to Configurations
-> Users to configure users.
Note: The manager user account created during Initial Setup cannot be changed to LDAP or AD user.
Hint: You can view or edit your own profile by clicking your user icon on the top left corner and selecting My Profile.
Create New Users
You can create new users by clicking + Create New User in the left pane.
To create local users
1. Select the Local User tab.
2. Enter the Username and Name.
3. Assign a Role to the new user.
4. Enter the Password, Confirm Password.
5. Click the icon and enter user''s email and phone number.
6. Repeat Step 2 - 5 to add another new user.
7. Click Create User.
To create LDAP users
1. Select the LDAP User tab.
2. Enter the LDAP Username and Name.
3. Assign a Role to the new user.
4. Click the icon and enter user''s email and phone number.
5. Repeat Step 2 - 4 to add another new user.
276. Click Create User.
Hint: To set the LDAP settings, you can go to General Settings.
To create AD users
1. Select the AD User tab.
2. Enter the AD Username and Name.
3. Assign a Role to the new user.
4. Click the icon and enter user''s email and phone number.
5. Repeat Step 2 - 4 to add another new user.
6. Click Create User.
Hint: To set the Microsoft AD settings, you can go to General Settings.
Manage Existing Users
To edit a user
1. In the left pane, select a user.
2. Modify the user profile.
3. Click Update Profile.
To delete a user
1. In the left pane, hover over the icon next to the user.
2. Select Remove User.
Manage Roles & Privileges
Roles are collections of privileges to which users are assigned. By default, Navicat Monitor includes three predefined
roles for you to assign to difference users for restricting their access. It also allows you to create new roles with
customized privileges settings. To configure roles and their privileges, go to Configurations -> Roles & Privileges.
Each predefined roles has different privileges:
Role Privileges
Manager Can access all pages with full control. The privileges of this role are
non-editable.
DBA Can access all pages, except the following features:
- Activate Token Keys, and License / Unlicense instances
28- Edit General Settings, Repository Database, Data Purge
- Retrieve all log files
- Edit Alert Notification Settings
- Add / Remove / Edit Users'' Profiles, Roles & Privileges
Operator Can access all pages, except the following features:
- End Process in Query Analyzer
- All configuration changes
Set IP Address Restrictions
As a manager, you can restrict login access at the role-level to prevent users from logging in to Navicat Monitor from
any unauthorized locations. If IP address restrictions are defined for a role, the restrictions impacts all users belong to
that role. To set a range of IP addresses or a single IP address to restrict for a role:
1. In the left pane, select a role.
2. In the IP Address Restrictions section, click + Add Range.
3. Choose the Type of the IP address: IPv4 / IPv6.
4. Enter the Subnet.
5. Click Save.
Create New Roles
You can also create new roles to suit the access control needs of users. Based on their needs, you can create
customized roles which can be assigned to the desired users to empower them to perform tasks, within the specified
boundaries.
1. In the left pane, click + New Customized Role.
2. Enter the Role Name.
3. In the IP Address Restrictions section, click + Add Range if you want to restrict the access of the new role
from an IP Address range.
4. In the Privileges section, turn on the privileges that you want to grant to the role.
5. Click Save.
Manage Existing Roles
To edit a role
1. In the left pane, select a role.
2. Modify the role profile: Role Name (only for customized roles), IP Address Restrictions settings or Privileges.
293. Click Save.
To duplicate a role
1. In the left pane, hover over the icon next to the role.
2. Select Duplicate.
3. The newly created role is named role_name Copy.
To delete a customized role
1. In the left pane, hover over the icon next to the role.
2. Select Delete.
Instances & Groups
Manage Instances & Groups
Navicat Monitor can monitor multiple servers. You can create instances, categorize your instances into groups, and
assign members. To configure instances and groups, go to Configurations -> All Instances.
To create a new instance to monitor your server, click + New Instance and select the server type. Then, enter the
appropriate information in the New Instance window. See Create Instances for details.
Manage Instances
To edit an instance
1. Select an instance.
2. Modify the instance settings.
3. Click Edit.
Hint: To change the group of instances, simply drag-and-drop selected instances from a group to another.
To suspend monitoring an instance
1. Select an instance.
2. Click More Action and select Pause Monitor.
To change the group of an instance
1. Drag and drop an instance into a group in the left pane.
To delete an instance
301. Select an instance you want to delete.
2. Click More Action and select Delete Instance.
Hint: Deleting multiple instances is supported.
Manage Groups & Members
Groups allow you to organize your instances into collections. Each group is shown as a tab label in the Overview page
for filtering the instances quickly. You can also assign users to specific groups as members. If alert notification has
configured, Navicat Monitor will send notifications to all members in the group at once when a alert is raised.
All groups are displayed on the left pane and the members of the selected group are displayed on the right pane.
To create a new group
1. Click + New Group.
2. Enter the name of the new group.
3. Click New.
To rename a group
1. In the left pane, hover over the icon next to the group.
2. Select Rename Group.
3. Enter a new group name.
4. Click Rename.
To add members to a group
1. In the left pane, hover over the icon next to the group.
2. Select Add Members to Group.
3. Enter the name or username of users.
4. Click Add Members.
To remove a member from a group
1. In the left pane, select a group.
2. In the right pane, click the member avatar that you want to remove.
3. Select Remove from Group.
31To delete a group
1. In the left pane, hover over the icon next to a group.
2. Select Delete.
Set Maintenance Windows
If you have to do maintenance work on your servers regularly, you may want to suspend monitoring and stop receiving
alerts from Navicat Monitor during maintenance. Navicat Monitor provides the ability for you to set maintenance window
time periods to disable monitoring selected instances. During that period, no alerts are raised and no notifications are
sent out. To set the maintenance windows of instances, go to Configurations -> All Instances.
Note: You can also suspend monitoring on an individual instance manually. See the "To suspend monitoring an
instance" section above.
To set maintenance window
1. Find the relevant instance.
2. Click the Set Maintenance Window button in the Maintenance Window column.
3. Enter / select the date and time that you want the maintenance window to start, its duration and recurrence
pattern.
4. Click Save.
Hint: Click More Action and select Set Maintenance Window to set maintenance window for selected instances.
To edit the maintenance window
1. Find the relevant instance.
2. Click the Edit button in the Maintenance Window column.
323. Modify the time period.
4. Click Save.
To delete the maintenance window
1. Find the relevant instance.
2. Click the Delete button in the Maintenance Window column.
Hint: Click More Action and select Delete Maintenance Window to delete maintenance window for selected
instances.
Alerts
Adjust Alert Policy
Alert is triggered when a monitored metric value crosses a specified threshold for a certain duration. You can enable or
disable alerts and change their thresholds and inherit settings. To configure the alert policy, go to Configurations ->
Alert Policy.
The Alert Type table displays all available alerts and their details. There are three types of alerts: System, Security and
Performance.
Change Inherit Settings
By default, when you open the Alert Policy page, you are at the All Instances level. You can select a level on the left
pane to view its alert policy settings. Those alerts that have been customized at the selected level are marked as This
level in the Inherit From column.
1. In the left pane, select a level.
2. In the Alert Type table, check the box of an alert.
3. Click Configure Alerts.
4. Choose Inherit settings from:
33Parent Inherit the Alert Settings and Notification Settings from its parent level.
Customize for this level Apply customized Alert Settings and Notification Settings for the
and level below selected level and all levels below it.
5. Click Save.
Hint: Changing inherit settings for multiple alerts is supported.
Enable / Disable Alerts
When Navicat Monitor is first installed, all alerts are enabled by default to identify any potential problems with your
instances.
1. In the left pane, select a level.
2. In the Alert Type table, check the box of an alert.
3. Click Configure Alerts.
4. Turn Enable Alert to ON or OFF.
5. Click Save.
Hint: Enabling or disabling multiple alerts is supported.
Set Alert Thresholds
Navicat Monitor raises alerts when certain thresholds are reached. Each alert has its default thresholds. You can adjust
the settings to suit your case.
1. In the left pane, select a level.
2. In the Alert Type table, check the box of an alert.
3. Click Configure Alerts.
4. In the Alert Settings section, configure the following information:
Raise this alert when: Set the threshold that triggers the alert.
Critical If the monitored value crosses the defined value, Navicat Monitor will
raise a Critical alert.
Warning If the monitored value crosses the defined value, Navicat Monitor will
raise a Warning alert.
for longer than Set the duration that the monitored value crosses the defined value.
5. Click Save.
Set Notification Settings
34Navicat Monitor can send notifications to recipients each time an alert is triggered. You can set who will receive the
notifications when an alert is triggered.
1. In the left pane, select a level.
2. In the Alert Type table, check the box of an alert.
3. Click Configure Alerts.
4. In the Notification Settings section, configure the following information:
Send notification when: Select the alert statuses (raised, ended) you want to send notifications.
Via: Select the methods (Email, SMS, SNMP) you want to send
notifications.
Recipient (Email & Select users and/or specific email addresses you want to notify.
SMS):
5. Click Save.
Note: Notification is generated when the alert is "Enabled" and the channels to receive notifications must be
configured.
Hint: Changing notification settings for multiple alerts is supported.
Edit Manager Note
Managers and users who have permission assigned to their roles can create manager notes to help other users
investigate alerts. It will show in the Alert Details page when the alert is triggered. With manager notes, users can
understand the status of an alert, or help resolve problems identified by the alert.
1. In the left pane, select a level.
2. In the Alert Type table, check the box of an alert.
3. Click Configure Alerts.
4. Enter a note for that alert in the Manager note: text box.
5. Click Save.
Set Up Notifications
Navicat Monitor provides 3 channels (emails, SNMP traps and SMS messages) to send notifications whenever an alert
is raised in your monitoring or a system problem while you are using it. To configure the alert notifications, go to
Configurations -> Notifications.
Email Notifications
1. In the Email section, enable System error message raised and/or Alert raised.
352. Configure the following information:
SMTP Server Enter your Simple Mail Transfer Protocol (SMTP) server for outgoing
messages.
Port Enter the port number you connect to your outgoing email (SMTP)
server.
Require a secure (TLS) Enable this option if your SMTP server requires an secure encrypted
connection connection.
Mail server requires a Enable this option if your SMTP server requires authorization to send
username and password email. Enter Account username and Password.
Send from Email Enter an email address that used in the "From" field for all notification
Address emails sent by Navicat Monitor.
Send test email to this Enter an email address to send a test email for checking your
email address / Send configuration.
Test Email
3. Click Save.
Note: If the System error message raised option is on, you will receive log files generated by Navicat Monitor when a
system problem occurred. You can submit the logs to Navicat Support Center.
SNMP Notifications
1. In the SNMP v2c section, enable Alert raised.
2. Configure the following information:
SNMP Target Address Enter the IP address of your server which receive the SNMP traps.
SNMP Target Port Enter the Port number of your server which receive the SNMP traps.
SNMP Community String Enter the SNMP community string (acts as a password) that is
assigned on your server for authentication.
Download MIB file Download the MIB file provided by Navicat Monitor and load it into your
server.
Send Test Trap Send a test trap to the target and port you specified.
3. Click Save.
SMS Notifications
1. In the SMS section, enable Alert raised.
2. Configure the following information:
Service Provider Select the SMS service provider based on your requirement: Clickatell,
Twillio or Others.
API Key [Clickatell] Enter the unique API Key of your Clickatell account.
Account SID [Twillio] Enter the unique Account SID of your Twillio account.
36Auth Token [Twillio] Enter the unique Auth Token of your Twillio account.
HTTP API URL [Others] Enter the URL of the HTTP-API for sending SMS messages.
Post / Get [Others] Choose to send SMS messages using a HTTP POST or HTTP
GET request.
Message Key [Others] Enter the parameter name of the text of the SMS message.
Recipient Mobile No. Key [Others] Enter the parameter name of recipients'' mobile number.
Other Key(s) [Others] Enter the other parameter names required for sending
messages through your SMS provider, e.g. username, password.
Value [Others] Enter the value of the parameter you specified.
Send test sms to this Select a country and enter a phone number to send a test SMS message
phone number / Send for checking your configuration.
Test SMS
3. Click Save.
Data Purging
The repository database stores all data collected by Navicat Monitor during monitoring process. It might consume large
amounts of your hard disk space. To prevent the database from growing too large or use all your hard disk space, you
can set a regular automatic data purge. To configure the data purging settings, go to Configurations -> Data Purging.
Data is stored in two categories: alert and performance data. Alert Data is displayed on various sections of Overview,
Alert History and Alert Details pages and Performance Data is displayed on various sections of Overview, Instance
Details and Chart pages.
You can choose how long to keep data in each categories. ''Do Not Purge'' is set as default. It means data will be stored
indefinitely in the Repository Database. To change this setting, select a time option from the Purge Data Older Than
drop-down menu and click Save.
37Chapter 4 - Overview
Overview Dashboard
The Overview dashboard page shows all instances that are monitored by Navicat Monitor. You can get a high-level
summary information and the healthy status of your instances, identify instances which require critical attention.
Instance Cards
The instance cards let you identify the server status and system resource usage. To create a new instance to monitor
your server, click + New Instance and select the server type. Then, enter the appropriate information in the New
Instance window. See Create Instances for details.
By default, instance cards show all available system resource usages. Click X of Y Shown and uncheck the metrics
that you are not interested in. Select Restore Default to restore the cards to their default settings.
Hover over a metric in a card to bring up a small chart. Move the mouse pointer over on the chart to show the time and
the values at that point.
38You can click on an instance to view its details and metrics.
Pause monitoring an instance
You may want to pause monitoring a specific instance temporarily. Click the icon and select Pause
Monitoring. Navicat Monitor stops collecting information from the server until the monitoring resumes. To start
monitoring again, select Resume Monitoring from .
Stop refreshing metrics
Navicat Monitor refreshes the metrics on the dashboard every 60 seconds. To stop or start refreshing the metrics, click
the or icon. Server data collection does not stop during the stop period.
Change the order of instances
Click Sort by and select a sorting option. If you choose Alert Severity, the instance cards will be sorted by the severity
level from critical to low. To customize the position, click and hold the connection icon on an instance card and then
drag-and-drop the card to the desired position. Navicat Monitor automatically remembers your custom order.
39Filter instances
When creating a new instance, you are allowed to assign it to an availability group. Click on a group name label to
shows all instances that belong to it.
You can also filter instances by their health states. The colored tags show the total number of servers having critical
alerts (red), servers having warnings (orange) and healthy servers (green). Click on a tag to filter the instances by
states in the selected group.
Search instances
If you are monitoring many instances, you can find the instances you want easily by the search feature. Enter a search
string in the Search for an Instance text box. Instance cards will be filtered by the search string immediately.
Latest Alerts
The right pane displays the recent alerts that Navicat Monitor raise. It can be hidden by clicking the icon. Click on
an individual alert, you will be directed to its details page, or click View All History to open the Alerts page.
Instance Details
View Instance Details
In the Overview page, click on an instance card to open its Instance Details page. It shows the server parameters and
metrics visually, gives you a quick view of the server load and performance. You can pause and resume monitoring the
instance here by using the Pause Monitoring and Resume Monitoring buttons. Navicat Monitor stops
collecting information from the server until the monitoring resumes.
40All monitored instances are shown in the left pane. Select an instance to view information related to it.
Information on Instance Details Page
Summary
It displays host information about the server, server properties, alerts and status. To view or edit the instance variables,
click View & Edit. If alert is raised, click on the alert to open the alert page.
It displays the top five databases or tables by size, and a sixth category called "Others" that groups the remaining
databases or tables. It is a quick and easy way to see which databases and tables on your server are the largest.
Databases & Tables
You can hover over each segment to show the size percentage. To view size information of all databases and tables in
the instance, click View All.
Charts
Navicat Monitor displays server performance metrics in the form of visualizations that are represented as small charts.
The charts track and refresh the data at the certain intervals, displays related metrics using different predefined colors
and symbols. In the small charts, the axis scales and labels are not printed.
41The time interval (Y-axis) and refresh options are configurable, use the Refresh Time drop-down menu, the datetime
picker, the time Interval drop-down menu and the panning arrows.
You can move the mouse pointer a point on the chart to read the values. To view the details of an individual chart or
more charts, click on a chart to open the Chart page.
View & Edit Instance Variables
In the Instance Details page, click View & Edit to view or edit the server variables. The Instance Variables page
displays the server variables, allows you to compare variables of multiple servers to determine why the performance of
one server is not as well as the others in the same condition.
Select multiple instances on the left pane to compare their variables. The values are listed side-by-side, differences can
be clear at a glance. Inapplicable variables are marked with N/A.
To edit a variable, hover over a value and click Edit.
42View Database & Table Size
In the Instance Details page, click View All under the Databases & Tables section. The Databases & Tables page
displays a list of databases and tables with their size in the server. The list is ordered by size. Click an instance in the
left pane to jump to its Databases & Tables page.
Charts
About Charts
Each small chart in the Instance Details page can be opened as a large chart. The Chart page shows metrics against a
specified sample interval and the detailed chart information. It displays related metrics using different predefined colors
and symbols. When the instance was stopped monitoring in a period, no metrics are available for that period in the
chart.
Navicat Monitor provides over 40 types of charts. You can change the chart type by clicking the chart title.
43Navicat Monitor supports 2 time series charts: Area Chart and Line Chart. To switch between line and area charts, click
or .
Area Chart
Line Chart
The time selector is for selecting a time span and an interval (X-axis) to display within the chart. It contains a datetime
picker, an interval drop-down menu and panning arrows.
Hint: Zoom in/out of the chart using the mouse wheel to customize the time interval. Click and drag the chart left or
right to change the time span.
Move the mouse pointer over a point on the chart to show the time and the legend with metrics at that point. Calculated
statistics (Mean, Min and Max) for the selected instance within the sample time are shown at the bottom.
44Compare Metrics
You can display metrics of multiple instances on the same chart simultaneously to compare and analysis data. Each
line / area on the chart represents the performance of a selected instance. Select the instances in the left pane to add
their metrics to the chart. Remove the metrics from the chart in the same way.
Export Charts
All charts can be exported as PDF files. To export the current chart, click .
A Single Chart
45A Compared Chart
46Chapter 5 - Alerts
About Alerts
Navicat Monitor raises alerts when it detects problems across your servers. There is two types of alerts: Warning
(orange) and Critical (red). Warning alert does not affect the performance of the server, but may indicate a problem
and require investigation. Critical alert indicates a serious issue which is affecting or will affect the performance of the
server. Such issues require immediate attention.
When an alert is raised, it displays on the Alerts History page and the Overview dashboard. Notifications will be sent to
the assigned group members or specific people.
You can customize thresholds to trigger alerts for specific instances and groups, and set sending alert notifications to
whom. See Alert Policy and Alert Notification for details.
Alert History
View Alert History
In the Alert History page, you can browse through the alert table, open a particular alert, assign it to a user, or select
multiple alerts at a time.
The alert table updates automatically to check for new alerts every 60 seconds. It displays the last 10 alerts based on
the time when the alerts were triggered. Alerts are sorted by the time they were raised (Start Time). Click a column title
to sort by that column.
All monitored instances are shown in the left pane. Select a level to show only alerts related to it.
To change the number of alerts shown per page, click Rows to Display and select a predefined number. By default, all
available columns in the list are shown. Click Show / Hide Columns and select the columns that you want to hide.
Select Restore Default to restore the list to its default settings.
If you want to view the detailed information of an alert, click on an alert to redirect to its details page. It is automatically
marked as read when you open it.
47Assign Alerts
1. Hover over the alert and click Assign to.
2. Select a user.
3. Click Assign User.
Filter Alerts
By default, the Alert History table displays the "Open" alerts in all instances. You can filter the alerts by using the left
instances pane, using the predefined filters, or creating your own filters.
Note: Applied filter is persisted when you select an instance or a group in the instances pane.
Instances Pane
The Instances Pane controls the instances for which alerts are displayed. If you select a group in the left list, then the
table only lists alerts relating to all instances in that group. And, the names of the instances are shown in the page
heading.
Predefined Filters
The Filter drop-down menu contains several predefined filters for filtering alerts. For example, you can view opened
critical or warning alerts, or all opened alerts.
Simply click on Filter and select a filter from the drop-down menu.
48Advanced Filter
The Advanced Filter enables you to filter your events based on customized criteria. Click Advanced Filter to expand
the Advanced Filter pane.
To collapse the Advanced Filter pane, click Advanced Filter again, or click Hide Filter at the bottom of the pane.
Apply an advanced filter
1. In the Advanced Filter pane, choose any combination of filter options you want.
2. Click Apply Filter.
Create a user-defined filter
1. After choosing the filter options in the Advanced Filter pane, click Save as Custom Filter.
2. Enter the filter name and click Save.
3. The custom filter is appeared in the Filter drop-down menu.
49Note: Delete a custom filter by clicking . The Alert History table defaults back to Open.
Alert Details
Click on an alert in the Overview page or the Alert History page to view its details page. In the Alert Details page, you
can view the detailed information of a raised alert, mark it as read/unread, open/close it, assign it to a member, add a
remark. When you open this page, the alert is automatically marked as "Read".
Information on Alert Details Page
Summary
It displays the current status of the alert, and its raised time and ended time.
Alert Details
It displays the alert name, the explanation of this alert, and the advice from Navicat Monitor which helps you investigate
and resolve the issue. Click Add Remark to write a remark for this alert.
Last Occurrences
It lists the least 5 alerts of this type raised for the current instance. Click View All to view all occurrences.
Charts
Various charts are shown depends on the alert type. They display various performance counter values and process
information captured around the time the alert was raised. Move the mouse pointer over a point on a chart to read the
values.
Assign Alerts
Assign an alert to a member
1. Click Assign to.
2. Select a user.
503. Click Assign User.
Unassign a user
1. In the Assign to column, click on the user avatar.
2. Select Clear Assigned User.
51Chapter 6 - Query Analyzer
Start Query Analyzer
The Query Analyzer tool provides a graphical representation for the query logs, enables you to monitor and optimize
query performance, visualize query activity statistics, analyze SQL statements, quickly identify and resolve long
running queries. To start using Query Analyzer, select an instance you want to analyze in the left pane, and analysis
starts immediately. After a while, analysis results are displayed:
Navicat Monitor refreshes the metrics in the Query Analyzer every 60 seconds. To stop or start refreshing the metrics,
click the or icon. Server data collection does not stop during the stop period.
Latest Deadlock Query
It shows the transaction information of the latest deadlock detected in the selected instance. You can click View All to
view all deadlocks.
Process List
It displays the total number of running processes for the selected instance, and lists the last 5 processes including ID,
command type, user, database and time information. You can click View All to view all processes.
Query Analyzer
Query Analyzer collects information about query statements by the following methods.
Retrieve the General Query Log from the server and analyze the information.
Retrieve the Slow Query Log from the server and analyze the information.
52 Query the performance_schema database and analyze specific performance information.
Note: Performance Schema is supported in MySQL Server 5.5.3 or later. Query statements are normalized and the
maximum length is 1024 bytes. Similar queries with different literal values are combined. Quoted values and numbers
are replaced by "?".
Top 5 Queries
The top 5 most time-consuming queries are displayed with a graph, giving you an immediate place to observe the
potential problems. You can click o refresh and update the top 5 queries list.
Top 5 Queries Based on Total Time - The query statement.
Count - The number of times that the query has been executed.
Total Time - The cumulative execution time for all the executions of the query.
User@Host - The user who executed the query.
Query Table
The query table provides the summary information for all of the queries executed. Occurrence statistics are calculated
and the result is displayed. Hover over a query to show the full query statement and click Copy Query to copy it.
Click Show / Hide Columns and select the columns that you want to hide. Select Restore Default to restore the table
to its default settings.
Queries can be filtered and sorted. Simply enter a search string in the Search for a query box to filter the table and
click the column name to sort the table.
To change the number of queries per page, click Rows to Display and select a predefined number. To change the
total number of queries in the table, click Total no. of Queries and select a predefined number.
53View Deadlocks
The Deadlock page displays all deadlocks detected on the selected instance that Navicat Monitor has information
about.
All monitored instances are shown in the left pane. Select an instance to show its process list.
By default, the deadlock list refreshes every 5 seconds automatically. If you want to change the auto-refreshing time,
use the Refresh Time drop-down menu. To pause the auto refresh, click .
Deadlocks can be filtered. Simply enter a search string in the Search for a deadlock box to filter the list.
To change the number of deadlocks shown per page, click Rows to Display and select a predefined number.
View Process List
The Process List page displays all processes currently running on the selected instance. You can check which queries
are currently being executed. The process list provides the following detailed information.
ID - The thread ID.
User@Host - The user who issued the statement.
DB - The database that the user is currently used.
Command - The type of command that the user issued.
54 Time - The time in seconds that the thread has been in its current state.
State - The state that indicates what the thread is doing.
Info - The statement that the user issued.
All monitored instances are shown in the left pane. Select an instance to show its process list.
By default, the process list refreshes every 5 seconds automatically. If you want to change the auto-refreshing time,
use the Refresh Time drop-down menu. To pause the auto refresh, click .
The list of threads can be filtered and sorted. Simply enter a search string in the Search for a thread box to filter the list
and click the column name to sort the list.
To change the number of threads shown per page, click Rows to Display and select a predefined number.
End Process
You may find slow or long running queries use lots of available CPU and memory resources and may block other valid
queries. To stop a thread instantly, click in the Action column, and then click End Process in the pop-up dialog.
55Chapter 7 - Replications
Monitored Replications
The Monitored Replications page displays all information related to monitored replication. You can monitor the health
of replication, diagnose replication issues and ensure the replication works seamlessly. Navicat Monitor provides
detailed information on status, configuration and performance of slaves.
Navicat Monitor supports 2 replication views: Diagram View and List View. To switch the view, click or .
If you want to view the detailed information of a replication, click on a slave to redirect to its details page.
Diagram View
This view visually displays the hierarchy and relationship of master servers and their slaves. Hover over a slave to
show its I/O thread and SQL thread statuses.
The instance blocks and the arrows are color-coded to represent the different states of the replication.
Green block indicates that the server is up (stable).
Red block indicates that the server is down.
Green arrow indicates that the replication is up and the slave is up-to-date with its master.
Red arrow indicates that the replication is down (disconnected) and the slave may be not up-to-date with its
master.
Hint: Zoom in/out of the graph using the mouse wheel. Click and drag the graph to move it.
List View
This view shows all registered master servers and slave servers and illustrates the replication details in a table. It
groups all master servers with their slaves. Common status information is displayed in columns. Click the arrow to the
left of each master name to expand or collapse its slaves status and configuration.
56The color bar represents different states of the replication slaves: stable (green), disconnected (red). Hover over it to
show the time.
Export Replications
You can export the replication diagram and list as a PDF file. To export the replication, click .
Replication Diagram
57Replication List
View Replication Details
The Replication Details page displays the detailed replication information for a slave you chosen in the Replication
page.
Information on Replication Details Page
Summary
At the beginning of this page, the slave and master servers information are listed. For multi-source replication, you can
click the master name to view its replication details.
Replication Up Down Chart
58It shows the Up/Down Status chart of the replication. The time selector is for selecting a time span and an interval
(X-axis) to display within the chart. It contains a datetime picker, an interval drop-down menu and panning arrows.
Error History
It shows the replication errors occurred during monitoring. To change the number of errors shown, click Rows to
Display and select a predefined number.
Slave Status & Slave Configuration
These two sections show the result set of the SHOW SLAVE STATUS statement.
59Chapter 8 - Commands
Navicat Monitor Commands
You can use the command line to manage Navicat Monitor application on Windows, macOS or Linux. The installation
folder or the program path of Navicat Monitor is:
Windows
C:\Program Files\PremiumSoft\Navicat Monitor
macOS
/Applications/NavicatMonitor.app/Contents/Resources/
Linux
/opt/navicatmonitor/x86_64-linux-gnu/
Note: On Linux operation systems, commands must be ran by the "navicatmonitor" account.
Syntax
navicatmonitor [command]
Available Commands
browser Open a browser with Navicat Monitor Web URL.
diagnostic Show diagnostic information.
help Print the help information of any command.
passwd Reset the Superuser password.
restart Restart Navicat Monitor.
start Start Navicat Monitor.
status Print the status information of Navicat Monitor.
stop Stop Navicat Monitor.
version Print the version number of Navicat Monitor.
Examples
/opt/navicatmonitor/x86_64-linux-gnu/navicatmonitor stop
C:\Program Files\PremiumSoft\Navicat Monitor\navicatmonitor restart
60Chapter 9 - Troubleshooting
Log Files
Navicat Monitor log files have detailed records of all sorts of server errors and messages. These files can help in
tracking down any problems with Navicat Monitor. Follow these steps to download the log files:
1. Go to Configurations.
2. Click About.
3. Scroll to the Diagnostics section.
4. Click Retrieve All Log Files to download a .zip file containing log files.
61">
To view the full page, please visit: Navicat-Monitor-Window-Prod-Image Product Userguide
