facts

README

Facts

Facts was originally included in Shepherd to gather facts about the operating system. It makes sense to break it out into a separate project so that they can move at different speeds.

Install

$ go get github.com/sfreiberg/facts

Documentation

http://godoc.org/github.com/sfreiberg/facts

Simple Example

package main

import (
	"github.com/sfreiberg/facts"

	"fmt"
)

func main() {
	f := factsFindFacts()
	json, err := f.ToPrettyJson()
	if err != nil {
		panic(err)
	}
	fmt.Printf("%s\n", json)
}

Current Features

• Get hostname, domain, cpu, os and interfaces

Planned Features

• BSD support
• Additional facts
  • Memory
  • Mounts

Current Limitations

• Only works on Linux, Mac OS X
• Lack of testing

Documentation

Overview

Gather facts (memory, cpus, filesystems, etc...) about the current machine.

Index

• type Address
• type Facts
  • func FindFacts() *Facts
  • func (f *Facts) ToJson() ([]byte, error)
  • func (f *Facts) ToPrettyJson() ([]byte, error)
  • func (f *Facts) ToYAML() ([]byte, error)
• type FileSystem
• type Interface

Types

type Address

type Address struct {
	Network   string `json:"network"`
	Address   string `json:"address"`
	IPNetwork string `json:"ip_network"`
}

type Facts

type Facts struct {
	Hostname         string                `json:"hostname"`
	Domain           string                `json:"domain"`
	Fqdn             string                `json:"fqdn"`
	Cpus             int                   `json:"cpus"`
	Arch             string                `json:"arch"`
	Os               string                `json:"os"`
	Platform         string                `json:"platform"`
	PlatformVersion  string                `json:"platform_version"`
	PlatformCodename string                `json:"platform_codename"`
	Uptime           float64               `json:"uptime"`
	Memory           uint64                `json:"memory"`      // In megabytes
	Swap             uint64                `json:"swap"`        // In megabytes
	Interfaces       map[string]Interface  `json:"interfaces"`  // key is nic name ex: en0, eth0
	FileSystems      map[string]FileSystem `json:"filesystems"` // key is DeviceName
}

func FindFacts

func FindFacts() *Facts

Gather all of the system facts available

func (*Facts) ToJson

func (f *Facts) ToJson() ([]byte, error)

Return facts as a JSON document

func (*Facts) ToPrettyJson

func (f *Facts) ToPrettyJson() ([]byte, error)

Return facts as a JSON document with newlines and indentation added.

func (*Facts) ToYAML

func (f *Facts) ToYAML() ([]byte, error)

Return facts as YAML

type FileSystem

type FileSystem struct {
	Directory  string `json:"directory"`
	DeviceType string `json:"device_type"`
	SysType    string `json:"sys_type"`
	Options    string `json:"options"`
	Size       uint64 `json:"size"` // in megabytes
}

type Interface

type Interface struct {
	Index        int       `json:"index"`
	MTU          int       `json:"mtu"`
	Name         string    `json:"name"`
	HardwareAddr string    `json:"hardware_addr"`
	Flags        []string  `json:"flags"`
	Addresses    []Address `json:"addresses"`
}