Merge pull request #39 from Random-Liu/journald-support

Journald support

Author: dchen1107

.gitignore

@@ -1 +1,2 @@
 /bin/node-problem-detector
+/Dockerfile

Dockerfile renamed to Dockerfile.in

@@ -12,8 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FROM alpine:3.4
+FROM @BASEIMAGE@
 MAINTAINER Random Liu <[email protected]>
+
+# Avoid symlink of /etc/localtime.
+RUN test -h /etc/localtime && rm -f /etc/localtime && cp /usr/share/zoneinfo/UTC /etc/localtime || true
+
 ADD ./bin/node-problem-detector /node-problem-detector
 ADD config /config
 ENTRYPOINT ["/node-problem-detector", "--kernel-monitor=/config/kernel-monitor.json"]

Godeps/Godeps.json

@@ -1,24 +1,73 @@
-.PHONY: all build-container build-tar build push-container push-tar push clean vet fmt version
+# Copyright 2017 The Kubernetes Authors.
+#
+# 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.
+
+# Build the node-problem-detector image.
+
+.PHONY: all build-container build-tar build push-container push-tar push clean vet fmt version Dockerfile
 
 all: build
 
-VERSION := $(shell git describe --tags --dirty)
+# VERSION is the version of the binary.
+VERSION:=$(shell git describe --tags --dirty)
 
-TAG ?= $(VERSION)
+# TAG is the tag of the container image, default to binary version.
+TAG?=$(VERSION)
 
-UPLOAD_PATH ?= gs://kubernetes-release
+# PROJ is the image project.
+PROJ?=gcr.io/google_containers
+
+# UPLOAD_PATH is the cloud storage path to upload release tar.
+UPLOAD_PATH?=gs://kubernetes-release
 # Trim the trailing '/' in the path
-UPLOAD_PATH := $(shell echo $(UPLOAD_PATH) | sed '$$s/\/*$$//')
+UPLOAD_PATH:=$(shell echo $(UPLOAD_PATH) | sed '$$s/\/*$$//')
+
+# PKG is the package name of node problem detector repo.
+PKG:=k8s.io/node-problem-detector
+
+# PKG_SOURCES are all the go source code.
+PKG_SOURCES:=$(shell find pkg cmd -name '*.go')
 
-PROJ ?= google_containers
+# TARBALL is the name of release tar. Include binary version by default.
+TARBALL:=node-problem-detector-$(VERSION).tar.gz
 
-PKG := k8s.io/node-problem-detector
+# IMAGE is the image name of the node problem detector container image.
+IMAGE:=$(PROJ)/node-problem-detector:$(TAG)
 
-PKG_SOURCES := $(shell find pkg cmd -name '*.go')
+# ENABLE_JOURNALD enables build journald support or not. Building journald support needs libsystemd-dev
+# or libsystemd-journal-dev.
+# TODO(random-liu): Build NPD inside container.
+ENABLE_JOURNALD?=1
 
-TARBALL := node-problem-detector-$(VERSION).tar.gz
+# TODO(random-liu): Support different architectures.
+BASEIMAGE:=alpine:3.4
 
-IMAGE := gcr.io/$(PROJ)/node-problem-detector:$(TAG)
+# Disable cgo by default to make the binary statically linked.
+CGO_ENABLED:=0
+
+# NOTE that enable journald will increase the image size.
+ifeq ($(ENABLE_JOURNALD), 1)
+	# Enable journald build tag.
+	BUILD_TAGS:=-tags journald
+	# Use fedora because it has newer systemd version (229) and support +LZ4. +LZ4 is needed
+	# on some os distros such as GCI.
+	BASEIMAGE:=fedora
+	# Enable cgo because sdjournal needs cgo to compile. The binary will be dynamically
+	# linked if CGO_ENABLED is enabled. This is fine because fedora already has necessary
+	# dynamic library. We can not use `-extldflags "-static"` here, because go-systemd uses
+	# dlopen, and dlopen will not work properly in a statically linked application.
+	CGO_ENABLED:=1
+endif
 
 vet:
 	go list ./... | grep -v "./vendor/*" | xargs go vet
@@ -30,14 +79,17 @@ version:
 	@echo $(VERSION)
 
 ./bin/node-problem-detector: $(PKG_SOURCES)
-	GOOS=linux go build -o bin/node-problem-detector \
-	     -ldflags '-w -extldflags "-static" -X $(PKG)/pkg/version.version=$(VERSION)' \
-	     cmd/node_problem_detector.go
+	CGO_ENABLED=$(CGO_ENABLED) GOOS=linux go build -o bin/node-problem-detector \
+	     -ldflags '-w -X $(PKG)/pkg/version.version=$(VERSION)' \
+	     $(BUILD_TAGS) cmd/node_problem_detector.go
+
+Dockerfile: Dockerfile.in
+	sed -e 's|@BASEIMAGE@|$(BASEIMAGE)|g' $< >$@
 
 test: vet fmt
-	go test -timeout=1m -v -race ./pkg/...
+	go test -timeout=1m -v -race ./pkg/... $(BUILD_TAGS)
 
-build-container: ./bin/node-problem-detector
+build-container: ./bin/node-problem-detector Dockerfile
 	docker build -t $(IMAGE) .
 
 build-tar: ./bin/node-problem-detector

Makefile

@@ -100,11 +100,17 @@ spec:
         - name: log
           mountPath: /log
           readOnly: true
+        - name: localtime
+          mountPath: /etc/localtime
+          readOnly: true
       volumes:
       - name: log
         # Config `log` to your system log directory
         hostPath:
           path: /var/log/
+      - name: localtime
+        hostPath:
+          path: /etc/localtime
 ```
 * Edit node-problem-detector.yaml to fit your environment: Set `log` volume to your system log diretory. (Used by KernelMonitor)
 * Create the DaemonSet with `kubectl create -f node-problem-detector.yaml`

README.md

@@ -18,15 +18,15 @@ package main
 
 import (
 	"flag"
+	"fmt"
 	"net/url"
 	"os"
 
+	"github.com/golang/glog"
+
 	"k8s.io/node-problem-detector/pkg/kernelmonitor"
 	"k8s.io/node-problem-detector/pkg/problemdetector"
 	"k8s.io/node-problem-detector/pkg/version"
-
-	"github.com/golang/glog"
-	"fmt"
 )
 
 // TODO: Move flags to options directory.
@@ -86,5 +86,7 @@ func main() {
 
 	k := kernelmonitor.NewKernelMonitorOrDie(*kernelMonitorConfigPath)
 	p := problemdetector.NewProblemDetector(k, *apiServerOverride, nodeName)
-	p.Run()
+	if err := p.Run(); err != nil {
+		glog.Fatalf("Problem detector failed with error: %v", err)
+	}
 }

cmd/node_problem_detector.go

@@ -1,5 +1,6 @@
 {
-	"logPath": "/log/kern.log",
+	"plugin": "journald",
+	"logPath": "/var/log/journal",
 	"lookback": "10m",
 	"startPattern": "Initializing cgroup subsys cpuset",
 	"bufferSize": 10,

config/kernel-monitor.json

@@ -12,6 +12,7 @@ spec:
       - name: node-problem-detector
         command:
         - /node-problem-detector
+        - --logtostderr
         - --kernel-monitor=/config/kernel-monitor.json
         image: gcr.io/google_containers/node-problem-detector:v0.2
         imagePullPolicy: Always
@@ -24,7 +25,12 @@ spec:
               fieldPath: spec.nodeName
         volumeMounts:
         - name: log
-          mountPath: /log
+          mountPath: /var/log
+          readOnly: true
+        # Make sure node problem detector is in the same timezone
+        # with the host.
+        - name: localtime
+          mountPath: /etc/localtime
           readOnly: true
         - name: config
           mountPath: /config
@@ -34,6 +40,9 @@ spec:
         # Config `log` to your system log directory
         hostPath:
           path: /var/log/
+      - name: localtime
+        hostPath:
+          path: /etc/localtime
       - name: config
         configMap:
           name: node-problem-detector-config

node-problem-detector.yaml

@@ -9,12 +9,8 @@ The rule list is extensible.
 
 ## Limitations
 
-* Kernel Monitor only supports file based kernel log now. It doesn't support log tools
-like journald. There is an [open issue](https://github.com/kubernetes/node-problem-detector/issues/14)
-to add journald support.
-
-* Kernel Monitor has assumption on kernel log format, now it only works on Ubuntu and
-Debian. However, it is easy to extend it to [support other log format](#support-other-log-format).
+* Kernel Monitor only supports syslog (rsyslog) and journald now, but it is easy
+  to extend it with [new log watcher](#new-log-watcher)
 
 ## Add New NodeConditions
 
@@ -43,14 +39,23 @@ with new rule definition:
 }
 ```
 
-## Change Log Path
+## Log Watchers
+
+Kernel monitor supports different log management tools with different log
+watchers:
+* [syslog](https://github.com/kubernetes/node-problem-detector/blob/master/pkg/kernelmonitor/logwatchers/syslog)
+* [journald](https://github.com/kubernetes/node-problem-detector/blob/master/pkg/kernelmonitor/logwatchers/journald)
+
+### Change Log Path
 
-Kernel log in different OS distros may locate in different path. The `log`
+Kernel log on different OS distros may locate in different path. The `logPath`
 field in `config/kernel-monitor.json` is the log path inside the container.
-You can always configure it to match your OS distro.
+You can always configure `logPath` and volume mount to match your OS distro.
+* syslog: `logPath` is the kernel log path, usually `/var/log/kern.log`.
+* journald: `logPath` is the journal log directory, usually `/var/log/journal`.
 
-## Support Other Log Format
+### New Log Watcher
 
-Kernel monitor uses [`Translator`](https://github.com/kubernetes/node-problem-detector/blob/master/pkg/kernelmonitor/translator/translator.go)
-plugin to translate kernel log the internal data structure. It is easy to
-implement a new translator for a new log format.
+Kernel monitor uses [Log
+Watcher](https://github.com/kubernetes/node-problem-detector/blob/master/pkg/kernelmonitor/logwatchers/types/log_watcher.go) to support different log management tools.
+It is easy to implement a new log watcher.

pkg/kernelmonitor/README.md

@@ -0,0 +1,49 @@
+/*
+Copyright 2016 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 kernelmonitor
+
+import (
+	watchertypes "k8s.io/node-problem-detector/pkg/kernelmonitor/logwatchers/types"
+	kerntypes "k8s.io/node-problem-detector/pkg/kernelmonitor/types"
+	"k8s.io/node-problem-detector/pkg/types"
+)
+
+// MonitorConfig is the configuration of kernel monitor.
+type MonitorConfig struct {
+	// WatcherConfig is the configuration of kernel log watcher.
+	watchertypes.WatcherConfig
+	// BufferSize is the size (in lines) of the log buffer.
+	BufferSize int `json:"bufferSize"`
+	// Source is the source name of the kernel monitor
+	Source string `json:"source"`
+	// DefaultConditions are the default states of all the conditions kernel monitor should handle.
+	DefaultConditions []types.Condition `json:"conditions"`
+	// Rules are the rules kernel monitor will follow to parse the log file.
+	Rules []kerntypes.Rule `json:"rules"`
+	// StartPattern is the pattern of the start line
+	StartPattern string `json:"startPattern, omitempty"`
+}
+
+// applyDefaultConfiguration applies default configurations.
+func applyDefaultConfiguration(cfg *MonitorConfig) {
+	if cfg.BufferSize == 0 {
+		cfg.BufferSize = 10
+	}
+	if cfg.WatcherConfig.Lookback == "" {
+		cfg.WatcherConfig.Lookback = "0"
+	}
+}