-
Notifications
You must be signed in to change notification settings - Fork 846
add RavenDB integration #2960
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
TheGoldenPlatypus
wants to merge
1
commit into
DataDog:master
Choose a base branch
from
TheGoldenPlatypus:add-ravendb-integration
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
add RavenDB integration #2960
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| # Agent Check: RavenDB | ||
|
|
||
|  | ||
|
|
||
| ## 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 such as 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)][2] | ||
| - [A valid RavenDB license][3] | ||
| - 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][4] on any machine. | ||
|
|
||
| 2. Run `ddev release build ravendb` to build the package. | ||
|
|
||
| 3. [Download the Datadog Agent][5]. | ||
|
|
||
| 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 exposes metrics in [Prometheus/OpenMetrics][6] 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. For all available configuration options, see the [sample ravendb/conf.yaml][7]. | ||
|
|
||
| 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`: | ||
|
|
||
| ```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][8] and look for `ravendb` under the Checks section. | ||
|
|
||
| ## Data collected | ||
|
|
||
| ### Metrics | ||
|
|
||
| See [metadata.csv][9] for a list of metrics provided by this integration. | ||
|
|
||
| ### Events | ||
|
|
||
| The RavenDB integration does not include any events. | ||
|
|
||
| ### Logs | ||
|
|
||
| The RavenDB integration collects RavenDB server logs, which cover server and cluster activity, database and index operations, and warning and error messages. Multi-line stack traces are combined into a single log entry. Log collection is disabled by default in the Datadog Agent; see [Log collection](#log-collection-optional) to enable it. | ||
|
|
||
| ### Service checks | ||
|
|
||
| See [service_checks.json][10] for a list of service checks provided by this integration. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| Need help? Contact [RavenDB's support team][11]. | ||
|
|
||
| [1]: https://ravendb.net | ||
| [2]: https://docs.ravendb.net/start/getting-started | ||
| [3]: https://ravendb.net/buy | ||
| [4]: https://docs.datadoghq.com/developers/integrations/python/ | ||
| [5]: https://app.datadoghq.com/account/settings/agent/latest | ||
| [6]: https://docs.ravendb.net/server/administration/monitoring/prometheus/ | ||
| [7]: https://github.com/DataDog/integrations-extras/blob/master/ravendb/datadog_checks/ravendb/data/conf.yaml.example | ||
| [8]: https://docs.datadoghq.com/agent/configuration/agent-commands/#agent-status-and-information | ||
| [9]: https://github.com/DataDog/integrations-extras/blob/master/ravendb/metadata.csv | ||
| [10]: https://github.com/DataDog/integrations-extras/blob/master/ravendb/assets/service_checks.json | ||
| [11]: mailto:support@ravendb.net | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done