DOCSEARCHbyAlgolia
Submit Docs

DBmarlin Documentation

website·Indexed 33 days ago

https://docs.dbmarlin.com/

A next-generation database monitoring solution designed to help databases run fast and stay fast. The documentation covers architecture, installation on Linux, Windows, and Kubernetes, high availability setup, and access control including RBAC and SSO integration with Microsoft Entra, Google, and Okta.

Tokens
75.5K
Snippets
161
Records
695
Agent score
63%

What's inside DBmarlin

  1. Overview of DBmarlin database monitoring

    DBmarlin is a next-generation database monitoring solution designed to optimize database performance and maintain speed. It supports both traditional database platforms and modern cloud-native databases operating in public or private clouds.

  2. Overview of DBmarlin Knowledge-base

    The DBmarlin Knowledge-base is a free collection of curated knowledge focused on database performance across multiple database types. It specifically emphasizes two core concepts for database performance tuning and optimization: Wait Events (which identify where time is spent in the database) and Execution Plans (which detail the steps the database optimizer takes to execute a SQL statement).

  3. Overview of DBmarlin Authentication

    DBmarlin (version 4.5.0 and above) uses an .htpasswd file for basic authentication, which is handled by the Nginx frontend web server. Authentication is disabled by default in clean installations. To enable it, create the first user using the provided CLI scripts, which automatically generates the auth.conf file in [dbmarlin]/nginx/conf/.

  4. Understand the purpose of SQL Statistics

    SQL Statistics are performance metrics used to analyze and optimize SQL queries and database systems. They provide insights into how a database engine processes SQL statements, allowing developers and administrators to identify performance bottlenecks. Common metrics across different database engines typically include CPU time and the total number of reads and writes performed by a specific SQL statement.

  5. DBmarlin Architecture Overview

    DBmarlin consists of a central server and optional remote agents. The server can be installed on 64-bit Linux or Windows. It bundles several core components: an Agent for data collection, a UI Server for the web interface, an Archiver for data management, and a Repository for storage.

  6. Understand DBmarlin licensing and Sensor requirements

    DBmarlin is licensed by the number of Database Sensors defined in the Instance Settings. Each Database Instance requires one Sensor (defined by a host:port connection string) and consumes one license.

    Key licensing rules:

    • The number of databases within a single instance does not affect the license count.
    • Host Sensors (for Linux and Windows) do not require a license.
    • License counts and expiration dates are visible on the license screen.

  8. Understand database execution plans

    An execution plan is the sequence of operations chosen by the database optimizer to run a specific SQL statement. It details the steps performed to retrieve data, including row scanning methods (table or index scans), join methods used to combine tables, and any required sorting operations.

  9. Architectural requirements for DBmarlin High Availability

    To implement High Availability (HA) for DBmarlin, a total of 4 machines are recommended: 2 machines dedicated to the DBmarlin PostgreSQL cluster and 2 machines dedicated to the DBmarlin application server. The application server is stateless provided a remote PostgreSQL instance is used.

  10. Relate database performance to Liquibase changesets

    Once the integration is configured, Liquibase sends schema change details to the DBmarlin API every time a changeset is applied. These events appear in the DBmarlin Event History screen and on the Events tab for the instance. Users can analyze the impact of changes by viewing annotations on performance charts and using DBmarlin Comparison Reports to analyze the period before and after the change.

  11. Understand DBmarlin Role-based Access Control (RBAC) basics

    Role-based Access Control (RBAC) in DBmarlin (version 4.8.0 or above) manages user access levels. There are two primary user types:

    • Admin users: Have full access to all databases and can perform all operations, including user administration.
    • Regular non-admin users: Have no database access by default. They must be granted access by an Admin and cannot perform user administration tasks, though they can view the user list.

    RBAC requires that Authentication is enabled.

  12. Understand the Oracle UPDATE statement in execution plans

    In the context of Oracle database execution plans, the UPDATE statement is a Data Manipulation Language (DML) operation used to modify existing data within the database. It is one of the four primary DML statements, alongside SELECT, INSERT, and DELETE.