facts v0.1.0 API Reference

Modules

Facts module is used to query the underlying system for given details

Facts.CPU handles all logic with regards to collecting metrics on the CPUs of the host

Provides a struct to hold CPU data

Provides a struct to hold CPU data

An alternative to use @constant_name value approach to defined reusable constants in elixir. This module offers an approach to define these in a module that can be shared with other modules. They are implemented with macros so they can be used in guards and matches

Examples:

Create a module to define your shared constants

defmodule MyConstants do
  use Constants
  define something,   10
  define another,     20
end

Use the constants

defmodule MyModule do
  require MyConstants
  alias MyConstants, as: Const
  def myfunc(item) when item == Const.something, do: Const.something + 5
  def myfunc(item) when item == Const.another, do: Const.another
end

Provides a struct to hold IO counters data

Provides a struct to hold Partition data

Provides a struct to hold usage data

Provides a struct to hold Host data

Provides a struct to hold Host data

Provides a struct to hold average load data

Provides a struct to hold miscellaneous data

Provides a struct to hold virtual memory data

Provides a struct to hold virtual memory data

Facts.Utils contains common logic that is used mostly internally by other modules