Documentation updates and a better example

eskibars · Mar 24, 2016 · afb8e62 · afb8e62
1 parent e93c733
commit afb8e62
Show file tree

Hide file tree

Showing 4 changed files with 96 additions and 113 deletions.
diff --git a/README.md b/README.md
@@ -1,115 +1,57 @@
-# Wmibeat
+# WMIbeat
 
-Welcome to Wmibeat.
+Welcome to WMIbeat.  WMIbeat is a [beat](https://github.com/elastic/beats) that allows you to run arbitrary WMI queries
+and index the results into [elasticsearch](https://github.com/elastic/elasticsearch) so you can monitor Windows machines.
 
 Ensure that this folder is at the following location:
 `${GOPATH}/github.com/eskibars`
 
-## Getting Started with Wmibeat
-
-### Init Project
-To get running with Wmibeat, run the following commands:
-
-```
-make init
-```
-
-
-To push Wmibeat in the git repository, run the following commands:
-
-```
-git commit 
-git remote set-url origin https://github.com/eskibars/wmibeat
-git push origin master
-```
-
-For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
-
-### Build
-
-To build the binary for Wmibeat run the command below. This will generate a binary
-in the same directory with the name wmibeat.
-
-```
-make
-```
-
-
+## Getting Started with WMIbeat
+To get running with WMIbeat, run "go build" and then run wmibeat.exe, as in the below `run` section.
+If you don't want to build your own, hop over to the "releases" page to download the latest.
+
+### Configuring
+To configure the WMI queries to run, you need to change wmibeat.yml.  Working from the default example:
+
+    classes:
+    - class: Win32_OperatingSystem
+      fields:
+      - FreePhysicalMemory
+      - FreeSpaceInPagingFiles
+      - FreeVirtualMemory
+      - NumberOfProcesses
+      - NumberOfUsers
+    - class: Win32_PerfFormattedData_PerfDisk_LogicalDisk
+      fields:
+      - Name
+      - FreeMegabytes
+      - PercentFreeSpace
+      - CurrentDiskQueueLength
+      - DiskReadsPerSec
+      - DiskWritesPerSec
+      - DiskBytesPerSec
+      - PercentDiskReadTime
+      - PercentDiskWriteTime
+      - PercentDiskTime
+      whereclause: Name != "_Total"
+    - class: Win32_PerfFormattedData_PerfOS_Memory
+      fields:
+      - CommittedBytes
+      - AvailableBytes
+      - PercentCommittedBytesInUse
+
+We can configure a set of classes, a set of fields per class, and a whereclause.  If there are multiple results, for any WMI class,
+WMIbeat will add the results as arrays.  If you need some help with what classes/fields, you can try [WMI Explorer](https://wmie.codeplex.com/).
+Note that many of the more interesting classes are "Perf" classes, which has a special checkbox to see in that tool.
+
 ### Run
 
-To run Wmibeat with debugging output enabled, run:
+To run WMIbeat with debugging output enabled, run:
 
 ```
 ./wmibeat -c wmibeat.yml -e -d "*"
 ```
 
-
-### Test
-
-To test Wmibeat, run the following commands:
-
-```
-make testsuite
-```
-
-alternatively:
-```
-make unit-tests
-make system-tests
-make integration-tests
-make coverage-report
-```
-
-The test coverage is reported in the folder `./build/coverage/`
-
-
-### Package
-
-To cross-compile and package Wmibeat for all supported platforms, run the following commands:
-
-```
-cd dev-tools/packer
-make deps
-make images
-make
-```
-
-### Update
-
-Each beat has a template for the mapping in elasticsearch and a documentation for the fields
-which is automatically generated based on `etc/fields.yml`.
-To generate etc/wmibeat.template.json and etc/wmibeat.asciidoc
-
-```
-make update
-```
-
-
-### Cleanup
-
-To clean  Wmibeat source code, run the following commands:
-
-```
-make fmt
-make simplify
-```
-
-To clean up the build directory and generated artifacts, run:
-
-```
-make clean
-```
-
-
-### Clone
-
-To clone Wmibeat from the git repository, run the following commands:
-
-```
-mkdir -p ${GOPATH}/github.com/eskibars
-cd ${GOPATH}/github.com/eskibars
-git clone https://github.com/eskibars/wmibeat
-```
-
-
+## Build your own Beat
+Beats is open source and has a convenient Beat generator, from which this project is based.
 For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
diff --git a/docs/index.asciidoc b/docs/index.asciidoc
@@ -1,5 +1,5 @@
-= Wmibeat Docs
-
-Welcome to the Wmibeat documentation.
+= WMIbeat Docs
 
+Welcome to the WMIbeat documentation.
 
+At the moment, all of the interesting documentation is still contained on the https://github.com/eskibars/wmibeat/blob/master/README.md[Readme]
diff --git a/etc/beat.yml b/etc/beat.yml
@@ -1,7 +1,34 @@
-################### Wmibeat Configuration Example #########################
+################### WMIbeat Configuration Example #########################
 
-############################# Wmibeat ######################################
+############################# WMIbeat ######################################
 
 wmibeat:
   # Defines how often an event is sent to the output
-  period: 1s
+  period: 30s
+
+  classes:
+    - class: Win32_OperatingSystem
+      fields:
+      - FreePhysicalMemory
+      - FreeSpaceInPagingFiles
+      - FreeVirtualMemory
+      - NumberOfProcesses
+      - NumberOfUsers
+    - class: Win32_PerfFormattedData_PerfDisk_LogicalDisk
+      fields:
+      - Name
+      - FreeMegabytes
+      - PercentFreeSpace
+      - CurrentDiskQueueLength
+      - DiskReadsPerSec
+      - DiskWritesPerSec
+      - DiskBytesPerSec
+      - PercentDiskReadTime
+      - PercentDiskWriteTime
+      - PercentDiskTime
+      whereclause: Name != "_Total"
+    - class: Win32_PerfFormattedData_PerfOS_Memory
+      fields:
+      - CommittedBytes
+      - AvailableBytes
+      - PercentCommittedBytesInUse
diff --git a/wmibeat.yml b/wmibeat.yml
@@ -4,7 +4,7 @@
 
 wmibeat:
   # Defines how often an event is sent to the output
-  period: 1s
+  period: 30s
 
   classes:
     - class: Win32_OperatingSystem
@@ -14,10 +14,24 @@ wmibeat:
       - FreeVirtualMemory
       - NumberOfProcesses
       - NumberOfUsers
-    - class: Win32_LogicalDisk
-      fields: 
-      - Caption
-      - FreeSpace
+    - class: Win32_PerfFormattedData_PerfDisk_LogicalDisk
+      fields:
+      - Name
+      - FreeMegabytes
+      - PercentFreeSpace
+      - CurrentDiskQueueLength
+      - DiskReadsPerSec
+      - DiskWritesPerSec
+      - DiskBytesPerSec
+      - PercentDiskReadTime
+      - PercentDiskWriteTime
+      - PercentDiskTime
+      whereclause: Name != "_Total"
+    - class: Win32_PerfFormattedData_PerfOS_Memory
+      fields:
+      - CommittedBytes
+      - AvailableBytes
+      - PercentCommittedBytesInUse
 
 ###############################################################################
 ############################# Libbeat Config ##################################