Adding stackdriver exporter

Makefile

@@ -41,7 +41,7 @@ PKG:=k8s.io/node-problem-detector
 PKG_SOURCES:=$(shell find pkg cmd -name '*.go')
 
 # TARBALL is the name of release tar. Include binary version by default.
-TARBALL:=node-problem-detector-$(VERSION).tar.gz
+TARBALL?=node-problem-detector-$(VERSION).tar.gz
 
 # IMAGE is the image name of the node problem detector container image.
 IMAGE:=$(REGISTRY)/node-problem-detector:$(TAG)

cmd/nodeproblemdetector/exporterplugins/default_plugin.go

@@ -0,0 +1,20 @@
+/*
+Copyright 2019 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package exporterplugins
+
+// This file is necessary to make sure the exporterplugins package non-empty
+// under any build tags.

cmd/nodeproblemdetector/exporterplugins/stackdriver_exporter_plugin.go

@@ -0,0 +1,25 @@
+// +build !disable_stackdriver_exporter
+
+/*
+Copyright 2019 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package exporterplugins
+
+import (
+	_ "k8s.io/node-problem-detector/pkg/exporters/stackdriver"
+)
+
+// The stackdriver plugin takes about 6MB in the NPD binary.

cmd/nodeproblemdetector/node_problem_detector.go

@@ -22,8 +22,10 @@ import (
 	"github.com/golang/glog"
 	"github.com/spf13/pflag"
 
+	_ "k8s.io/node-problem-detector/cmd/nodeproblemdetector/exporterplugins"
 	_ "k8s.io/node-problem-detector/cmd/nodeproblemdetector/problemdaemonplugins"
 	"k8s.io/node-problem-detector/cmd/options"
+	"k8s.io/node-problem-detector/pkg/exporters"
 	"k8s.io/node-problem-detector/pkg/exporters/k8sexporter"
 	"k8s.io/node-problem-detector/pkg/exporters/prometheusexporter"
 	"k8s.io/node-problem-detector/pkg/problemdaemon"
@@ -54,21 +56,25 @@ func main() {
 	}
 
 	// Initialize exporters.
-	exporters := []types.Exporter{}
+	initializedExporters := []types.Exporter{}
 	if ke := k8sexporter.NewExporterOrDie(npdo); ke != nil {
-		exporters = append(exporters, ke)
+		initializedExporters = append(initializedExporters, ke)
 		glog.Info("K8s exporter started.")
 	}
 	if pe := prometheusexporter.NewExporterOrDie(npdo); pe != nil {
-		exporters = append(exporters, pe)
+		initializedExporters = append(initializedExporters, pe)
 		glog.Info("Prometheus exporter started.")
 	}
-	if len(exporters) == 0 {
+	plugableExporters := exporters.NewExporters()
+	if len(plugableExporters) != 0 {
+		initializedExporters = append(initializedExporters, plugableExporters...)
+	}
+	if len(initializedExporters) == 0 {
 		glog.Fatalf("No exporter is successfully setup")
 	}
 
 	// Initialize NPD core.
-	p := problemdetector.NewProblemDetector(problemDaemons, exporters)
+	p := problemdetector.NewProblemDetector(problemDaemons, initializedExporters)
 	if err := p.Run(); err != nil {
 		glog.Fatalf("Problem detector failed with error: %v", err)
 	}

cmd/options/options.go

@@ -26,6 +26,7 @@ import (
 
 	"github.com/spf13/pflag"
 
+	"k8s.io/node-problem-detector/pkg/exporters"
 	"k8s.io/node-problem-detector/pkg/problemdaemon"
 	"k8s.io/node-problem-detector/pkg/types"
 )
@@ -86,6 +87,7 @@ type NodeProblemDetectorOptions struct {
 
 func NewNodeProblemDetectorOptions() *NodeProblemDetectorOptions {
 	npdo := &NodeProblemDetectorOptions{MonitorConfigPaths: types.ProblemDaemonConfigPathMap{}}
+
 	for _, problemDaemonName := range problemdaemon.GetProblemDaemonNames() {
 		npdo.MonitorConfigPaths[problemDaemonName] = &[]string{}
 	}
@@ -118,6 +120,10 @@ func (npdo *NodeProblemDetectorOptions) AddFlags(fs *pflag.FlagSet) {
 	fs.StringVar(&npdo.PrometheusServerAddress, "prometheus-address",
 		"127.0.0.1", "The address to bind the Prometheus scrape endpoint.")
 
+	for _, exporterName := range exporters.GetExporterNames() {
+		exporterHandler := exporters.GetExporterHandlerOrDie(exporterName)
+		exporterHandler.Options.SetFlags(fs)
+	}
 	for _, problemDaemonName := range problemdaemon.GetProblemDaemonNames() {
 		fs.StringSliceVar(
 			npdo.MonitorConfigPaths[problemDaemonName],

config/exporter/stackdriver-exporter.json

@@ -0,0 +1,8 @@
+{
+	"apiEndpoint": "monitoring.googleapis.com:443",
+	"exportPeriod": "60s",
+	"metadataFetchTimeout": "600s",
+	"metadataFetchInterval": "10s",
+	"panicOnMetadataFetchFailure": false,
+	"customMetricPrefix": ""
+}

config/systemd/node-problem-detector-metric-only.service

@@ -1,12 +1,13 @@
 [Unit]
 Description=Node problem detector
-Wants=local-fs.target
-After=local-fs.target
+Wants=network-online.target
+After=network-online.target
 
 [Service]
 Restart=always
 RestartSec=10
 ExecStart=/home/kubernetes/bin/node-problem-detector --v=2 --logtostderr --enable-k8s-exporter=false \
+          --exporter.stackdriver=/home/kubernetes/node-problem-detector/config/exporter/stackdriver-exporter.json \
           --config.system-log-monitor=/home/kubernetes/node-problem-detector/config/kernel-monitor.json,/home/kubernetes/node-problem-detector/config/docker-monitor.json,/home/kubernetes/node-problem-detector/config/systemd-monitor.json \
           --config.custom-plugin-monitor=/home/kubernetes/node-problem-detector/config/kernel-monitor-counter.json,/home/kubernetes/node-problem-detector/config/systemd-monitor-counter.json \
           --config.system-stats-monitor=/home/kubernetes/node-problem-detector/config/system-stats-monitor.json          

pkg/exporters/register.go

@@ -0,0 +1,63 @@
+/*
+Copyright 2019 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package exporters
+
+import (
+	"fmt"
+
+	"k8s.io/node-problem-detector/pkg/types"
+)
+
+var (
+	handlers = make(map[types.ExporterType]types.ExporterHandler)
+)
+
+// Register registers a exporter factory method, which will be used to create the exporter.
+func Register(exporterType types.ExporterType, handler types.ExporterHandler) {
+	handlers[exporterType] = handler
+}
+
+// GetExporterNames retrieves all available exporter types.
+func GetExporterNames() []types.ExporterType {
+	exporterTypes := []types.ExporterType{}
+	for exporterType := range handlers {
+		exporterTypes = append(exporterTypes, exporterType)
+	}
+	return exporterTypes
+}
+
+// GetExporterHandlerOrDie retrieves the ExporterHandler for a specific type of exporter, panic if error occurs..
+func GetExporterHandlerOrDie(exporterType types.ExporterType) types.ExporterHandler {
+	handler, ok := handlers[exporterType]
+	if !ok {
+		panic(fmt.Sprintf("Exporter handler for %v does not exist", exporterType))
+	}
+	return handler
+}
+
+// NewExporters creates all exporters based on the configurations initialized.
+func NewExporters() []types.Exporter {
+	exporters := []types.Exporter{}
+	for _, handler := range handlers {
+		exporter := handler.CreateExporterOrDie(handler.Options)
+		if exporter == nil {
+			continue
+		}
+		exporters = append(exporters, exporter)
+	}
+	return exporters
+}

pkg/exporters/register_test.go

@@ -0,0 +1,69 @@
+/*
+Copyright 2019 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package exporters
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"k8s.io/node-problem-detector/pkg/types"
+)
+
+func TestRegistration(t *testing.T) {
+	fooExporterFactory := func(types.CommandLineOptions) types.Exporter {
+		return nil
+	}
+	fooExporterHandler := types.ExporterHandler{
+		CreateExporterOrDie: fooExporterFactory,
+		Options:             nil,
+	}
+
+	barExporterFactory := func(types.CommandLineOptions) types.Exporter {
+		return nil
+	}
+	barExporterHandler := types.ExporterHandler{
+		CreateExporterOrDie: barExporterFactory,
+		Options:             nil,
+	}
+
+	Register("foo", fooExporterHandler)
+	Register("bar", barExporterHandler)
+
+	expectedExporterNames := []types.ExporterType{"foo", "bar"}
+	exporterNames := GetExporterNames()
+	assert.ElementsMatch(t, expectedExporterNames, exporterNames)
+
+	handlers = make(map[types.ExporterType]types.ExporterHandler)
+}
+
+func TestGetExporterHandlerOrDie(t *testing.T) {
+	fooExporterFactory := func(types.CommandLineOptions) types.Exporter {
+		return nil
+	}
+	fooExporterHandler := types.ExporterHandler{
+		CreateExporterOrDie: fooExporterFactory,
+		Options:             nil,
+	}
+
+	Register("foo", fooExporterHandler)
+
+	assert.NotPanics(t, func() { GetExporterHandlerOrDie("foo") })
+	assert.Panics(t, func() { GetExporterHandlerOrDie("bar") })
+
+	handlers = make(map[types.ExporterType]types.ExporterHandler)
+}

pkg/exporters/stackdriver/config/config.go

@@ -0,0 +1,56 @@
+/*
+Copyright 2019 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package config
+
+import (
+	"time"
+
+	"k8s.io/node-problem-detector/pkg/exporters/stackdriver/gce"
+)
+
+var (
+	defaultExportPeriod          = (60 * time.Second).String()
+	defaultEndpoint              = "monitoring.googleapis.com:443"
+	defaultMetadataFetchTimeout  = (600 * time.Second).String()
+	defaultMetadataFetchInterval = (10 * time.Second).String()
+)
+
+type StackdriverExporterConfig struct {
+	ExportPeriod                string       `json:"exportPeriod"`
+	APIEndpoint                 string       `json:"apiEndpoint"`
+	GCEMetadata                 gce.Metadata `json:"gceMetadata"`
+	MetadataFetchTimeout        string       `json:"metadataFetchTimeout"`
+	MetadataFetchInterval       string       `json:"metadataFetchInterval"`
+	PanicOnMetadataFetchFailure bool         `json:"panicOnMetadataFetchFailure"`
+	CustomMetricPrefix          string       `json:"customMetricPrefix"`
+}
+
+// ApplyConfiguration applies default configurations.
+func (sec *StackdriverExporterConfig) ApplyConfiguration() {
+	if sec.ExportPeriod == "" {
+		sec.ExportPeriod = defaultExportPeriod
+	}
+	if sec.MetadataFetchTimeout == "" {
+		sec.MetadataFetchTimeout = defaultMetadataFetchTimeout
+	}
+	if sec.MetadataFetchInterval == "" {
+		sec.MetadataFetchInterval = defaultMetadataFetchInterval
+	}
+	if sec.APIEndpoint == "" {
+		sec.APIEndpoint = defaultEndpoint
+	}
+}