https://github.com/mongodb/ftdc
utils for working with mongodb full-time diagnostic data capture files
https://github.com/mongodb/ftdc
Last synced: about 1 month ago
JSON representation
utils for working with mongodb full-time diagnostic data capture files
- Host: GitHub
- URL: https://github.com/mongodb/ftdc
- Owner: mongodb
- License: apache-2.0
- Created: 2018-08-28T20:22:12.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T16:06:31.000Z (3 months ago)
- Last Synced: 2025-04-02T12:34:05.988Z (about 1 month ago)
- Language: Go
- Size: 5.17 MB
- Stars: 25
- Watchers: 6
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
======================================================
``ftdc`` -- Golang FTDC Parsing and Generating Library
======================================================
Overview
--------
FTDC, originally short for *full time diagnostic data capture*, is
MongoDB's internal diagnostic data collection facility. It encodes
data in a space-efficient format, which allows MongoDB to record
diagnostic information every second, and store weeks of data with only
a few hundred megabytes of storage.
This library provides a fully-featured and easy to use toolkit for
interacting data stored in this format in Go programs. The library
itself originated as a `project by 2016 Summer interns at MongoDB
`_ but has diverged substantially
since then.
Features
--------
Current
~~~~~~~
Currently the library provides parsing of the FTDC data format and
several ways of iterating these results. Additionally, it provides the
ability to create FTDC payloads, and is the only extant (?) tool for
generating FTDC data outside of the MongoDB code base.
The library includes tools for generating FTDC payloads and document
streams as well as iterators and tools for accessing data from FTDC
files. All functionality is part of the ``ftdc`` package, and the API
is fully documented.
Upcoming
~~~~~~~~
- (pending requests and use-cases) mode to read FTDC data without
flattening the document structure.
- command line tools for parsing and generating FTDC payloads.
- helpers for generating default collector configurations.
- combined check
- improved collector performance.
... and more
Documentation
-------------
All documentation is in the `godoc `_.
Participate
-----------
File tickets in the `MAKE `_
project on the MongoDB jira. The repository will shortly move back to
an offical MongoDB GitHub organization.
Pull requests are welcome.