Skip to content

add RavenDB integration - #2960

Open
TheGoldenPlatypus wants to merge 9 commits into
DataDog:masterfrom
TheGoldenPlatypus:add-ravendb-integration
Open

add RavenDB integration#2960
TheGoldenPlatypus wants to merge 9 commits into
DataDog:masterfrom
TheGoldenPlatypus:add-ravendb-integration

Conversation

@TheGoldenPlatypus

Copy link
Copy Markdown

What does this PR do?

Adds a new integration for RavenDB using the OpenMetrics endpoint.
The integration collects server, cluster, database, index, and GC metrics from RavenDB and exposes them to Datadog. It also includes configurable filtering to control metric cardinality and a sample dashboard for visualization.

Motivation

RavenDB exposes Prometheus/OpenMetrics metrics, but there is currently no official Datadog integration.
This integration allows users to monitor RavenDB instances directly through Datadog without needing custom metric pipelines, while also providing controls to avoid high-cardinality metric ingestion.

Review checklist

  • PR has a meaningful title or PR has the no-changelog label attached
  • Feature or bugfix has tests
  • Git history is clean
  • If PR impacts documentation, docs team has been notified or an issue has been opened on the documentation repo
  • If this PR includes a log pipeline, please add a description describing the remappers and processors.

Additional Notes

--

@TheGoldenPlatypus
TheGoldenPlatypus requested review from a team as code owners April 6, 2026 09:19
@TheGoldenPlatypus
TheGoldenPlatypus requested a review from a team as a code owner April 6, 2026 14:18
@estherk15 estherk15 added the editorial review Waiting on a more in-depth review from a docs team editor label Apr 6, 2026
@TheGoldenPlatypus

TheGoldenPlatypus commented Apr 9, 2026

Copy link
Copy Markdown
Author

the manifest validation is failing because source_type_id is required and must be unique
I don't have it, assumed the scaffolding should take care of assigning one.
Could you reviewers assign the correct source_type_id ?

{'assets': {'integration': {'source_type_id': ['Missing data for required field.']}}}

@TheGoldenPlatypus TheGoldenPlatypus changed the title add ravendb integration add RavenDB integration Apr 14, 2026
@github-actions

github-actions Bot commented May 5, 2026

Copy link
Copy Markdown

This pull request has not been updated for more than 21 days. If there are no updates to this PR within 7 days, it will be closed. If you'd like to re-open this PR after it's been closed, you can start from the latest master branch or pull the latest changes into your branch and create a new pull request.

@github-actions github-actions Bot added the stale label May 5, 2026
@TheGoldenPlatypus

Copy link
Copy Markdown
Author

hey, following up on this PR as it's close to becoming stale. Any update or feedback from the team?

@github-actions github-actions Bot removed the stale label May 7, 2026
@github-actions

Copy link
Copy Markdown

This pull request has not been updated for more than 21 days. If there are no updates to this PR within 7 days, it will be closed. If you'd like to re-open this PR after it's been closed, you can start from the latest master branch or pull the latest changes into your branch and create a new pull request.

@github-actions github-actions Bot added the stale label May 28, 2026
@TheGoldenPlatypus

Copy link
Copy Markdown
Author

hey, following up on this PR as it's close to becoming stale. Any update or feedback from the team?

@github-actions github-actions Bot removed the stale label Jun 2, 2026
@github-actions

Copy link
Copy Markdown

This pull request has not been updated for more than 21 days. If there are no updates to this PR within 7 days, it will be closed. If you'd like to re-open this PR after it's been closed, you can start from the latest master branch or pull the latest changes into your branch and create a new pull request.

@github-actions github-actions Bot added the stale label Jun 24, 2026
@TheGoldenPlatypus

Copy link
Copy Markdown
Author

hey, following up on this PR as it's close to becoming stale. Any update or feedback from the team?

@github-actions github-actions Bot removed the stale label Jun 25, 2026
@github-actions

Copy link
Copy Markdown

This pull request has not been updated for more than 21 days. If there are no updates to this PR within 7 days, it will be closed. If you'd like to re-open this PR after it's been closed, you can start from the latest master branch or pull the latest changes into your branch and create a new pull request.

@github-actions github-actions Bot added the stale label Jul 17, 2026
@TheGoldenPlatypus

Copy link
Copy Markdown
Author

hey, following up on this PR as it's close to becoming stale. Any update or feedback from the team?

@github-actions github-actions Bot removed the stale label Jul 19, 2026

@estherk15 estherk15 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you take another look at the link references? There were a few orphaned links and some inline reference links that don't match formatting.

Comment thread ravendb/README.md
Comment on lines +27 to +28
1. Install the [developer toolkit]
(https://docs.datadoghq.com/developers/integrations/python/)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you format this as a reference link at the bottom of the file?

Suggested change
1. Install the [developer toolkit]
(https://docs.datadoghq.com/developers/integrations/python/)
1. Install the [developer toolkit](https://docs.datadoghq.com/developers/integrations/python/)

Comment thread ravendb/README.md
Run the Agent's status subcommand and look for 'ravendb' under the Checks section.


## Data Collected

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing a Logs subsection describing what log types are collected, and a Service checks subsection linking to service_checks.json.

Comment thread ravendb/README.md

## Troubleshooting

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Need help? Contact the support@ravendb.net of this integration.
Need help? Contact [RavenDB's support team][10].

Comment thread ravendb/README.md

### Validation

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

@estherk15 estherk15 Jul 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run the Agent's status subcommand and look for 'ravendb' under the Checks section.
Run the [Agent's status subcommand][6] and look for `ravendb` under the Checks section.

Comment thread ravendb/README.md
Comment on lines +17 to +18
- [A running RavenDB server (single node or cluster)](https://docs.ravendb.net/start/getting-started)
- [A valid RavenDB license](https://ravendb.net/buy)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move these links to the bottom of the page and use reference link format?

Comment thread ravendb/README.md
[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/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[10]: mailto:support@ravendb.net

Comment thread ravendb/README.md

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

logs_enabled: true

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
logs_enabled: true
```yaml
logs_enabled: true
```

Comment thread ravendb/README.md

## 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[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][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 such as ACID transactions, full-text search, and automatic indexing.

Comment thread ravendb/README.md

#### 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`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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`.
1. RavenDB exposes metrics in [Prometheus/OpenMetrics](https://docs.ravendb.net/server/administration/monitoring/prometheus/) format at an administrative endpoint: `/admin/monitoring/v1/prometheus`.

Comment thread ravendb/README.md

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
2. Edit the `ravendb/conf.yaml` file in the `conf.d/` directory of the Datadog Agent. For all available configuration option, see the [sample ravendb/conf.yaml][4].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorial review Waiting on a more in-depth review from a docs team editor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants