Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ coverage:
target: 75
flags:
- radarr
RavenDB:
target: 75
flags:
- ravendb
Reboot_Required:
target: 75
flags:
Expand Down Expand Up @@ -594,6 +598,11 @@ flags:
paths:
- radarr/datadog_checks/radarr
- radarr/tests
ravendb:
carryforward: true
paths:
- ravendb/datadog_checks/ravendb
- ravendb/tests
reboot_required:
carryforward: true
paths:
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@
/purefb/ @chrroberts-pure pure-observability@purestorage.com @DataDog/ecosystems-review
/qdrant/ @Anush008 info@qdrant.com
/radarr/ @HadrienPatte
/ravendb/ @TheGoldenPlatypus omer.ratsaby@ravendb.net
/rbltracker/ @DataDog/agent-integrations
/reboot_required/ @montdidier support@krugerheavyindustries.com
/redisenterprise/ @maguec christian@redislabs.com @DataDog/ecosystems-review
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/test-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -994,6 +994,25 @@ jobs:
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
jcaf6931:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@574d63ba88365ffbab915280ceddbaa333c63d6a
with:
job-name: RavenDB
target: ravendb
platform: linux
runner: '["ubuntu-22.04"]'
repo: "${{ inputs.repo }}"
context: ${{ inputs.context }}
python-version: "${{ inputs.python-version }}"
latest: ${{ inputs.latest }}
agent-image: "${{ inputs.agent-image }}"
agent-image-py2: "${{ inputs.agent-image-py2 }}"
agent-image-windows: "${{ inputs.agent-image-windows }}"
agent-image-windows-py2: "${{ inputs.agent-image-windows-py2 }}"
test-py2: ${{ inputs.test-py2 }}
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
j473bdb7:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@574d63ba88365ffbab915280ceddbaa333c63d6a
with:
Expand Down
6 changes: 6 additions & 0 deletions ravendb/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# CHANGELOG - RavenDB

## 1.0.0 / 2026-04-06

***Added: ***
* Initial Release
21 changes: 21 additions & 0 deletions ravendb/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 RavenDB

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
143 changes: 143 additions & 0 deletions ravendb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@

Check failure on line 1 in ravendb/README.md

View workflow job for this annotation

GitHub Actions / run / Validate

All images must be checked into the repo under the `ravendb/images` folder. This image path must be in the form: https://raw.githubusercontent.com/DataDog/integrations-extras/master/ravendb/images/<IMAGE_NAME> Image currently is: images/ravendb_overview.png
# Agent Check: RavenDB

![RavenDB Dashboard](images/ravendb_overview.png)

## Overview

[RavenDB][1] is a NoSQL document-oriented database designed for high performance, scalability, and ease of use. It is optimized for handling JSON-based documents and supports advanced features like ACID transactions, full-text search, and automatic indexing.
RavenDB is widely used for applications that require high-speed transactions, real-time analytics, and distributed architecture while maintaining data integrity. It is particularly suited for enterprise applications, e-commerce, and real-time monitoring systems.

This integration collects metrics from RavenDB via its Prometheus/OpenMetrics endpoint, enabling visibility into cluster health, node activity, database operations, indexing performance, and resource utilization. These metrics can be used for monitoring, visualization, and alerting within Datadog.

## Setup

### Prerequisites

- [A running RavenDB server (single node or cluster)](https://docs.ravendb.net/start/getting-started)
- [A valid RavenDB license](https://ravendb.net/buy)
- The Datadog Agent installed on each node you want to monitor
- Network access from the Datadog Agent to the RavenDB metrics endpoint


### Installation

To install the RavenDB check on your host:

1. Install the [developer toolkit]
(https://docs.datadoghq.com/developers/integrations/python/)
on any machine.

2. Run `ddev release build ravendb` to build the package.

3. [Download the Datadog Agent][2].

4. Upload the build artifact to any host with an Agent and
run `datadog-agent integration install -w
path/to/ravendb/dist/<ARTIFACT_NAME>.whl`.

### Configuration

#### Metric collection

1. RavenDB is exposing metrics in [Prometheus/OpenMetrics](https://docs.ravendb.net/server/administration/monitoring/prometheus/) format at an administrative endpoint: `/admin/monitoring/v1/prometheus`.

2. Edit the `ravendb/conf.yaml` file in the `conf.d/` directory of the Datadog Agent. See the [sample ravendb/conf.yaml][4] for all available configuration options.
Minimal configuration example:
```yaml
init_config:
instances:
- openmetrics_endpoint: "http://localhost:8080/admin/monitoring/v1/prometheus"
```

3. (Optional) Enable additional metric groups:

Due to their potentially high cardinality, database-, index-, and collection-level metrics are disabled by default. Enabling these metrics may significantly increase the number of time series, especially in environments with many databases, indexes, or collections.
```yaml
instances:
- openmetrics_endpoint: "<RAVENDB_METRICS_URL>"
enable_database_metrics: true
enable_index_metrics: true
enable_collection_metrics: true
enable_gc_metrics: true
```

#### Secured endpoints (TLS)

If the RavenDB metrics endpoint is exposed over HTTPS and requires client authentication, configure TLS options:
```yaml
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:
```yaml
instances:
- openmetrics_endpoint: "<RAVENDB_METRICS_URL>"
tags:
- ravendb_cluster:my-ravendb-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:
```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.


### Validation

Run the Agent's status subcommand and look for 'ravendb' under the Checks section.


## Data Collected

### Metrics

See [metadata.csv][7] for a list of metrics provided by this integration.

### Events

The RavenDB integration does not include any events.

## Troubleshooting

Need help? Contact the support@ravendb.net of this integration.

[1]: https://ravendb.net
[2]: https://app.datadoghq.com/account/settings/agent/latest
[3]: https://docs.datadoghq.com/containers/kubernetes/integrations/
[4]: https://github.com/DataDog/integrations-extras/blob/master/ravendb/datadog_checks/ravendb/data/conf.yaml.example
[5]: https://docs.datadoghq.com/agent/configuration/agent-commands/#start-stop-and-restart-the-agent
[6]: https://docs.datadoghq.com/agent/configuration/agent-commands/#agent-status-and-information
[7]: https://github.com/DataDog/integrations-extras/blob/master/ravendb/metadata.csv
[9]: https://docs.datadoghq.com/help/

56 changes: 56 additions & 0 deletions ravendb/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: RavenDB
files:
- name: ravendb.yaml
options:
- template: init_config
options:
- template: init_config/default
- template: instances
options:
- name: openmetrics_endpoint
description: URL to the RavenDB Prometheus/OpenMetrics endpoint.
required: true
value:
type: string
example: http://127.0.0.1:8080/admin/monitoring/v1/prometheus
- name: enable_database_metrics
description: Enable collection of database-level metrics (tagged by database_name).
value:
type: boolean
example: false
default: false
- name: enable_index_metrics
description: Enable collection of index-level metrics (tagged by database_name and index_name).
value:
type: boolean
example: false
default: false
- name: enable_collection_metrics
description: Enable collection of collection-level metrics (tagged by database_name and collection_name).
value:
type: boolean
example: false
default: false
- name: enable_gc_metrics
description: Enable collection of GC (Garbage Collection) metrics exposed by RavenDB.
value:
type: boolean
example: false
default: false
- name: exclude_metrics
description: >
A list of metric names to exclude. Matches against the Datadog metric name (without the ravendb. prefix).
value:
type: array
items:
type: string
example:
- "documents.count"
- "indexes.errors.count"
- template: instances/default
- template: logs
example:
- type: file
path: /var/log/ravendb/logs/*.log
source: ravendb
service: ravendb
Loading
Loading