Database Instance Settings
From the left menu select Settings/Instances and then click the Create button. Here you can define the target database instance you would like to monitor.
Pre-requisites​
Check that the database is of a supported database type.
Before adding the database target, please read the pre-requisites for the database you would like to monitor.
List Database Targets​
The list shows any Database Targets you have defined and you have the option to start, stop, edit or delete them.
- When editing a sensor it will stop the sensor and you will need to start it again.
- Mouseover on the status icon on the left side shows the status of the Sensor. Examples would be "Started", "Stopped", "Starting", "Stopping" and if there are connectivity issues connecting to the database the error will be shown here.
- Mouseover on the Start/Stop button shows the reason the Sensor was Started or Stopped. Examples would be "Stopped - License count exceeded" or "Started - User initiated".
- The status and reason are the last know status and reason for the Sensor and if you have just made a change, could take up to 1 minute before you see them update.
Creating a new Database Target​
The following parameters need to be defined.
| Parameter | Description |
|---|---|
| Name | Enter any free-text identifier to give your target database instance a meaningful name. Names must be unique. |
| Database Type | Choose from the list of supported databases. E.g. MySQL |
| Debug Mode | In most cases you should leave Debug off unless directed by Support. |
| Database Host | The hostname, fully qualified DNS name or IP address of the target database instance. This will be used to make the connection from the DBmarlin Agent and so must by reachable over the network. |
| Database Port | Select the TCP Port that the database instance is listening on. This will be used to make the connection from the DBmarlin Agent and so must be open over the network. |
| Username | The username within the target database instance that you will connect as. We recommend that you create a dbmarlin user configured as describe in the docs. MySQL user, PostgreSQL user, Oracle user, SQL Server user, CockroachDB |
| Password | The password for the username you are using. |
| Collect SQL Statistics | Enable collection of SQL statistics at the statement level such as Executions and Duration. |
| Collect Extended SQL Statistics | Enable collection of additional SQL statistics at the statement level such as CPU time or Logical reads. The additional SQL statistics can be configured on the SQL Statistics Settings screen |
Advanced Connection Settings​
If you toggle the "Advanced mode" there are addition settings you might need to set for a sensor.
If a custom JDBC connection URL is specified then this takes priority over anything set in the Host and Port fields. The Username and Password field will still be used however.
| Parameter | Description |
|---|---|
| Connection String | Override the default JDBC connection string and enter a custom JDBC connection URL if required. |
| Connection Parameters | This can be useful for example if you need to set a custom JDBC parameter such as SSL enabled or ServerTimezone |
| Monitoring Interval (milliseconds) | How often the DBmarlin agent samples the active sessions and SQL statements in the target database. For more see FAQ |
| Batch Interval | How often the batch process runs. This includes change detection for parameters and schema objects as well as collection of SQL statistics. For more see FAQ |
| Detect Changes | Enable or disable change detection of database parameters and schema objects such as databases, table and indexes. For more see FAQ |
| Debug Enabled | Only enable if advised by support. DBmarlin log files will be many time larger with debug enabled. |
Video Walk-through​
This short video walk-through showing how to add a new Database Target for monitoring with DBmarlin.