options

package

v0.0.4 Latest Latest Go to latest Published: Apr 1, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/AthennaMind/opnsense-exporter

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Init()
func Logger() (log.Logger, error)
type CollectorsDisableSwitch
- func CollectorsSwitches() CollectorsDisableSwitch
type OPNSenseConfig
- func OPNSense() (*OPNSenseConfig, error)
- func (c *OPNSenseConfig) Validate() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	MetricsPath = kingpin.Flag(
		"web.telemetry-path",
		"Path under which to expose metrics.",
	).Default("/metrics").String()
	DisableExporterMetrics = kingpin.Flag(
		"web.disable-exporter-metrics",
		"Exclude metrics about the exporter itself (promhttp_*, process_*, go_*).",
	).Envar("OPNSENSE_EXPORTER_DISABLE_EXPORTER_METRICS").Bool()
	MaxProcs = kingpin.Flag(
		"runtime.gomaxprocs",
		"The target number of CPUs that the Go runtime will run on (GOMAXPROCS)",
	).Envar("GOMAXPROCS").Default("2").Int()
	InstanceLabel = kingpin.Flag(
		"exporter.instance-label",
		"Label to use to identify the instance in every metric. "+
			"If you have multiple instances of the exporter, you can differentiate them by using "+
			"different value in this flag, that represents the instance of the target OPNsense.",
	).Envar("OPNSENSE_EXPORTER_INSTANCE_LABEL").Required().String()

	WebConfig = kingpinflag.AddFlags(kingpin.CommandLine, ":8080")
)

Functions ¶

func Init ¶

func Init()

func Logger ¶

func Logger() (log.Logger, error)

Types ¶

type CollectorsDisableSwitch ¶

type CollectorsDisableSwitch struct {
	ARP       bool
	Cron      bool
	Wireguard bool
	Unbound   bool
}

CollectorsDisableSwitch hold the enabled/disabled state of the collectors

func CollectorsSwitches ¶

func CollectorsSwitches() CollectorsDisableSwitch

CollectorsSwitches returns configured instances of CollectorsDisableSwitch

type OPNSenseConfig ¶

type OPNSenseConfig struct {
	Protocol  string
	Host      string
	APIKey    string
	APISecret string
	Insecure  bool
}

OPNSenseConfig holds the configuration for the OPNsense API.

func OPNSense ¶

func OPNSense() (*OPNSenseConfig, error)

func (*OPNSenseConfig) Validate ¶

func (c *OPNSenseConfig) Validate() error

Validate checks if the configuration is valid. returns an error on any missing value

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL