Name: mongodbtools
Owner: Honeycomb
Description: A set of utilities for working with MongoDB logs. Imported directly by the Honeycomb agent, honeytail
Created: 2016-09-02 01:42:40.0
Updated: 2017-12-04 14:55:28.0
Pushed: 2017-08-16 06:38:24.0
Size: 41
Language: Go
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Tools for sending MongoDB logs to Honeycomb.
Two packages. One for ingesting mongodb logs (logparser) and the other for query normalization (queryshape).
See our docs for more about Honeycomb, and our MongoDB-specific docs.
scripts/mongo_stats.sh is a shell script that collects some statistics from the server and the mongo instance and submits them to Honeycomb. It is a template for you use in creating your own stats scripts - it might work for you as is but likely needs modification to fit your environment. It has been tested against MongoDB 3.2.
Though it is technically a shell script, the majority of the logic in the script is javascript interpreted by the mongo client. The javascript functions parse server information and collect information about locks and other server statistics, then return it as a JSON object. That JSON object is the payload that is sent to Honeycomb.
It is intended to be run from cron every minute - internally it runs 4 times, submitting statistics every 15 seconds.
The logparser package is spiritually derived from Travis Cline's PEG parser over at https://github.com/tmc/mongologtools. While the parser code itself is obviously different (this parser is hand-coded), there are api similarities, and Travis's parser was definitely helpful when figuring out just what the heck the logs were supposed to look like.
His license is replicated here:
right (c) 2015, Travis Cline <travis.cline@gmail.com>
ission to use, copy, modify, and/or distribute this software for any purpose
or without fee is hereby granted, provided that the above copyright notice
this permission notice appear in all copies.
SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
RD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
ESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
RECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
SE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
IOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
SOFTWARE.
Another debt of gratitude goes out to Thomas Rückstieß and his awesome mongodb log spec at https://github.com/rueckstiess/mongodb-log-spec. In particular the queryshape package attempts (and fails in some cases) to match up with his spec.
Features, bug fixes and other changes to mongodbtools are gladly accepted. Please open issues or a pull request with your change. Remember to add your name to the CONTRIBUTORS file!
All contributions will be released under the Apache License 2.0.