status

Documentation

Overview

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Package status implements status reporting.

Index

• Constants
• type BundleLoadDurationNanoseconds
• type Collectors
• type Config
  • func ParseConfig(config []byte, services []string, pluginsList []string) (*Config, error)
• type ConfigBuilder
  • func NewConfigBuilder() *ConfigBuilder
• type Logger
• type Plugin
  • func Lookup(manager *plugins.Manager) *Plugin
  • func New(parsedConfig *Config, manager *plugins.Manager) *Plugin
• type PrometheusConfig
• type UpdateRequestV1

Constants

const Name = v1.Name

Name identifies the plugin on manager.

Types

type BundleLoadDurationNanoseconds

type BundleLoadDurationNanoseconds = v1.BundleLoadDurationNanoseconds

BundleLoadDurationNanoseconds represents the configuration for the status.prometheus_config.bundle_loading_duration_ns settings

type Collectors

type Collectors = v1.Collectors

type Config

type Config = v1.Config

Config contains configuration for the plugin.

func ParseConfig

func ParseConfig(config []byte, services []string, pluginsList []string) (*Config, error)

ParseConfig validates the config and injects default values.

type ConfigBuilder

type ConfigBuilder = v1.ConfigBuilder

ConfigBuilder assists in the construction of the plugin configuration.

func NewConfigBuilder

func NewConfigBuilder() *ConfigBuilder

NewConfigBuilder returns a new ConfigBuilder to build and parse the plugin config.

type Logger

type Logger = v1.Logger

Logger defines the interface for status plugins.

type Plugin

type Plugin = v1.Plugin

Plugin implements status reporting. Updates can be triggered by the caller.

func Lookup

func Lookup(manager *plugins.Manager) *Plugin

Lookup returns the status plugin registered with the manager.

func New

func New(parsedConfig *Config, manager *plugins.Manager) *Plugin

New returns a new Plugin with the given config.

type PrometheusConfig

type PrometheusConfig = v1.PrometheusConfig

type UpdateRequestV1

type UpdateRequestV1 = v1.UpdateRequestV1

UpdateRequestV1 represents the status update message that OPA sends to remote HTTP endpoints.