Units found in metric documentation.
A metric may have one of the following units...
===
ampere: the amount of electric charge passing a point in an electric circuit per unit time.
===
volt: the difference in electric potential between two points of a conducting wire when an electric current of one ampere dissipates one watt of power between those points.
===
Celsius: unit of measurement for temperature.
===
bit: basic unit of digital information.
byte: unit of digital information.
kilobytes: 1 kilobyte
consists of 1000 bytes
.
kibibyte: 1 kibibyte
consists of 1024 bytes
.
megabytes: 1 megabyte
consists of 1e6 bytes
.
mebibyte: 1 mebibyte
consists of 1024^2 bytes
.
gigabyte: 1 gigabyte
consists of 1e9 bytes
.
gibibyte: 1 gibibyte
consists of 1024^3 bytes
.
megabytes per second: 1 megabyte
consists of 1e6 bytes
.
===
hugepages: number of pages in memory that are larger than the default page size.
===
milliseconds: unit of measurement for time.
seconds: unit of measurement for time.
===
I/O: input and output.
rpm: revolutions per minute.
utilization: describes a unitless value indicating the extent to which a device is utilized.
===
To contribute to the units documentation, see the contributing guide. Any updates to the documentation should be tagged.
$ git tag -a <major.minor.patch> -m "[UPDATE] version."
$ git push origin <major.minor.patch>
Use semantic versioning (semvar) for communicating versions.
- Any new units should be communicated as
minor
updates. - Any corrections/value modifications should be
patches
. - Any documentation restructuring (changing field names, removing fields, etc) should be communicated as a
major
update.
===
The documentation is stored as JSON, a lightweight data-interchange format. Many languages provide JSON support: JavaScript, Python, Go, PHP, Java, Haskell, and others.
You are free to use the JSON documentation, as is. Simply copy the file and use accordingly.
For those using package managers to manage dependencies, we provide package manager support, as outlined below.
The documentation is registered as a Bower package. Bower provides a straightforward means for managing dependencies.
In order to use Bower, you must first install Node.js and Git. Once the prerequisites are installed,
$ npm install -g bower
To install the latest documentation,
$ bower install doc-metrix-units
Bower will place the documentation in a bower_components/
directory within the current working directory.
To update to the latest documentation,
$ bower update doc-metrix-units
Copyright © 2014. NodePrime.