https://github.com/simagix/mongo-ftdc

Display MongoDB FTDC Metrics Using Grafana
https://github.com/simagix/mongo-ftdc

docker docker-compose ftdc grafana mongodb

Last synced: 2 months ago
JSON representation

Display MongoDB FTDC Metrics Using Grafana

• Host: GitHub
• URL: https://github.com/simagix/mongo-ftdc
• Owner: simagix
• License: apache-2.0
• Created: 2019-07-24T20:22:42.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-13T03:49:45.000Z (8 months ago)
• Last Synced: 2024-06-20T19:26:19.850Z (7 months ago)
• Topics: docker, docker-compose, ftdc, grafana, mongodb
• Language: Go
• Size: 139 KB
• Stars: 30
• Watchers: 5
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MongoDB FTDC Metrics and Charts

A dockerized tool to view MongoDB FTDC metrics.

## Build

Use `build.sh` to build *simagix/ftdc* and *simagix/grafana-ftdc* Docker images.

```bash

./build.sh docker

```

## Startup

Create a `diagnostic.data` directory if it doesn't exist yet:

```bash

mkdir -p ./diagnostic.data/

```

Copy FTDC files to under directory *diagnostic.data*:

```bash

cp $SOMEWHERE/metrics.* ./diagnostic.data/

```

Bring up FTDC viewer:

```bash

docker-compose up -d

```

## View FTDC Metrics

- View results URL `http://localhost:3030/` using a browser.

- Choose **MongoDB FTDC Analytics** from dashboard.

- Change correct *From* and *To* date/time in the *Custom Range* panel.

## Read Other FTDC Data

To read different FTDC files without restarting all Docker containers, remove all files from directory *diagnostic.data* and copy FTDC files to under the same directory.  Execute the command below to force FTDC data reload:

```bash

curl -XPOST http://localhost:5408/grafana/dir -d '{"dir": "/diagnostic.data"}'

```

A JSON document is returned with information of the new endpoint, begin and end timestamps:

> {"endpoint":"/d/simagix-grafana/mongodb-mongo-ftdc?orgId=1\u0026from=1550767345000\u0026to=1550804249000","ok":1}

Alternatively, you can simply run the command `docker-compose down` to bring down the entire cluster, edit the *docker-compose.yaml* file to point the *diagnostic.data* directory to a new location, and run `docker-compose up` to bring up the cluster again.

## Shutdown

```bash

docker-compose down

```

## Disclaimer

This software is not supported by MongoDB, Inc. under any of their commercial support subscriptions or otherwise. Any usage is at your own risk. Bug reports, feature requests and questions can be posted in the Issues section on GitHub.