Previous

Next

RavenDB Dashboard - Cluster Health, Logs and Network

RavenDB Dashboard - Databases and Indexes

RavenDB Dashboard - Resources and Performance

Overview

RavenDB is a high-performance NoSQL document database designed for modern applications that require scalability, reliability, and low-latency data access. It provides ACID transactions, automatic indexing, full-text search, distributed clustering, and built-in high availability.

The RavenDB integration collects metrics directly from RavenDB’s Prometheus/OpenMetrics endpoint, giving operators comprehensive visibility into the health and performance of their deployments.

Monitor your RavenDB deployment

Monitor key operational metrics including:

• Cluster health and node status
• CPU, memory, disk, and network utilization
• Database activity and request throughput
• Indexing performance and errors
• Storage utilization and I/O
• Licensing and certificate status

Built-in dashboards

The integration includes pre-built dashboards that provide an operational overview of your RavenDB environment. Visualize resource utilization, database performance, indexing activity, storage, networking, and cluster health from a single place, helping identify bottlenecks and troubleshoot issues faster.

Optional log collection

Collect RavenDB logs alongside metrics to correlate operational events with infrastructure performance. This unified view simplifies troubleshooting and accelerates root cause analysis.

Secure and production ready

The integration supports both unsecured and TLS-secured RavenDB deployments, including client certificate authentication. It is designed for single-node servers as well as distributed RavenDB clusters, making it suitable for development, staging, and production environments.

Setup

Metric collection

• RavenDB exposes metrics in Prometheus/OpenMetrics format at an administrative endpoint: /admin/monitoring/v1/prometheus.

• Edit the ravendb/conf.yaml file in the conf.d/ directory of the Datadog Agent. Minimal configuration example:

   init_config:
   instances:
     - openmetrics_endpoint: "http://localhost:8080/admin/monitoring/v1/prometheus"

• Edit the ravendb/conf.yaml file in the conf.d/ directory of the Datadog Agent. See the sample ravendb/conf.yaml for all available configuration options.

  Minimal configuration example:

   init_config:
   instances:
     - openmetrics_endpoint: "http://localhost:8080/admin/monitoring/v1/prometheus"

Secured endpoints (TLS)

If the RavenDB metrics endpoint is exposed over HTTPS and requires client authentication, configure TLS options:

instances:
  - openmetrics_endpoint: "https://<host>/admin/monitoring/v1/prometheus"
    tls_cert: /path/to/client.crt
    tls_private_key: /path/to/client.key

Ensure the Datadog Agent user has read access to the certificate and key files.

Cluster deployments

For RavenDB clusters:

• Install and configure the Datadog Agent on each node
• Configure each Agent instance to scrape the local node’s metrics endpoint
• Use tags to correlate metrics across nodes and clusters

Example:

instances:
  - openmetrics_endpoint: "<RAVENDB_METRICS_URL>"
    tags:
      - ravendb_cluster:dev-cluster
      - ravendb_node:A

Log collection (optional)

To collect RavenDB logs, enable log collection in datadog.yaml:

`logs_enabled: true`

Then add a log configuration to ravendb.d/conf.yaml:

logs:
  - type: file
    path: /var/log/ravendb/*.log
    service: ravendb
    source: ravendb

    log_processing_rules:
      - type: multi_line
        name: ravendb_multiline
        pattern: '^\d{4}-\d{2}-\d{2}'

Ensure the Datadog Agent user has read permissions on the log files.

Data Collected

Metrics

Uninstallation

To uninstall the RavenDB integration, run:

datadog-agent integration remove ravendb

If you manually installed the integration package, remove the corresponding Python wheel from the Agent environment.

Optionally:

• Remove ravendb.d/conf.yaml
• Disable log collection for RavenDB
• Restart the Datadog Agent

Support

Need help? Contact RavenDB’s support team at support@ravendb.net.

Further Reading

Additional helpful documentation, links, and articles:

Guides, API Reference & Tutorials | RavenDB DocumentationDOCUMENTATION