]> i-scream Git - www.i-scream.org.git/blob - htdocs/libstatgrab/index.xhtml
Update copyright year.
[www.i-scream.org.git] / htdocs / libstatgrab / index.xhtml
1 <!--#include virtual="/doctype.inc" -->
2   <head>
3     <title>
4       libstatgrab homepage
5     </title>
6 <!--#include virtual="/style.inc" -->
7   </head>
8   <body>
9     <div id="container">
10       <div id="main">
11 <!--#include virtual="/header.inc" -->
12         <div id="contents">
13           <h1 class="top">
14             libstatgrab homepage
15           </h1>
16           <div id="topnav">
17             <ul>
18               <li>
19                 <a href="#what">What is libstatgrab?</a>
20               </li>
21               <li>
22                 <a href="#news">News</a>
23               </li>
24               <li>
25                 <a href="#download">Downloading</a>
26               </li>
27               <li>
28                 <a href="#bindings">Language Bindings</a>
29               </li>
30               <li>
31                 <a href="#packages">Packages</a>
32               </li>
33               <li>
34                 <a href="#development">Development</a>
35               </li>
36               <li>
37                 <a href="#documentation">Documentation</a>
38               </li>
39               <li>
40                 <a href="#screenshot">Screenshot</a>
41               </li>
42             </ul>
43           </div>
44           <h2>
45             <a id="what">What is libstatgrab?</a>
46           </h2>
47           <p>
48             libstatgrab is a library that provides cross platform
49             access to statistics about the system on which it's run.
50             It's written in C and presents a selection of useful
51             interfaces which can be used to access key system
52             statistics. The current list of statistics includes CPU
53             usage, memory utilisation, disk usage, process counts,
54             network traffic, disk I/O, and more.
55           </p>
56           <p>
57             The current list of supported and tested platforms
58             includes FreeBSD, Linux, NetBSD, OpenBSD, Solaris,
59             DragonFly BSD, HP-UX and AIX. We are always happy to
60             accept patches to extend support to other operating
61             systems.
62           </p>
63           <p>
64             The package also includes a couple of useful tools. The
65             first, <a href="#screenshot">saidar</a>, provides a
66             curses-based interface to viewing the current state of the
67             system. The second, statgrab, gives a sysctl-style
68             interface to the statistics gathered by libstatgrab. This
69             extends the use of libstatgrab to people writing scripts or
70             anything else that can't easily make C function calls.
71             Included with statgrab is a script to generate an
72             <a href="http://www.mrtg.org">MRTG</a> configuration file
73             to use statgrab.
74           </p>
75           <h2>
76             <a id="news">News</a>
77           </h2>
78           <h3>
79             Friday 11 July 2014
80           </h3>
81           <p>
82             Version 0.91 of libstatgrab has been released.<br />
83             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
84           </p>
85           <p>
86             This release includes a number of bugfixes and new
87             features but is API compatible with 0.90.
88           </p>
89           <ul>
90             <li>Use /proc/mounts on Linux where available.</li>
91             <li>Add a new field named device_canonical to the filesystem
92                 statistics.</li>
93             <li>Fix list miscounting in sg_set_valid_filesystems.</li>
94             <li>Fix buffer overrun when dealing with a larger number of
95                 processes.</li>
96             <li>Fix divide by zero display problem in saidar.</li>
97             <li>When logging with log4cplus is enabled, properties files
98                 are installed in to ${prefix}/etc.</li>
99             <li>Add Graphite output support in statgrab.</li>
100           </ul>
101           <p>
102             A full list of changes can be found in the
103             <a href="http://git.i-scream.org/?p=libstatgrab.git;a=blob;f=NEWS;h=3fbe52269637c4e68aab0d70b0419343889a4d4f;hb=d8d6c819ee007eb03bc95a48a614bcefec229b42">NEWS</a>
104             file contained within the release.
105           </p>
106           <p>
107             If you find any bugs in the release please report them
108             over at our
109             <a href="https://github.com/i-scream/libstatgrab/issues">Issue
110             Tracker</a> on GitHub.
111           </p>
112           <h3>
113             Thursday 8 August 2013
114           </h3>
115           <p>
116             Version 0.90 of libstatgrab has been released.<br />
117             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
118             Please note this and future releases are signed with a new
119             <a href="/pgpkey.xhtml">PGP key</a>.
120           </p>
121           <p>
122             Please note that the API in 0.90 has changed, so
123             applications using libstatgrab will need to be updated to
124             support the changes.
125           </p>
126           <p>
127             There are a large number of changes in this version of
128             libstatgrab. Here is an overview:
129           </p>
130           <ul>
131             <li>Thread safety and reentrant functions.</li>
132             <li>API unification (every stats call is now able to
133                 return multiple entries).</li>
134             <li>Complete rewrite of internal memory management (eases
135                 future extensions).</li>
136             <li>Add experimental support for tracing using log4cplus.</li>
137             <li>Complete the ports for AIX, HP-UX and most of the
138                 widely used BSD-based operating systems.</li>
139             <li>Complete the port for Darwin/MacOS X including basic
140                 Mach.</li>
141             <li>Clean up the FreeBSD and Solaris implementations.</li>
142             <li>Clean up the FreeBSD and Solaris implementations.</li>
143           </ul>
144           <p>
145             This release is the result of a significant amount of work
146             by the newest member of the libstatgrab team - Jens
147             Rehsack. Welcome to the team Jens!
148           </p>
149           <p>
150             If you find any bugs in the release please report them
151             over at our
152             <a href="https://github.com/i-scream/libstatgrab/issues">Issue
153             Tracker</a> on GitHub.
154           </p>
155           <h3>
156             Sunday 21 February 2010
157           </h3>
158           <p>
159             Version 0.17 of libstatgrab has been released.<br />
160             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
161           </p>
162           <p>
163             This release adds support for FreeBSD 9 and other systems
164             using utmpx. Also on FreeBSD it fixes an issue with large
165             quantities of memory and adds support for dynamically
166             getting a list of supported file systems. On Solaris ZFS
167             file systems will now be detected. And finally on Linux CPU
168             iowait information will be given where available.
169           </p>
170           <h3>
171             Friday 30 May 2008
172           </h3>
173           <p>
174             Dag Odenhall got in touch today to let us know he's written
175             <a href="http://statgrab.rubyforge.org/">Ruby bindings</a>
176             for libstatgrab. Thanks Dag!
177           </p>
178           <h3>
179             Monday 17 March 2008
180           </h3>
181           <p>
182             Version 0.16 of libstatgrab has been released.<br />
183             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
184           </p>
185           <p>
186             This release fixes some minor build problems on Solaris
187             with Sun's compiler, and on the Debian "armel" port. Also
188             a minor fix to statgrab-make-mrtg-config on machines with
189             no swap, and added support for FreeBSD 8.
190           </p>
191           <h3>
192             Saturday 14 July 2007
193           </h3>
194           <p>
195             Version 0.15 of libstatgrab has been released.<br />
196             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
197           </p>
198           <p>
199             This release fixes a regression introduced on OpenBSD in
200             the last release - memory statistics were reported
201             incorrectly. Some other minor changes have been made, see
202             the NEWS file for more information.
203           </p>
204           <h3>
205             Monday 8 January 2007
206           </h3>
207           <p>
208             Version 0.14 of libstatgrab has been released.<br />
209             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
210           </p>
211           <p>
212             This release contains mainly bugfixes - see the NEWS file
213             in the distribution for a full list. It also brings a new
214             feature in saidar: colour support, which can be activated
215             with the -c runtime flag.
216           </p>
217           <h3>
218             Monday 20 March 2006
219           </h3>
220           <p>
221             Version 0.13 of libstatgrab has been released.<br />
222             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
223           </p>
224           <p>
225             This release mainly includes a bunch of bug fixes, but
226             also brings preliminary support for WIN32. We've also
227             added a few lines to the header file to make C++ linking
228             easier. Please see the NEWS file in the distribution for
229             full details.
230           </p>
231           <h3>
232             Sunday 31 July 2005
233           </h3>
234           <p>
235             Version 0.12 of libstatgrab has been released.<br />
236             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
237           </p>
238           <p>
239             This release has some new features, bug fixes, and a minor
240             API change. More details have been added to the file
241             system statistics, linux partition detection has been
242             reworked, and compile errors on Linux 2.6 have been fixed.
243             Support has been added for Solaris 10 and FreeBSD 7.
244             There are also manual pages for all the tools.
245           </p>
246           <p>
247             The duplex value in the network interface statistics has
248             changed name from "dup" to "duplex" - this breaks the API.
249             We plan to stabilise the API for a 1.0 release. As before,
250             the old name is available if SG_ENABLE_DEPRECATED is
251             defined.
252           </p>
253           <h3>
254             Tuesday 26 April 2005
255           </h3>
256           <p>
257             Official libstatgrab packages for Debian now
258             <a href="http://packages.debian.org/unstable/source/libstatgrab">available</a>.
259           </p>
260           <p>
261             Thanks to the work of
262             <a href="mailto:fenio@debian.org">Bartosz Fenski</a>
263             libstatgrab is now available on debian. This replaces our
264             unofficial debian packages which will no longer be
265             updated.
266           </p>
267           <h3>
268             Thursday 3 March 2005
269           </h3>
270           <p>
271             Version 0.11.1 of libstatgrab has been released.<br />
272             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
273           </p>
274           <p>
275             This release fixes a handful of minor bugs. Duplex
276             settings were reported incorrectly on linux (half and
277             full duplex were swapped), saidar displayed negative
278             filesystem stats incorrectly, and NFS filesystems were
279             ignored. These have all been fixed.
280           </p>
281           <h3>
282             Friday 12 November 2004
283           </h3>
284           <p>
285             Version 0.11 of libstatgrab has been released.<br />
286             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
287           </p>
288           <p>
289             This release brings support for HP-UX (version 11.11), and
290             also fixes a few other minor issues.
291           </p>
292           <h3>
293             Wednesday 25 August 2004
294           </h3>
295           <p>
296             Version 0.10.3 of libstatgrab has been released.<br />
297             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
298           </p>
299           <p>
300             This release adds a handful of new features to statgrab, and
301             adds support for FreeBSD 6.0-CURRENT. See the NEWS file in
302             the tarball for more details.
303           </p>
304           <h3>
305             Tuesday 27 July 2004
306           </h3>
307           <p>
308             Version 0.10.2 of libstatgrab has been released.<br />
309             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
310           </p>
311           <p>
312             This release fixes a problem with the shared library
313             version number in the last release.
314           </p>
315           <h3>
316             Monday 26 July 2004
317           </h3>
318           <p>
319             Version 0.10.1 of libstatgrab has been released.<br />
320             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
321           </p>
322           <p>
323             This release consists almost entirely of bugfixes.
324             We've fixed compile-time errors for recent OpenBSD and
325             NetBSD platforms, and also a minor bug in statgrab
326             that broke network statistics on Solaris. New
327             variables have been added to the pkg-config file to
328             suggest ownership and permissions of binaries, and
329             we've added error reporting functions that store errno
330             values. There's also other minor fixes detailed in the
331             NEWS file.
332           </p>
333           <h3>
334             Thursday 20 May 2004
335           </h3>
336           <p>
337             Version 0.10 of libstatgrab has been released.<br />
338             Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.
339           </p>
340           <p>
341             This release concentrates heavily on standardising the names
342             of functions and structures throughout libstatgrab. Although
343             this will mean changes for existing programs, in the long run
344             we hope it'll make things both clearer and easier. However,
345             for those who still need the old functions we have provided
346             compatibility wrappers. See the NEWS file for details.
347           </p>
348           <p>
349             The other main change in this release is a new function to
350             provide full details on currently running processes. See the
351             documentation for sg_get_process_stats for details. Along with
352             this there are compare functions for use with qsort for sorting
353             process, network, and disk io statistics. We've also introduced
354             error reporting functions that allow calling applications to
355             see why libstatgrab has returned a failure. See sg_get_error.
356           </p>
357           <p>
358             Finally, we've added support for NetBSD 2.0 and tidied up lots
359             of areas of the code. This release does not include the python
360             bindings - they're now available as their own project called
361             <a href="/pystatgrab/">pystatgrab</a>.
362           </p>
363           <h3>
364             Sunday 21 March 2004
365           </h3>
366           <p>
367             pystatgrab, a new package containing a set of Python
368             bindings, has been released. Check out its
369             <a href="/pystatgrab/">project page</a>.
370           </p>
371           <h2>
372             <a id="download">Downloading</a>
373           </h2>
374           <p>
375             The latest version of libstatgrab can be downloaded from
376             our <a href="/mirrors.xhtml">mirror sites</a>.
377             All downloads are pgp signed using our
378             <a href="/pgpkey.xhtml">PGP Key</a>.
379           </p>
380           <p>
381             For installation instructions see the README and INSTALL
382             files contained within the archive.
383           </p>
384           <h2>
385             <a id="bindings">Language Bindings</a>
386           </h2>
387           <ul>
388             <li>
389               <a href="/pystatgrab/">Python</a>
390             </li>
391             <li>
392               <a href="http://pecl.php.net/statgrab/">PHP</a>
393             </li>
394             <li>
395               <a href="http://search.cpan.org/dist/Unix-Statgrab/">Perl</a>
396             </li>
397             <li>
398               <a href="http://statgrab.rubyforge.org/">Ruby</a>
399             </li>
400           </ul>
401           <p>
402             Here are links to bindings for higher level languages
403             that provide access to libstatgrab. If you've written
404             a binding for another language, please get in touch so we
405             can add a link here.
406           </p>
407           <h2>
408             <a id="packages">Packages of libstatgrab</a>
409           </h2>
410           <ul>
411             <li>
412               <a href="http://www.freebsd.org/cgi/ports.cgi?query=statgrab&amp;stype=all">FreeBSD</a>
413             </li>
414             <li>
415               <a href="http://packages.gentoo.org/search/?sstring=libstatgrab">Gentoo Linux</a>
416             </li>
417             <li>
418               <a href="http://www.blastwave.org/packages.php/libstatgrab">Solaris (Blastwave)</a>
419             </li>
420             <li>
421               <a href="http://www.sunfreeware.com/">Solaris (SunFreeware)</a>
422             </li>
423             <li>
424               <a href="http://www.opencsw.org/packages/libstatgrab/">Solaris (OpenCSW)</a>
425             </li>
426             <li>
427               <a href="http://packages.debian.org/unstable/source/libstatgrab">Debian</a>
428             </li>
429             <li>
430               <a href="ftp://ftp.netbsd.org/pub/NetBSD/packages/pkgsrc/devel/libstatgrab/README.html">NetBSD</a>
431             </li>
432             <li>
433               <a href="http://software.opensuse.org/download/home:/anagappan/">RPMs for various Linux distributions</a>
434             </li>
435             <li>
436               <a href="http://www.openbsd.org/cgi-bin/cvsweb/ports/sysutils/libstatgrab/">OpenBSD</a>
437             </li>
438           </ul>
439           <p>
440             These are various pre-packaged versions of libstatgrab
441             that you can get for your favourite operating system. If
442             we've missed any out, please let us know.
443           </p>
444           <p>
445             We've noticed that Google throws up some RPM's relating
446             to Mandrake and Suse, but no webpage for them.
447           </p>
448           <h2>
449             <a id="documentation">Documentation</a>
450           </h2>
451           <p>
452             The only online documentation we have at the moment is the
453             manual pages converted in to HTML format. First are the
454             manual pages for the command line tools:
455           </p>
456           <ul>
457             <li>
458               <a href="docs/saidar.1.html">saidar(1)</a>
459             </li>
460             <li>
461               <a href="docs/statgrab.1.html">statgrab(1)</a>
462             </li>
463             <li>
464               <a href="docs/statgrab-make-mrtg-config.1.html">statgrab-make-mrtg-config(1)</a>
465             </li>
466             <li>
467               <a href="docs/statgrab-make-mrtg-index.1.html">statgrab-make-mrtg-index(1)</a>
468             </li>
469           </ul>
470           <p>
471             We also have an overview page for the library:
472           </p>
473           <ul>
474             <li>
475               <a href="docs/statgrab.3.html">statgrab(3)</a>
476             </li>
477           </ul>
478           <p>
479             Then we have the manual pages for each function:
480           </p>
481           <ul>
482             <li>
483               <a href="docs/sg_comp_init.3.html">sg_comp_init(3)</a>
484             </li>
485             <li>
486               <a href="docs/sg_get_cpu_stats.3.html">sg_get_cpu_stats(3)</a>
487             </li>
488             <li>
489               <a href="docs/sg_get_disk_io_stats.3.html">sg_get_disk_io_stats(3)</a>
490             </li>
491             <li>
492               <a href="docs/sg_get_error.3.html">sg_get_error(3)</a>
493             </li>
494             <li>
495               <a href="docs/sg_get_fs_stats.3.html">sg_get_fs_stats(3)</a>
496             </li>
497             <li>
498               <a href="docs/sg_get_host_info.3.html">sg_get_host_info(3)</a>
499             </li>
500             <li>
501               <a href="docs/sg_get_load_stats.3.html">sg_get_load_stats(3)</a>
502             </li>
503             <li>
504               <a href="docs/sg_get_mem_stats.3.html">sg_get_mem_stats(3)</a>
505             </li>
506             <li>
507               <a href="docs/sg_get_network_iface_stats.3.html">sg_get_network_iface_stats(3)</a>
508             </li>
509             <li>
510               <a href="docs/sg_get_network_io_stats.3.html">sg_get_network_io_stats(3)</a>
511             </li>
512             <li>
513               <a href="docs/sg_get_page_stats.3.html">sg_get_page_stats(3)</a>
514             </li>
515             <li>
516               <a href="docs/sg_get_process_stats.3.html">sg_get_process_stats(3)</a>
517             </li>
518             <li>
519               <a href="docs/sg_get_user_stats.3.html">sg_get_user_stats(3)</a>
520             </li>
521             <li>
522               <a href="docs/sg_init.3.html">sg_init(3)</a>
523             </li>
524             <li>
525               <a href="docs/sg_internal-intro.3.html">sg_internal-intro(3)</a>
526             </li>
527             <li>
528               <a href="docs/sg_intro.3.html">sg_intro(3)</a>
529             </li>
530             <li>
531               <a href="docs/sg_lock_mutex.3.html">sg_lock_mutex(3)</a>
532             </li>
533             <li>
534               <a href="docs/sg_set_error.3.html">sg_set_error(3)</a>
535             </li>
536             <li>
537               <a href="docs/sg_vector_create.3.html">sg_vector_create(3)</a>
538             </li>
539           </ul>
540           <h2>
541             <a id="screenshot">Screenshot</a>
542           </h2>
543           <p>
544             Here's what saidar looks like when it's running:
545           </p>
546           <p>
547             <img src="saidar.png" alt="saidar screenshot" />
548           </p>
549         </div>
550 <!--#include virtual="/footer.inc" -->
551       </div>
552 <!--#include virtual="/menu.inc" -->
553     </div>
554   </body>
555 </html>