<img height="1" width="1" style="display:none;" alt="" src="https://dc.ads.linkedin.com/collect/?pid=204641&amp;fmt=gif">

dbWatch 101: The dbWatch File Structure

Posted by Rey Lawrence Torrecampo on Jan 28, 2022 9:49:00 AM

Database Monitoring Tools are essential tools for Database Admins. When it comes to tracking the performance and health of their database systems, these tools need to capture your database instance's vital information.  

 

 

There are two things to consider to use database monitoring tools effectively - (1) database access and (2) file structure. The most important step is setting up administration access between your database system and database monitoring tool. Tools like dbWatch utilize your provided administration credentials to create schemas, tables, stored procedures, and functions used in monitoring your database system. Similarly, administrations access is also vital for database reporting.

During database reporting, especially for health checks, accessing the data available in the system is critical in delivering accurate and timely reports. As the database admin, this is also your responsibility to provide only appropriate access to your database.  

Finally, familiarize yourself with database monitoring tools' file structure, especially in Windows 10 server. Knowing where the XML files and JSON files are located makes it easier to fix them. Just make sure you have the necessary administration access to open them. 

In this blog, we'll dissect dbWatch Control Center's file structure. Most of the topics covered in this blog can be found in our online documentation: dbWatch Control Center Architecture and dbWatch File Structure. If you need further information, you can check out the links provided. 

When installing dbWatch to a Windows 10 server, you need to specify two directories to initialize the installation process. As you can see below, two directories are set on the summary page – Program Files and Program Data. 

 

Graphical user interface, text, application

Description automatically generated

 

 

Once installed, you should be able to see the following directories: 

Directory Name 

Directory 

Install Directory 

C:\Program Files\ControlCenter\ 

Library directory 

C:\ProgramData\dbWatchControlCenter\archives\ 

Monitor work directory 

C:\Users\{Users}\.dbwatch\.monitor\ 

Server work directory 

C:\ProgramData\dbWatchControlCenter\ 

 

These four directories will contain the information needed for the dbWatch Control Center. Make sure you have administration access when opening these files. The simplest way of doing it is by logging in to your administration account. Also, always observe to log in with non-personalized administration credentials like username admin with a strong password. That way, only you and any database admins know the administration access. 

We'll go over each directory one-by-one, so we have a better idea of how it interacts with a Windows 10 server.  

In the Install Directory, you should be able to see the following:  

Graphical user interface, application, table, Excel

Description automatically generated

 

You can see the executable files such as monitor.exe and the dbWatch Control Center GUI program. The two most important files here are monitor.conf and server.conf. These files contain the adjusted dependencies and path files of the other dbWatch Control Center files. Usually, you won't alter any of these files since it could malfunction the software.  

Another thing to consider is that the server folder contains the resources for database reporting. When opening this folder and accessing resources, you'll be directed to: 

 

 

dbWatch's database reporting wizard will be using both the appropriate .dtd files and report folder to generate a report. Usually, after generating the database report, it is stored in: 

 

With this information, files for database reporting are much easier to find. 

Next, the Library directory contains the dbWatch Control Center software. This file holds 3rd Party extensions and data on the software. When opening it, you should see the following: 

Table

Description automatically generated

 

Upon installation, the four folders shown above contain the .jar files. Each jar file below is stored in one of the following folders: 

 

 

These files will be essential when upgrading to the latest version of dbWatch Control Center.  

Finally, we have the work directories. We will skip the Monitor work directory for this blog as it mimics some of the Server Work Directory functionalities. Going back to the directory found in your Windows 10 server, the Server Work directory contains the following: 

Table

Description automatically generated

 

Aside from the archives folder, which contains the Library directory, four important folders are shown. Below is the summary of all the files and other subfolders and files:  

 

 Most of the files in these directories contain XML files and JSON files. For example, in the config domain, you can see a mix of both XML files and JSON files:

 

 

For example, the authentication  XML file holds the domain's user name, domain ID, and password algorithm. At the same time, the License XML file holds the information for dbWatch's license. On the other hand, layout.json provides the domain address and the database system's instance ID. Similarly, users.json has the user and role definition. It's good practice to check the files to know how they interact. 

 

Although we have not discussed it in detail, when backing up your dbWatch Control Center in a Windows 10 server, the Server Work directory contains all the needed recovery information when backing up your dbWatch Control Center in a Windows 10 server 

 

--------------------------------------------------------------------- 

 

This is a short section on the overview of dbWatch's file structure. As a Database Admin, getting familiar with dbWatch Control Center will be handy to backup, migrate, and recover your database monitoring tools. As a database admin, having basic knowledge of database monitoring tools is essential to protecting your database systems from mishaps.

Get you free licenses for five instances valid for six months now! dbWatch Control Center free license

If you have any questions about dbWatch Control Center, feel free to contact me: rey@dbwatch.com 

For more information, visit www.dbWatch.com or the dbWatch wiki pages  

#DevOps #DBA #DatabaseManagement #databasemonitoring #sqlserver #oracle #mysql #mariadb #postgresql #sqlmonitor #sqlmanagement #dbmonitor #database monitor #databasefarms #clouddb #Azure 

 

------------

 

About the Author: 

Rey Lawrence Torrecampo is a Pre-sales Engineer for dbWatch and  

a full-time Database Administrator. He has extensive knowledge in Postgres and MSSQL database management systems, with SQL as his most proficient language. 

 

------------ 

 

Other Blogs: 

Monitor your Postgre SQL Database Performance

Activity on Database Platforms - dbWatch Control Center Edition