This plugin collects facts about nodes (systems) such as hardware details, network settings, OS type and version, IP addresses, MAC addresses, SSH keys and more from Facter and converts them into Snap metrics.
It's used in the Snap framework.
- facter 3.x
- golang 1.5+ (needed only for building)
NOTE: Facter 2.x may also work, but it's currently not part of our test matrix.
All OSs currently supported by Snap:
- Linux/amd64
- Darwin/amd64
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).
Fork https://github.com/intelsdi-x/snap-plugin-collector-facter
Clone repo into $GOPATH/src/github.com/intelsdi-x/:
$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-facter.git
Build the Snap facter plugin by running make within the cloned repo:
$ make
This builds the plugin in ./build/
- Set up the Snap framework
- Load the plugin and create a task, see example in Examples.
There are a number of other resources you can review to learn to use this plugin:
This plugin has the ability to gather the following metrics:
| Namespace | Description |
|---|---|
| /intel/facter/architecture | |
| /intel/facter/bios_release_date | |
| /intel/facter/bios_vendor | |
| /intel/facter/bios_version | |
| /intel/facter/blockdevices | |
| /intel/facter/blockdevice_sda_model | |
| /intel/facter/blockdevice_sda_size | |
| /intel/facter/blockdevice_sda_vendor | |
| /intel/facter/blockdevice_sdb_model | |
| /intel/facter/blockdevice_sdb_size | |
| /intel/facter/blockdevice_sdb_vendor | |
| /intel/facter/boardmanufacturer | |
| /intel/facter/boardproductname | |
| /intel/facter/boardserialnumber | |
| /intel/facter/dhcp_servers | |
| /intel/facter/domain | |
| /intel/facter/facterversion | |
| /intel/facter/filesystems | |
| /intel/facter/fqdn | |
| /intel/facter/gid | |
| /intel/facter/hardwareisa | |
| /intel/facter/hardwaremodel | |
| /intel/facter/hostname | |
| /intel/facter/id | |
| /intel/facter/interfaces | |
| /intel/facter/ipaddress | |
| /intel/facter/ipaddress_[INTERFACE] | |
| /intel/facter/is_virtual | |
| /intel/facter/kernel | |
| /intel/facter/kernelmajversion | |
| /intel/facter/kernelrelease | |
| /intel/facter/kernelversion | |
| /intel/facter/lsbdistcodename | |
| /intel/facter/lsbdistdescription | |
| /intel/facter/lsbdistid | |
| /intel/facter/lsbdistrelease | |
| /intel/facter/lsbmajdistrelease | |
| /intel/facter/lsbminordistrelease | |
| /intel/facter/lsbrelease | |
| /intel/facter/macaddress | |
| /intel/facter/macaddress_[INTERFACE] | |
| /intel/facter/manufacturer | |
| /intel/facter/memoryfree | |
| /intel/facter/memoryfree_mb | |
| /intel/facter/memorysize | |
| /intel/facter/memorysize_mb | |
| /intel/facter/mtu_[INTERFACE] | |
| /intel/facter/mtu_lo | |
| /intel/facter/netmask | |
| /intel/facter/netmask_[INTERFACE] | |
| /intel/facter/network_[INTERFACE] | |
| /intel/facter/operatingsystem | |
| /intel/facter/operatingsystemmajrelease | |
| /intel/facter/operatingsystemrelease | |
| /intel/facter/os | |
| /intel/facter/osfamily | |
| /intel/facter/partitions | |
| /intel/facter/path | |
| /intel/facter/physicalprocessorcount | |
| /intel/facter/processor[ID] | |
| /intel/facter/processorcount | |
| /intel/facter/processors | |
| /intel/facter/productname | |
| /intel/facter/ps | |
| /intel/facter/rubyplatform | |
| /intel/facter/rubysitedir | |
| /intel/facter/rubyversion | |
| /intel/facter/selinux | |
| /intel/facter/selinux_config_mode | |
| /intel/facter/selinux_config_policy | |
| /intel/facter/selinux_current_mode | |
| /intel/facter/selinux_enforced | |
| /intel/facter/selinux_policyversion | |
| /intel/facter/serialnumber | |
| /intel/facter/ssh[KEY] | |
| /intel/facter/swapfree | |
| /intel/facter/swapfree_mb | |
| /intel/facter/swapsize | |
| /intel/facter/swapsize_mb | |
| /intel/facter/system_uptime | |
| /intel/facter/timezone | |
| /intel/facter/type | |
| /intel/facter/uniqueid | |
| /intel/facter/uptime | |
| /intel/facter/uptime_days | |
| /intel/facter/uptime_hours | |
| /intel/facter/uptime_seconds | |
| /intel/facter/uuid | |
| /intel/facter/virtual |
Example of running Snap facter 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-facter/latest/linux/x86_64/snap-plugin-collector-facter
$ 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-facter
$ snaptel plugin load snap-plugin-publisher-file
See all available metrics:
$ snaptel metric list
Download an example task file and load it:
$ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-facter/master/examples/tasks/task-facter.json
$ snaptel task create -t task-facter.json
Using task manifest to create task
Task created
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
Name: Task-02dd7ff4-8106-47e9-8b86-70067cd0a850
State: Running
See realtime output from snaptel task watch <task_id> (CTRL+C to exit)
2015-12-02 08:49:33.679791899 -0500 EST|[intel facter architecture]|amd64|gklab-044-107
2015-12-02 08:49:33.679792606 -0500 EST|[intel facter bios_release_date]|07/14/2011|gklab-044-107
2015-12-02 08:49:33.679797562 -0500 EST|[intel facter bios_vendor]|Hewlett-Packard|gklab-044-107
2015-12-02 08:49:33.679797789 -0500 EST|[intel facter bios_version]|786H1 v01.13|gklab-044-107
2015-12-02 08:49:34.680113961 -0500 EST|[intel facter architecture]|amd64|gklab-044-107
2015-12-02 08:49:34.680114801 -0500 EST|[intel facter bios_release_date]|07/14/2011|gklab-044-107
2015-12-02 08:49:34.680115034 -0500 EST|[intel facter bios_vendor]|Hewlett-Packard|gklab-044-107
2015-12-02 08:49:34.680115224 -0500 EST|[intel facter bios_version]|786H1 v01.13|gklab-044-107
2015-12-02 08:49:35.680925816 -0500 EST|[intel facter architecture]|amd64|gklab-044-107
2015-12-02 08:49:35.680926797 -0500 EST|[intel facter bios_release_date]|07/14/2011|gklab-044-107
Stop task:
$ snaptel task stop 02dd7ff4-8106-47e9-8b86-70067cd0a850
Task stopped:
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
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.
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.
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.
Snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.
- Author: @ppalucki
And thank you! Your contribution, through code and participation, is incredibly important to us.