Merge pull request #76 from NETWAYS/feature/add-mongo

Add collector for MongoDB

Author: martialblog

README.md

@@ -126,6 +126,17 @@ Module: `keepalived`
 
 See [modules/keepalived/collector.go](modules/keepalived/collector.go)
 
+### MongoDB
+
+Module: `mongodb`
+
+* MongoDB version
+* Package versions
+* Service status
+* Configuration from `/etc/mongod.conf`
+
+See [modules/mongodb/collector.go](modules/mongodb/collector.go) for details.
+
 ### MySQL
 
 Module: `mysql`

main.go

@@ -14,6 +14,7 @@ import (
 	"github.com/NETWAYS/support-collector/modules/icingaweb2"
 	"github.com/NETWAYS/support-collector/modules/influxdb"
 	"github.com/NETWAYS/support-collector/modules/keepalived"
+	"github.com/NETWAYS/support-collector/modules/mongodb"
 	"github.com/NETWAYS/support-collector/modules/mysql"
 	"github.com/NETWAYS/support-collector/modules/postgresql"
 	"github.com/NETWAYS/support-collector/modules/puppet"
@@ -58,6 +59,7 @@ var modules = map[string]func(*collection.Collection){
 	"icinga-director": icingadirector.Collect,
 	"corosync":        corosync.Collect,
 	"keepalived":      keepalived.Collect,
+	"mongodb":         mongodb.Collect,
 	"mysql":           mysql.Collect,
 	"influxdb":        influxdb.Collect,
 	"postgresql":      postgresql.Collect,
@@ -78,6 +80,7 @@ var (
 		"icingadb",
 		"corosync",
 		"keepalived",
+		"mongodb",
 		"mysql",
 		"influxdb",
 		"postgresql",

modules/mongodb/collector.go

@@ -0,0 +1,76 @@
+package mongodb
+
+import (
+	"github.com/NETWAYS/support-collector/pkg/collection"
+	"github.com/NETWAYS/support-collector/pkg/obfuscate"
+	"os"
+	"path/filepath"
+)
+
+const ModuleName = "mongodb"
+
+var relevantPaths = []string{
+	"/etc/mongod.conf",
+}
+
+var possibleDaemons = []string{
+	"/usr/lib/systemd/system/mongod.service",
+	"/lib/systemd/system/mongod.service",
+}
+
+var services = []string{
+	"mongod",
+}
+
+var files = []string{
+	"/etc/mongod.conf",
+}
+
+var commands = map[string][]string{
+	"mongod-version.txt": {"mongod", "--version"},
+	"mongo-version.txt":  {"mongo", "--version"},
+}
+
+var obfuscators = []*obfuscate.Obfuscator{
+	obfuscate.NewFile(`(?i)(?:password).*\s*:\s*(.*)`, `conf`),
+}
+
+func Detect() bool {
+	for _, path := range relevantPaths {
+		_, err := os.Stat(path)
+		if err == nil {
+			return true
+		}
+	}
+
+	return false
+}
+
+func Collect(c *collection.Collection) {
+	if !Detect() {
+		c.Log.Info("Could not find mongodb")
+		return
+	}
+
+	c.Log.Info("Collecting mongodb information")
+
+	c.RegisterObfuscators(obfuscators...)
+
+	for _, file := range files {
+		c.AddFiles(ModuleName, file)
+	}
+
+	for _, file := range possibleDaemons {
+		c.AddFilesIfFound(ModuleName, file)
+	}
+
+	c.AddInstalledPackagesRaw(filepath.Join(ModuleName, "packages.txt"), "*mongo*")
+
+	for _, service := range services {
+		c.AddServiceStatusRaw(filepath.Join(ModuleName, "service-"+service+".txt"), service)
+	}
+
+	for name, cmd := range commands {
+		c.AddCommandOutput(filepath.Join(ModuleName, name), cmd[0], cmd[1:]...)
+	}
+}

modules/mongodb/collector_test.go

@@ -0,0 +1,21 @@
+package mongodb
+
+import (
+	"bytes"
+	"github.com/NETWAYS/support-collector/pkg/collection"
+	"github.com/NETWAYS/support-collector/pkg/obfuscate"
+	"github.com/NETWAYS/support-collector/pkg/util"
+	"testing"
+)
+
+func TestCollect(t *testing.T) {
+	c := collection.New(&bytes.Buffer{})
+
+	Collect(c)
+}
+
+func TestObfuscators(t *testing.T) {
+	util.AssertObfuscationExample(t, obfuscators, obfuscate.KindFile, "/etc/mongod.conf")
+
+	util.AssertAllObfuscatorsTested(t, obfuscators)
+}

modules/mongodb/testdata/etc/mongod.conf

@@ -0,0 +1,38 @@
+#System Log
+
+systemLog.path: /var/log/mongodb/mongod.log
+systemLog.destination: file
+systemLog.logAppend: true
+systemLog.quiet: false
+
+#Process Management
+processManagement:
+  pidFilePath: /var/run/mongodb/mongod.pid
+
+#Storage
+storage.dbPath: /var/lib/mongodb
+storage.journal.enabled: true
+
+#Security
+security.authorization: disabled
+security.example.fooPassword: <string>
+
+#Net
+net:
+   port: <int>
+   bindIp: <string>
+   bindIpAll: <boolean>
+   maxIncomingConnections: <int>
+   wireObjectCheck: <boolean>
+   ipv6: <boolean>
+   unixDomainSocket:
+      enabled: <boolean>
+   tls:
+      certificateKeyFilePassword: <string>
+      clusterPassword: <string>
+
+#Replication
+
+#Sharding
+
+#Operation Profiling

modules/mongodb/testdata/etc/mongod.conf.obfuscated

@@ -0,0 +1,38 @@
+#System Log
+
+systemLog.path: /var/log/mongodb/mongod.log
+systemLog.destination: file
+systemLog.logAppend: true
+systemLog.quiet: false
+
+#Process Management
+processManagement:
+  pidFilePath: /var/run/mongodb/mongod.pid
+
+#Storage
+storage.dbPath: /var/lib/mongodb
+storage.journal.enabled: true
+
+#Security
+security.authorization: disabled
+security.example.fooPassword: <HIDDEN>
+
+#Net
+net:
+   port: <int>
+   bindIp: <string>
+   bindIpAll: <boolean>
+   maxIncomingConnections: <int>
+   wireObjectCheck: <boolean>
+   ipv6: <boolean>
+   unixDomainSocket:
+      enabled: <boolean>
+   tls:
+      certificateKeyFilePassword: <HIDDEN>
+      clusterPassword: <HIDDEN>
+
+#Replication
+
+#Sharding
+
+#Operation Profiling