README
1Go-kstat provides a Go API for the kstat kernel statistics system
2on Solaris, Illumos, OmniOS, and other Solaris derived systems. For
3general information on kstats, see the kstat(1) and kstat(3kstat)
4manpages. For more documentation on the details of the package, see
5doc.go, kstat_solaris.go, types_solaris_amd64.go, and raw_solaris.go.
6
7This package is quite young, so the API may well change as I and
8other people gain experience with using it.
9
10The API supports access to 'named' kstat statistics, IO statistics,
11and the most common and useful sorts of 'raw' kstat statistics
12(unix:0:sysinfo, unix:0:vminfo, unix:0:var, and mnt:*:mntinfo).
13Other raw kstat statistics are not explicitly supported, but the
14API provides some escape hatches for access to custom raw
15statistics.
16
17This is a cgo-based package so it can't be cross compiled like a regular
18Go package. It may also have bugs with memory management, since it
19interacts with the Solaris kstat library and holds references to memory
20that's been dynamically allocated in C.
21
22See kstat-godoc.txt for a text dump of the full godoc for the package.
23Unfortunately Go tool limitations appear to make it impossible to see
24full package documentat on anything except a Solaris machine (including
25https://godoc.org/, sadly).
26
27Bug reports and other contributions are highly welcome.
28
29Author:
30
31Chris Siebenmann
32https://github.com/siebenmann/go-kstat
33https://utcc.utoronto.ca/~cks/space/blog/
34
35(and elsewhere)
36
37Copyright: standard Go copyright
38