collector

package

v0.0.0-...-d251121 Latest Latest Go to latest Published: Nov 24, 2022 License: MIT Imports: 11 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/thegeeklab/audit-exporter

Documentation ¶

Index ¶

type ICollector
type Settings
type TrivyCollector
- func NewTrivyCollector(trivyClient client.TrivyClient, settings Settings, logger *logrus.Logger) *TrivyCollector

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ICollector ¶

type ICollector interface {
	Name() string
	Settings() Settings
	Scan(context.Context) error
	StartLoop(context.Context, time.Duration)
	Describe(ch chan<- *prometheus.Desc)
	Collect(ch chan<- prometheus.Metric)
}

ICollector defines the interface that need to be implemented by each collector

type Settings ¶

type Settings struct {
	ClientConcurrency int64
	LoopInterval      time.Duration
}

Settings defines the required collector settings

type TrivyCollector ¶

type TrivyCollector struct {
	Vulnerabilities    *prometheus.GaugeVec
	VulnerabilitiesSum *prometheus.GaugeVec
	// contains filtered or unexported fields
}

TrivyCollector defines the trivy collector instance

func NewTrivyCollector ¶

func NewTrivyCollector(
	trivyClient client.TrivyClient,
	settings Settings,
	logger *logrus.Logger,
) *TrivyCollector

NewTrivyCollector creates a new collector instance

func (*TrivyCollector) Collect ¶

func (c *TrivyCollector) Collect(ch chan<- prometheus.Metric)

Collect implements the prometheus colletor interface method

func (*TrivyCollector) Describe ¶

func (c *TrivyCollector) Describe(ch chan<- *prometheus.Desc)

Describe implements the prometheus colletor interface method

func (*TrivyCollector) Name ¶

func (c *TrivyCollector) Name() string

Name returns the collectors friendly name

func (*TrivyCollector) Scan ¶

func (c *TrivyCollector) Scan(ctx context.Context) error

Scan checks the discovered docker images in parallel and maps the results to prometheus metrics

func (*TrivyCollector) Settings ¶

func (c *TrivyCollector) Settings() Settings

Settings returns the collectors settings

func (*TrivyCollector) StartLoop ¶

func (c *TrivyCollector) StartLoop(ctx context.Context, interval time.Duration)

StartLoop re-schedules the next collectors run depending on the configured interval

Source Files ¶

View all Source files

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