New module windows for metricbeat

metricbeat/include/list.go

@@ -69,6 +69,8 @@ import (
 	_ "github.com/elastic/beats/metricbeat/module/system/network"
 	_ "github.com/elastic/beats/metricbeat/module/system/process"
 	_ "github.com/elastic/beats/metricbeat/module/system/socket"
+	_ "github.com/elastic/beats/metricbeat/module/windows"
+	_ "github.com/elastic/beats/metricbeat/module/windows/perfmon"
 	_ "github.com/elastic/beats/metricbeat/module/zookeeper"
 	_ "github.com/elastic/beats/metricbeat/module/zookeeper/mntr"
 )

metricbeat/module/windows/_meta/config.yml

@@ -0,0 +1,5 @@
+#- module: windows
+#  metricsets: ["perfmon"]
+#  enabled: true
+#  period: 10s
+#  perfmon.counters:

metricbeat/module/windows/_meta/docs.asciidoc

@@ -0,0 +1,3 @@
+== windows Module
+
+This is the windows Module.

metricbeat/module/windows/_meta/fields.yml

@@ -0,0 +1,10 @@
+- key: windows
+  title: "Windows"
+  description: >
+    []beta
+    Module for Windows
+  fields:
+    - name: windows
+      type: group
+      description: >
+      fields:

metricbeat/module/windows/doc.go

@@ -0,0 +1,4 @@
+/*
+Package windows is a Metricbeat module that contains MetricSets.
+*/
+package windows

metricbeat/module/windows/perfmon/_meta/data.json

@@ -0,0 +1,19 @@
+{
+    "@timestamp":"2016-05-23T08:05:34.853Z",
+    "beat":{
+        "hostname":"beathost",
+        "name":"beathost"
+    },
+    "metricset":{
+        "host":"localhost",
+        "module":"mysql",
+        "name":"status",
+        "rtt":44269
+    },
+    "windows":{
+        "perfmon":{
+            "example": "perfmon"
+        }
+    },
+    "type":"metricsets"
+}

metricbeat/module/windows/perfmon/_meta/docs.asciidoc

@@ -0,0 +1,26 @@
+=== windows perfmon MetricSet
+
+This is the perfmon metricset of the module windows.
+
+[float]
+=== Features and configuration
+
+Metricset to collect performance counters.
+Example configuration:
+```
+- module: windows
+  metricsets: ["perfmon"]
+  enabled: true
+  period: 10s
+  perfmon.counters:
+    - group: "processor"  
+      collectors:
+        - alias: "processor_perfomance"
+          query: '\Processor Information(_Total)\% Processor Performance'
+        - alias: "processor_time"
+          query: '\Processor Information(_Total)\% Processor Time'
+    - group: "disk"
+      collectors:
+        - alias: "bytes_written"
+          query: '\FileSystem Disk Activity(_Total)\FileSystem Bytes Written'
+```

metricbeat/module/windows/perfmon/_meta/fields.yml

@@ -0,0 +1,26 @@
+- name: perfmon
+  type: group
+  fields:
+    - name: counters
+      type: group
+      description: >
+        Grouping of different counters
+      fields: 
+        - name: group
+          type: string
+          description: >
+            Name of the group. For example `processor` or `disk`
+
+        - name: collectors
+          type: group
+          fields:
+            - name: alias
+              type: string
+              description: >
+                Short form for the query
+
+            - name: query
+              type: string
+              description: >
+                The query. For example `\\Processor Information(_Total)\\% Processor Performance`. Backslashes have to be escaped.
+

metricbeat/module/windows/perfmon/defs_windows.go

@@ -0,0 +1,31 @@
+// +build ignore
+
+package perfmon
+
+/*
+#include <windows.h>
+#include <stdio.h>
+#include <conio.h>
+#include <pdh.h>
+#include <pdhmsg.h>
+#cgo LDFLAGS: -lpdh
+*/
+import "C"
+
+const (
+	ERROR_SUCCESS           = C.ERROR_SUCCESS
+	PDH_STATUS_VALID_DATA   = C.PDH_CSTATUS_VALID_DATA
+	PDH_STATUS_NEW_DATA     = C.PDH_CSTATUS_NEW_DATA
+	PDH_NO_DATA             = C.PDH_NO_DATA
+	PDH_STATUS_NO_OBJECT    = C.PDH_CSTATUS_NO_OBJECT
+	PDH_STATUS_NO_COUNTER   = C.PDH_CSTATUS_NO_COUNTER
+	PDH_STATUS_INVALID_DATA = C.PDH_CSTATUS_INVALID_DATA
+	PDH_INVALID_HANDLE      = C.PDH_INVALID_HANDLE
+	PDH_INVALID_DATA        = C.PDH_INVALID_DATA
+	PDH_NO_MORE_DATA        = C.PDH_NO_MORE_DATA
+	PdhFmtDouble            = C.PDH_FMT_DOUBLE
+	PdhFmtLarge             = C.PDH_FMT_LARGE
+	PdhFmtLong              = C.PDH_FMT_LONG
+)
+
+type PdhCounterValue C.PDH_FMT_COUNTERVALUE

metricbeat/module/windows/perfmon/defs_windows_386.go

@@ -0,0 +1,24 @@
+package perfmon
+
+const (
+	ERROR_SUCCESS           = 0x0
+	PDH_STATUS_VALID_DATA   = 0x0
+	PDH_STATUS_NEW_DATA     = 0x1
+	PDH_NO_DATA             = 0x800007d5
+	PDH_STATUS_NO_OBJECT    = 0xc0000bb8
+	PDH_STATUS_NO_COUNTER   = 0xc0000bb9
+	PDH_STATUS_INVALID_DATA = 0xc0000bba
+	PDH_INVALID_HANDLE      = 0xc0000bbc
+	PDH_INVALID_DATA        = 0xc0000bc6
+	PDH_NO_MORE_DATA        = 0xc0000bcc
+	PdhFmtDouble            = 0x00000200
+	PdhFmtLarge             = 0x00000400
+	PdhFmtLong              = 0x00000100
+)
+
+type PdhCounterValue struct {
+	CStatus   uint32
+	Pad_cgo_0 [4]byte
+	LongValue int32
+	Pad_cgo_1 [4]byte
+}

metricbeat/module/windows/perfmon/defs_windows_amd64.go

@@ -0,0 +1,24 @@
+package perfmon
+
+const (
+	ERROR_SUCCESS           = 0x0
+	PDH_STATUS_VALID_DATA   = 0x0
+	PDH_STATUS_NEW_DATA     = 0x1
+	PDH_NO_DATA             = 0x800007d5
+	PDH_STATUS_NO_OBJECT    = 0xc0000bb8
+	PDH_STATUS_NO_COUNTER   = 0xc0000bb9
+	PDH_STATUS_INVALID_DATA = 0xc0000bba
+	PDH_INVALID_HANDLE      = 0xc0000bbc
+	PDH_INVALID_DATA        = 0xc0000bc6
+	PDH_NO_MORE_DATA        = 0xc0000bcc
+	PdhFmtDouble            = 0x00000200
+	PdhFmtLarge             = 0x00000400
+	PdhFmtLong              = 0x00000100
+)
+
+type PdhCounterValue struct {
+	CStatus   uint32
+	Pad_cgo_0 [4]byte
+	LongValue int32
+	Pad_cgo_1 [4]byte
+}

metricbeat/module/windows/perfmon/pdh_windows.go

@@ -0,0 +1,120 @@
+package perfmon
+
+import (
+	"strconv"
+	"unsafe"
+
+	"time"
+
+	"github.com/elastic/beats/libbeat/common"
+)
+
+type Handle struct {
+	status      error
+	query       uintptr
+	counterType int
+	counters    []CounterGroup
+}
+
+type CounterGroup struct {
+	GroupName string
+	Counters  []Counter
+}
+
+type Counter struct {
+	counterName  string
+	counter      uintptr
+	counterPath  string
+	displayValue PdhCounterValue
+}
+
+var errorMapping = map[uint32]string{
+	PDH_INVALID_DATA:        `PDH_INVALID_DATA`,
+	PDH_INVALID_HANDLE:      `PDH_INVALID_HANDLE`,
+	PDH_NO_DATA:             `PDH_NO_DATA`,
+	PDH_NO_MORE_DATA:        `PDH_NO_MORE_DATA`,
+	PDH_STATUS_INVALID_DATA: `PDH_STATUS_INVALID_DATA`,
+	PDH_STATUS_NEW_DATA:     `PDH_STATUS_NEW_DATA`,
+	PDH_STATUS_NO_COUNTER:   `PDH_STATUS_NO_COUNTER`,
+	PDH_STATUS_NO_OBJECT:    `PDH_STATUS_NO_OBJECT`,
+}
+
+func GetHandle(config []CounterConfig) (*Handle, uint32) {
+	q := &Handle{}
+	err := _PdhOpenQuery(0, 0, &q.query)
+	if err != ERROR_SUCCESS {
+		return nil, err
+	}
+
+	counterGroups := make([]CounterGroup, len(config))
+	q.counters = counterGroups
+
+	for i, v := range config {
+		counterGroups[i] = CounterGroup{GroupName: v.Name, Counters: make([]Counter, len(v.Group))}
+		for j, v1 := range v.Group {
+			counterGroups[i].Counters[j] = Counter{counterName: v1.Alias, counterPath: v1.Query}
+			err := _PdhAddCounter(q.query, counterGroups[i].Counters[j].counterPath, 0, &counterGroups[i].Counters[j].counter)
+			if err != ERROR_SUCCESS {
+				return nil, err
+			}
+		}
+	}
+
+	return q, 0
+}
+
+func (q *Handle) ReadData(firstFetch bool) (common.MapStr, uint32) {
+
+	err := _PdhCollectQueryData(q.query)
+
+	if firstFetch {
+		// Most counters require two sample values in order to compute a displayable value. So wait and then collect the second value
+		time.Sleep(2000)
+		err = _PdhCollectQueryData(q.query)
+	}
+
+	if err != ERROR_SUCCESS {
+		return nil, err
+	}
+
+	result := common.MapStr{}
+
+	for _, v := range q.counters {
+		groupVal := make(map[string]interface{})
+		for _, v1 := range v.Counters {
+			err := _PdhGetFormattedCounterValue(v1.counter, PdhFmtDouble, q.counterType, &v1.displayValue)
+			if err != ERROR_SUCCESS {
+				return nil, err
+			}
+			doubleValue := (*float64)(unsafe.Pointer(&v1.displayValue.LongValue))
+			groupVal[v1.counterName] = *doubleValue
+
+		}
+		result[v.GroupName] = groupVal
+	}
+	return result, 0
+}
+
+func CloseQuery(q uintptr) uint32 {
+	err := _PdhCloseQuery(q)
+	if err != ERROR_SUCCESS {
+		return err
+	}
+
+	return 0
+}
+
+func GetError(err uint32) string {
+	if val, ok := errorMapping[err]; ok {
+		return val
+	}
+	return strconv.FormatUint(uint64(err), 10)
+}
+
+//go:generate go run $GOROOT/src/syscall/mksyscall_windows.go -output syscall_windows.go pdh.go
+// Windows API calls
+//sys   _PdhOpenQuery(dataSource uintptr, userData uintptr, query *uintptr) (err uint32) = pdh.PdhOpenQuery
+//sys   _PdhAddCounter(query uintptr, counterPath string, userData uintptr, counter *uintptr) (err uint32) = pdh.PdhAddEnglishCounterW
+//sys   _PdhCollectQueryData(query uintptr) (err uint32) = pdh.PdhCollectQueryData
+//sys   _PdhGetFormattedCounterValue(counter uintptr, format uint32, counterType int, value *PdhCounterValue) (err uint32) = pdh.PdhGetFormattedCounterValue
+//sys   _PdhCloseQuery(query uintptr) (err uint32) = pdh.PdhCloseQuery

metricbeat/module/windows/perfmon/pdh_windows_integration_test.go

@@ -0,0 +1,58 @@
+//+build integration windows
+
+package perfmon
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestExistingCounter(t *testing.T) {
+	config := make([]CounterConfig, 1)
+	config[0].Name = "process"
+	config[0].Group = make([]CounterConfigGroup, 1)
+	config[0].Group[0].Alias = "processor_performance"
+	config[0].Group[0].Query = "\\Processor Information(_Total)\\% Processor Performance"
+	handle, err := GetHandle(config)
+
+	assert.Empty(t, err)
+
+	err = CloseQuery(handle.query)
+
+	assert.Empty(t, err)
+}
+
+func TestNonExistingCounter(t *testing.T) {
+	config := make([]CounterConfig, 1)
+	config[0].Name = "process"
+	config[0].Group = make([]CounterConfigGroup, 1)
+	config[0].Group[0].Alias = "processor_performance"
+	config[0].Group[0].Query = "\\Processor Information(_Total)\\not existing counter"
+	handle, err := GetHandle(config)
+
+	assert.Equal(t, 3221228473, int(err))
+
+	if handle != nil {
+		err = CloseQuery(handle.query)
+
+		assert.Empty(t, err)
+	}
+}
+
+func TestNonExistingObject(t *testing.T) {
+	config := make([]CounterConfig, 1)
+	config[0].Name = "process"
+	config[0].Group = make([]CounterConfigGroup, 1)
+	config[0].Group[0].Alias = "processor_performance"
+	config[0].Group[0].Query = "\\non existing object\\% Processor Performance"
+	handle, err := GetHandle(config)
+
+	assert.Equal(t, 3221228472, int(err))
+
+	if handle != nil {
+		err = CloseQuery(handle.query)
+
+		assert.Empty(t, err)
+	}
+}