1 files changed, 81 insertions, 0 deletions
diff --git a/src/sar2pcp/README b/src/sar2pcp/README
new file mode 100644
index 0000000..276c25b
--- /dev/null
+++ b/src/sar2pcp/README
@@ -0,0 +1,81 @@
+Converting a sadc data file to a PCP archive
+
+This example uses the PCP::LogImport Perl wrapper around the libpcp_import
+library to convert a sadc datafile into a PCP archive.
+
+The version of sar that is supported here is the one from
+http://freshmeat.net/projects/sysstat/ which includes the sadf utility
+to translate the sadc datafile into an XML file.  The Perl script
+sar2pcp runs sadf and translates the XML into a PCP archive.
+
+Usage: sar2pcp sadcfile archive
+
+The translation currently supports the following PCP metrics:
+    disk.all.read
+    disk.all.read_bytes
+    disk.all.total
+    disk.all.total_bytes
+    disk.all.write
+    disk.all.write_bytes
+    disk.dev.avactive
+    disk.dev.read_bytes
+    disk.dev.total
+    disk.dev.total_bytes
+    disk.dev.write_bytes
+    kernel.all.cpu.idle
+    kernel.all.cpu.intr
+    kernel.all.cpu.nice
+    kernel.all.cpu.sys
+    kernel.all.cpu.user
+    kernel.all.cpu.wait.total
+    kernel.all.intr
+    kernel.all.load
+    kernel.all.pswitch
+    kernel.percpu.cpu.idle
+    kernel.percpu.cpu.intr
+    kernel.percpu.cpu.nice
+    kernel.percpu.cpu.sys
+    kernel.percpu.cpu.user
+    kernel.percpu.cpu.wait.total
+    mem.util.bufmem
+    mem.util.cached
+    mem.util.free
+    mem.util.swapCached
+    mem.util.swapFree
+    mem.util.used
+    mem.vmstat.pgfault
+    mem.vmstat.pgfree
+    mem.vmstat.pgmajfault
+    mem.vmstat.pgpgin
+    mem.vmstat.pgpgout
+    network.interface.collisions
+    network.interface.in.bytes
+    network.interface.in.drops
+    network.interface.in.errors
+    network.interface.in.fifo
+    network.interface.in.frame
+    network.interface.in.packets
+    network.interface.out.bytes
+    network.interface.out.carrier
+    network.interface.out.drops
+    network.interface.out.errors
+    network.interface.out.fifo
+    network.interface.out.packets
+    proc.runq.runnable
+    swap.pagesin
+    swap.pagesout
+    vfs.dentry.count
+    vfs.files.count
+    vfs.inodes.count
+
+This is sufficient to support the following standard pmchart views:
+    CPU
+    Disk
+    Diskbytes
+    Loadavg
+    Memory
+    Netbytes
+    Netpackets
+    Overview (except for a lesser memory stats)
+    Paging
+