Skip to content

Explore and visualize MongoDB FTDC diagnostics data in Grafana — understand performance, memory, and connection trends instantly.

License

Notifications You must be signed in to change notification settings

devops-land/mongodb_ftdc_viewer

Repository files navigation

mongodb_ftdc_viewer is a reimagined and performance-focused evolution of zelmario/Big-hole - kudos to zelmario for the original work.

It provides a fast, reliable way to process MongoDB diagnostics data and push it to InfluxDB at high speed. Metrics can then be explored through a Docker-hosted Grafana instance.

Screenshoot

Prerequisites

  • Docker and Docker-compose

Installation

  1. Clone the repository git clone https://github.com/devops-land/mongodb_ftdc_viewer.git
  2. Navigate to the project directory cd mongodb_ftdc_viewer
  3. Make the main script executable: chmod +x run.sh
  4. Build the docker images docker-compose build

Usage

  1. Run the script./run.sh --input-dir <DIAGNOSTICS_DATA_DIRECTORY>

Note: you need to do those steps every time you need to read new diagnostic data files

The script will decode all the diagnostic data files (may takes some time, depending on your computer and how many metric files you want to process) and launch three docker containers:

Screenshoot

Read Other FTDC Data:

To read other FTDC data you need to stop the containers with Ctrl-C, delete the diagnostic.data directory files and copy the new ones.

How to get more metrics

There is a file named metrics_to_get.txt that contains the list of metrics to retrieve. If you want to gather more metrics, simply add the name of the desired metric to this file. You'll find a complete list of all available metrics in another file called metrics.txt. Just add the metric you want to retrieve to metrics_to_get.txt, and the script will collect it.

You can use InfluxDB to view the metrics and construct the queries needed to display them in Grafana.

http://localhost:8086/
user: admin
pass: password

Screenshoot

If you want to edit the dashboard, you can log in to grafana:

http://localhost:3001/
user: admin
pass: admin

Then, you can save it to grafana/dashboard/dashboard.json

Have in mind that after any modification on the metrics_to_get.txt file or the dashboard, you need to rebuild the container with docker-compose build

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

All Contributions are welocme!

About

Explore and visualize MongoDB FTDC diagnostics data in Grafana — understand performance, memory, and connection trends instantly.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published