Getting Started with DBForge

Installation

DBForge can be installed as a managed service or self-hosted. Choose the option that best fits your needs.

Docker Installation

$ docker run -d \
-e DB_HOST=localhost \
-e DB_PORT=5432 \
-p 8080:8080 \
dbforge:latest

This will start a DBForge instance connected to your database.

Quick Setup

  1. 1. Sign up for a DBForge account at dbforge.io
  2. 2. Install the agent on your database server
  3. 3. Create your first dashboard
  4. 4. Configure alerts and notifications

API Documentation

Authentication

All API requests require an API key passed in the Authorization header.

Authorization: Bearer YOUR_API_KEY
Retrieve your API key from the DBForge dashboard under Settings > API Keys.

Get Metrics

Retrieve real-time and historical metrics from your database.

GET /api/v1/metrics/query-latency
Response:
{
"metric": "query_latency",
"value": 2.3,
"unit": "ms",
"timestamp": 1695124800
}

Create Alert

Create performance and health alerts for your databases.

POST /api/v1/alerts
Request Body:
{
"name": "High Query Latency",
"metric": "query_latency",
"threshold": 5.0,
"duration": 300
}

Guides & Best Practices

Setting Up Monitoring

Enable comprehensive monitoring by installing the DBForge agent on your database servers. The agent collects metrics with minimal overhead.

Performance Tuning

Use Query Analytics to identify slow queries and get optimization recommendations from DBForge's AI engine.

Backup and Restore

Configure automated backups with flexible retention policies. Perform point-in-time recovery when needed.

Troubleshooting

Common Issues

Agent Not Connecting

Check that the agent process is running and has network connectivity to your database.

High Agent CPU Usage

Reduce sampling frequency or filter out unnecessary metrics in agent configuration.

Frequently Asked Questions

What databases are supported?

DBForge supports PostgreSQL, MySQL/MariaDB, MongoDB, and Redis.

How long is data retained?

Metrics are retained for up to 2 years on our managed service with configurable policies.