metrics

package

v1.4.1 Latest Latest Go to latest Published: Apr 1, 2024 License: Apache-2.0 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/ComplianceAsCode/compliance-operator

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type ControllerMetrics
- func DefaultControllerMetrics() *ControllerMetrics
type Metrics
- func New() *Metrics
- func NewMetrics(imp impl) *Metrics

Constants ¶

View Source

const (
	HandlerPath                  = "/metrics-co"
	ControllerMetricsServiceName = "metrics-co"
	ControllerMetricsPort        = 8585
	MetricsAddrListen            = ":8585"
)

View Source

const (
	METRIC_STATE_COMPLIANT = iota
	METRIC_STATE_NON_COMPLIANT
	METRIC_STATE_INCONSISTENT
	METRIC_STATE_ERROR
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ControllerMetrics ¶

type ControllerMetrics struct {
	// contains filtered or unexported fields
}

func DefaultControllerMetrics ¶

func DefaultControllerMetrics() *ControllerMetrics

type Metrics ¶

type Metrics struct {
	// contains filtered or unexported fields
}

Metrics is the main structure of this package.

func New ¶

func New() *Metrics

New returns a new default Metrics instance.

func NewMetrics ¶

func NewMetrics(imp impl) *Metrics

func (*Metrics) IncComplianceRemediationStatus ¶

func (m *Metrics) IncComplianceRemediationStatus(name string, status v1alpha1.ComplianceRemediationStatus)

IncComplianceRemediationStatus increments the ComplianceRemediation status counter

func (*Metrics) IncComplianceScanStatus ¶

func (m *Metrics) IncComplianceScanStatus(name string, status v1alpha1.ComplianceScanStatus)

IncComplianceScanStatus also increments error if necessary

func (*Metrics) Register ¶

func (m *Metrics) Register() error

Register iterates over all available metrics and registers them.

func (*Metrics) SetComplianceStateError ¶

func (m *Metrics) SetComplianceStateError(name string)

SetComplianceStateError sets the compliance_state gauge to 3.

func (*Metrics) SetComplianceStateInCompliance ¶

func (m *Metrics) SetComplianceStateInCompliance(name string)

SetComplianceStateInCompliance sets the compliance_state gauge to 0.

func (*Metrics) SetComplianceStateInconsistent ¶

func (m *Metrics) SetComplianceStateInconsistent(name string)

SetComplianceStateInconsistent sets the compliance_state gauge to 2.

func (*Metrics) SetComplianceStateOutOfCompliance ¶

func (m *Metrics) SetComplianceStateOutOfCompliance(name string)

SetComplianceStateOutOfCompliance sets the compliance_state gauge to 1.

func (*Metrics) Start ¶

func (m *Metrics) Start(ctx context.Context) error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
metricsfakes Code generated by counterfeiter.	Code generated by counterfeiter.

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