options.go

/*
Copyright 2018 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 options

import (
	"flag"

	"github.com/spf13/pflag"
)

func NewLogCounterOptions() *LogCounterOptions {
	return &LogCounterOptions{}
}

// LogCounterOptions contains frequent event detector command line and application options.
type LogCounterOptions struct {
	// command line options. See flag descriptions for the description
	JournaldSource string
	LogPath        string
	Lookback       string
	Delay          string
	Pattern        string
	RevertPattern  string
	Count          int
}

// AddFlags adds log counter command line options to pflag.
func (fedo *LogCounterOptions) AddFlags(fs *pflag.FlagSet) {
	fs.StringVar(&fedo.JournaldSource, "journald-source", "", "The source configuration of journald, e.g., kernel, kubelet, etc")
	fs.StringVar(&fedo.LogPath, "log-path", "", "The log path that log watcher looks up")
	fs.StringVar(&fedo.Lookback, "lookback", "", "The time log watcher looks up")
	fs.StringVar(&fedo.Delay, "delay", "",
		"The time duration log watcher delays after node boot time. This is useful when log watcher needs to wait for some time until the node is stable.")
	fs.StringVar(&fedo.Pattern, "pattern", "",
		"The regular expression to match the problem in log. The pattern must match to the end of the line.")
	fs.StringVar(&fedo.RevertPattern, "revert-pattern", "",
		"Similar to --pattern but conversely it decreases count value for every match. This is useful to discount a log when another log occurs.")
	fs.IntVar(&fedo.Count, "count", 1,
		"The number of times the pattern must be found to trigger the condition")
}

func init() {
	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
}