Binlog Browser
Binlog Browser is a GUI tool that allows you to view and analyze your database’s binary logs. It helps you identify which queries were executed, when they ran, and which tables were affected.
What is a Binary Log?
The Binary Log (Binlog) in MariaDB records all changes made to the database. It stores SQL statements that modify data, such as INSERT, UPDATE, and DELETE, along with DDL statements that modify the structure of database tables.
What is the Binlog Browser?
Binlog Browser provides a simple interface to explore database binary logs. You can use it to check:
- Which query was executed.
- When the query was executed.
- Which database table was affected.
Where to Find Binlog Browser?
You can access Binlog Browser from the sidebar:
Devtools → Binlog Browser
Note
If you do not see the Binlog Browser option, make sure you have completed your Frappe Cloud onboarding. If the option is still unavailable, contact Frappe Cloud support.
Who Can Access It?
Currently, Binlog Browser is available only for dedicated database servers with at least 8GB RAM.
Once the feature becomes more stable, support will also be extended to servers with 4GB RAM.
Why Do We Need the Binlog Browser?
Binary logs are stored in a binary format, which makes them difficult and resource-intensive to analyze manually.
Binlog Browser helps with debugging and database investigation tasks, such as:
- Finding the query responsible when data appears incorrect or missing.
- Identifying queries causing sudden growth in binlog file size or heavy database writes.
- Verifying database activity during point-in-time restoration or checking that no writes occurred after a backup.
How Does It Work?
Binlog Browser works with another tool called the Binlog Indexer.
The Binlog Indexer converts binary logs into searchable metadata, allowing Binlog Browser to quickly display and analyze database changes.
Note
If the Binlog Indexer is not enabled, Binlog Browser will not be available for viewing indexed logs.
How to Enable Binlog Indexer / Browser?
You can enable the Binlog Indexer by following the Frappe Cloud documentation for database server actions.
Automated Binlog Indexing
By default, Frappe Cloud runs an automated job every hour that indexes four binlog files.
During the indexing process, Binlog Browser remains unavailable until the job is completed.
Note
You need to wait until the indexing process finishes before accessing Binlog Browser again.
Binlog Indexing Status
If your binlogs are not indexed yet, Binlog Browser will not display any results.
To check the indexing status:
- Click the Binlogs icon available in the top-right corner.
- View the list of binlogs along with their size and indexing status.
On-demand Binlog Indexing
If you need to index multiple binlogs immediately, you can manually select the required binlogs and submit an indexing request.
After submitting the request, you will be redirected to a page where you can monitor the job status.
Once indexing is completed, you can return to Binlog Browser and access the newly indexed binlogs.
