snap-plugin-collector-mongodb

DISCONTINUATION OF PROJECT.

This project will no longer be maintained by Intel.

This project has been identified as having known security escapes.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project.

DISCONTINUATION OF PROJECT

This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.

Snap collector plugin - mongodb

This plugin collects metrics from MongoDB database.

It's used in the Snap framework.

1. Getting Started

• System Requirements
• Operating systems
• Installation
• Configuration and Usage

1. Documentation

• Global Config
• Collected Metrics
• Examples
• Roadmap

1. Community Support
2. Contributing
3. License
4. Acknowledgements

Getting Started

System Requirements

• golang 1.7+ - needed only for building
• mongodb 3.2.x

Operating systems

All OSs currently supported by Snap:

• Linux/amd64
• Darwin/amd64

Installation

Download the plugin binary:

You can get the pre-built binaries for your OS and architecture from the plugin's GitHub Releases page. Download the plugin from the latest release and load it into snapteld (/opt/snap/plugins is the default location for Snap packages).

To build the plugin binary:

Fork https://github.com/intelsdi-x/snap-plugin-collector-mongodb Clone repo into $GOPATH/src/github.com/intelsdi-x/:

$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-mongodb.git

Build the Snap mongodb plugin by running make within the cloned repo:

$ make

This builds the plugin in ./build/

Configuration and Usage

• Set up the Snap framework.

• Configure connection strings to MongoDB service which includes username , password , hostname (default "localhost:27017").

• Load the plugin and create a task, see example in Examples.

Documentation

This collector gathers metrics from mongodb server status command.

Global config

Global configuration files are described in Snap's documentation. You have to add "mongodb" section with following entries:

• "uri" - it's hostname and port pair in format "hostname:port", as default set to "localhost:27017".
• "username" - username if authentification is enabled
• "password" - password if authentification is enabled

See exemplary Global configuration files in [examplary config files] (examples/configs/).

Collected Metrics

List of collected metrics is described in METRICS.md.

Examples

Example of running Snap mongodb collector and writing data to file.

Ensure snap daemon is running:

• initd: service snap-telemetry start
• systemd: systemctl start snap-telemetry
• command line: snapteld -l 1 -t 0 &

Download and load Snap plugins:

$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-mongodb/latest/linux/x86_64/snap-plugin-collector-mongodb
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
$ chmod 755 snap-plugin-*
$ snaptel plugin load snap-plugin-collector-mongodb
$ snaptel plugin load snap-plugin-publisher-file

Create a task manifest file  (exemplary files in [examples/tasks/] (examples/tasks/)):
```yaml
--- 
max-failures: 10
schedule: 
  interval: 1s
  type: simple
version: 1
workflow: 
  collect: 
    config: 
      /intel/mongodb: 
        uri: "localhost:27017"
        username: ""
        password: ""
    metrics: 
      /intel/mongodb/opscounters/command: {}
      /intel/mongodb/opscounters/delete: {}
      /intel/mongodb/opscounters/getmore: {}
      /intel/mongodb/opscounters/insert: {}
      /intel/mongodb/opscounters/query: {}
      /intel/mongodb/opscounters/update: {}
      /intel/mongodb/tmalloc/aggressive_memory_decommit: {}
      /intel/mongodb/tmalloc/central_cache_free_bytes: {}
      /intel/mongodb/tmalloc/current_allocated_bytes: {}
      /intel/mongodb/tmalloc/current_total_thread_cache_bytes: {}
      /intel/mongodb/tmalloc/heap_size: {}
      /intel/mongodb/tmalloc/max_total_thread_cache_bytes: {}
      /intel/mongodb/tmalloc/pageheap_free_bytes: {}
      /intel/mongodb/tmalloc/pageheap_unmapped_bytes: {}
      /intel/mongodb/tmalloc/thread_cache_free_bytes: {}
      /intel/mongodb/tmalloc/total_free_bytes: {}
      /intel/mongodb/tmalloc/transfer_cache_free_bytes: {}
    publish: 
      - 
        config: 
          file: /tmp/mongodb_metrics
        plugin_name: file

Download an example task file and load it:

$ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-mongodb/master/examples/tasks/mongodb-file.yaml
$ snaptel task create -t mongodb-file.json
Using task manifest to create task
Task created
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67
Name: Task-480323af-15b0-4af8-a526-eb2ca6d8ae67
State: Running

See realtime output from snaptel task watch <task_id> (CTRL+C to exit)

$ snaptel task watch 480323af-15b0-4af8-a526-eb2ca6d8ae67

This data is published to a file /tmp/mongodb_metrics per task specification

Stop task:

$ snaptel task stop 480323af-15b0-4af8-a526-eb2ca6d8ae67
Task stopped:
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67

Roadmap

There isn't a current roadmap for this plugin, but it is in active development. As we launch this plugin, we do not have any outstanding requirements for the next release.

If you have a feature request, please add it as an issue and/or submit a pull request.

Community Support

This repository is one of many plugins in Snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap.

To reach out to other users, head to the main framework or visit Slack.

Contributing

We love contributions!

There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.

License

Snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.

Acknowledgements

• Author: @Marcin Spoczynski

This software has been contributed by MIKELANGELO, a Horizon 2020 project co-funded by the European Union. https://www.mikelangelo-project.eu/

Thank You

And thank you! Your contribution, through code and participation, is incredibly important to us.