service_monitor

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 (in the context of the rig-operator Helm values):

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
• type Config
• type Plugin
  • func (p *Plugin) Initialize(req plugin.InitializeRequest) error
  • func (p *Plugin) Run(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) error

Constants

const (
	Name = "rigdev.service_monitor"
)

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) 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