Skip to content

Commit

Permalink
Add documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Kochie <[email protected]>
  • Loading branch information
SuperQ committed Aug 14, 2018
1 parent 3dd9f30 commit bd94ce9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
5 changes: 5 additions & 0 deletions generator/FORMAT.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module_name:
# List of OID subtrees to walk.
- 1.3.6.1.2.1.2
- 1.3.6.1.2.1.31.1.1
- 1.3.6.1.2.1.25.1.2
get:
# List of OIDs to get directly.
- 1.3.6.1.2.1.1.3
Expand All @@ -25,6 +26,10 @@ module_name:
# as a label value on that gauge.
# A metric that's part of a table, and thus has labels.
- name: hrSystemDate
oid: 1.3.6.1.2.1.25.1.2
type: DateAndTime
help: The host's notion of the local date and time of day. - 1.3.6.1.2.1.25.1.2
- name: ifMtu
oid: 1.3.6.1.2.1.2.2.1.4
type: gauge
Expand Down
1 change: 1 addition & 0 deletions generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ modules:
# gauge: An integer with type gauge.
# counter: An integer with type counter.
# OctetString: A bit string, rendered as 0xff34.
# DateAndTime: An RFC 2579 DateAndTime byte sequence. If the device has no time zone data, UTC is used.
# DisplayString: An ASCII or UTF-8 string.
# PhysAddress48: A 48 bit MAC address, rendered as 00:01:02:03:04:ff.
# Float: A 32 bit floating-point value with type gauge.
Expand Down

0 comments on commit bd94ce9

Please sign in to comment.