logs

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 logs implements decision log buffering and uploading.

Index

• Constants
• type BundleInfoV1
• type Config
  • func ParseConfig(config []byte, services []string, pluginList []string) (*Config, error)
• type ConfigBuilder
  • func NewConfigBuilder() *ConfigBuilder
• type EventV1
• type HTTPRequestContext
• type HTTPRequestContextConfig
• type Logger
• type Plugin
  • func Lookup(manager *plugins.Manager) *Plugin
  • func New(parsedConfig *Config, manager *plugins.Manager) *Plugin
• type ReportingConfig
• type RequestContext
• type RequestContextConfig

Constants

const Name = v1.Name

Name identifies the plugin on manager.

Types

type BundleInfoV1

type BundleInfoV1 = v1.BundleInfoV1

BundleInfoV1 describes a bundle associated with a decision log event.

type Config

type Config = v1.Config

Config represents the plugin configuration.

func ParseConfig

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

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 EventV1

type EventV1 = v1.EventV1

EventV1 represents a decision log event. WARNING: The AST() function for EventV1 must be kept in sync with the struct. Any changes here MUST be reflected in the AST() implementation below.

type HTTPRequestContext

type HTTPRequestContext = v1.HTTPRequestContext

type HTTPRequestContextConfig

type HTTPRequestContextConfig = v1.HTTPRequestContextConfig

type Logger

type Logger = v1.Logger

Logger defines the interface for decision logging plugins.

type Plugin

type Plugin = v1.Plugin

Plugin implements decision log buffering and uploading.

func Lookup

func Lookup(manager *plugins.Manager) *Plugin

Lookup returns the decision logs 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 ReportingConfig

type ReportingConfig = v1.ReportingConfig

ReportingConfig represents configuration for the plugin's reporting behaviour.

type RequestContext

type RequestContext = v1.RequestContext

type RequestContextConfig

type RequestContextConfig = v1.RequestContextConfig