service_monitor

package
v1.12.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

Service Monitor Plugin

The rigdev.service_monitor plugin spawns a Prometheus ServiceMonitor per capsule for use with a Prometheus Operator stack. The service monitor will monitor services with the same name as the capsule and will use the endpoint specified by the path and portName fields in the configuration.

Example

Config:

config:
  pipeline:
    serviceMonitorStep:
      plugin: "rigdev.service_monitor"
      config: |
        path: metrics
        portName: metricsport

Config

Configuration for the deployment plugin

Field Description
Path string
PortName string

Documentation

Overview

+groupName=plugins.rig.dev -- Only used for config doc generation

Index

Constants

View Source
const (
	Name = "rigdev.service_monitor"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	Path     string
	PortName string
}

Configuration for the deployment plugin +kubebuilder:object:root=true

type Plugin

type Plugin struct {
	plugin.NoWatchObjectStatus
	// contains filtered or unexported fields
}

func (*Plugin) ComputeConfig added in v1.12.0

func (p *Plugin) ComputeConfig(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) (string, error)

func (*Plugin) Initialize

func (p *Plugin) Initialize(req plugin.InitializeRequest) error

func (*Plugin) Run

func (p *Plugin) Run(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) error

Jump to

Keyboard shortcuts

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