RavenDB Metrics

Ship your RavenDB Metrics via Telegraf to your Logit.io Stack

Configure Telegraf to ship RavenDB metrics to your Logit.io stacks via Logstash.

Install Integration

Please click on the Install Integration button to configure your stack for this source.

Install Telegraf

This integration allows you to configure a Telegraf agent to send your metrics, in multiple formats, to Logit.io.

Choose the installation method for your operating system:

When you paste the command below into Powershell it will download the Telegraf zip file. Once that is complete, press Enter again and the zip file will be extracted into C:\Program Files\InfluxData\telegraf\telegraf-1.31.2.

wget https://dl.influxdata.com/telegraf/releases/telegraf-1.31.2_windows_amd64.zip -UseBasicParsing -OutFile telegraf-1.31.2_windows_amd64.zip 
Expand-Archive .\telegraf-1.31.2_windows_amd64.zip -DestinationPath 'C:\Program Files\InfluxData\telegraf'

Configure the Telegraf input plugin

The configuration file below is pre-configured to scrape the system metrics from your hosts, add the following code to the configuration file /etc/telegraf/telegraf.conf from the previous step.

# Reads metrics from RavenDB servers via the Monitoring Endpoints
[[inputs.ravendb]]
  ## Node URL and port that RavenDB is listening on. By default,
  ## attempts to connect securely over HTTPS, however, if the user
  ## is running a local unsecure development cluster users can use
  ## HTTP via a URL like "http://localhost:8080"
  url = "https://localhost:4433"
 
  ## RavenDB X509 client certificate setup
  # tls_cert = "/etc/telegraf/raven.crt"
  # tls_key = "/etc/telegraf/raven.key"
 
  ## Optional request timeout
  ##
  ## Timeout, specifies the amount of time to wait
  ## for a server's response headers after fully writing the request and
  ## time limit for requests made by this client
  # timeout = "5s"
 
  ## List of statistics which are collected
  # At least one is required
  # Allowed values: server, databases, indexes, collections
  #
  # stats_include = ["server", "databases", "indexes", "collections"]
 
  ## List of db where database stats are collected
  ## If empty, all db are concerned
  # db_stats_dbs = []
 
  ## List of db where index status are collected
  ## If empty, all indexes from all db are concerned
  # index_stats_dbs = []
 
  ## List of db where collection status are collected
  ## If empty, all collections from all db are concerned
  # collection_stats_dbs = []

Read more about how to configure data scraping and configuration options for RavenDB (opens in a new tab)

Configure the output plugin

Once you have generated the configuration file, you need to set up the output plug-in to allow Telegraf to transmit your data to Logit.io in Prometheus format. This can be accomplished by incorporating the following code into your configuration file:

[[outputs.http]]
  url = "https://@metricsUsername:@metricsPassword@@metrics_id-vm.logit.io:@vmAgentPort/api/v1/write"
  data_format = "prometheusremotewrite"
 
  [outputs.http.headers]
    Content-Type = "application/x-protobuf"
    Content-Encoding = "snappy"

Start Telegraf

From the location where Telegraf was installed (C:\Program Files\InfluxData\telegraf\telegraf-1.31.2) run the program providing the chosen configuration file as a parameter:

.\telegraf.exe --config telegraf-demo.conf

Once Telegraf is running you should see output similar to the following, which confirms the inputs, output and basic configuration the application has been started with: Powershell Telegraf information

View your metrics

Data should now have been sent to your Stack.

View My Data

If you don't see take a look at How to diagnose no data in Stack below for how to diagnose common issues.

How to diagnose no data in Stack

If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.

Telegraf RavenDB metrics Overview

To effectively monitor and analyze RavenDB metrics in a distributed environment, it's essential to have a reliable and efficient metrics management solution. Telegraf, an open-source metrics collection agent, is ideally suited for gathering RavenDB metrics from diverse sources, including operational RavenDB instances, databases, and other related applications.

Telegraf offers a wide range of input plugins, allowing users to gather metrics from different sources such as CPU usage, memory usage, network activity, and more. To store and query these collected metrics, organizations can make use of Prometheus, an open-source monitoring and alerting system that supports a flexible querying language and graphical visualization of data.

To ship RavenDB metrics from Telegraf to Prometheus, organizations need to configure Telegraf to output metrics in the Prometheus format, and then use Prometheus to scrape these metrics from the Telegraf server. This process involves setting up Telegraf to collect metrics from RavenDB and output them in the Prometheus format, configuring Prometheus to retrieve the metrics from the Telegraf server, and then visualizing and analyzing the data using Prometheus's flexible querying and graphical visualization capabilities.

Once the metrics have been imported into Prometheus, further analysis and visualization can be carried out using Grafana. Grafana is an open-source platform for monitoring and observability that is perfectly compatible with Prometheus. It allows users to create dynamic and interactive dashboards that provide a more detailed look into the metrics data.

If you need any further assistance with shipping your log data to Logit.io we're here to help you get started. Feel free to get in contact with our support team by sending us a message via live chat & we'll be happy to assist.