env

Documentation

Index

• Constants
• Variables
• func Register()
• type EnvDescriptor
• type EnvEndpoint
  • func (ep *EnvEndpoint) Read(ctx context.Context, input *Input) (*EnvDescriptor, error)
• type EnvProperties
  • func BindEnvProperties(ctx *bootstrap.ApplicationContext) EnvProperties
  • func NewEnvProperties() *EnvProperties
• type Input
• type PSourceDescriptor
• type PValueDescriptor
• type Sanitizer
  • func NewSanitizer(keyPatterns []string) *Sanitizer
  • func (s Sanitizer) Sanitize(ctx context.Context, key string, value interface{}) interface{}

Constants

const (
	ID              = "env"
	EnableByDefault = false
)

const (
	EnvPropertiesPrefix = "management.endpoint.env"
)

Variables

var (
	DefaultKeysToSanitize = utils.NewStringSet(
		`.*password.*`, `.*secret.*`,
		`key`, `.*credentials.*`,
		`vcap_services`, `sun.java.command`,
	)
)

var Module = &bootstrap.Module{
	Name:       "actuator-env",
	Precedence: actuator.MinActuatorPrecedence,
	Options: []fx.Option{
		fx.Provide(BindEnvProperties),
		fx.Invoke(register),
	},
}

Functions

func Register

func Register()

Types

type EnvDescriptor

type EnvDescriptor struct {
	ActiveProfiles  []string            `json:"activeProfiles,omitempty"`
	PropertySources []PSourceDescriptor `json:"propertySources,omitempty"`
}

type EnvEndpoint

type EnvEndpoint struct {
	actuator.WebEndpointBase
	// contains filtered or unexported fields
}

EnvEndpoint implements actuator.Endpoint, actuator.WebEndpoint

func (*EnvEndpoint) Read

func (ep *EnvEndpoint) Read(ctx context.Context, input *Input) (*EnvDescriptor, error)

Read never returns error

type EnvProperties

type EnvProperties struct {
	// KeysToSanitize holds list of regular expressions
	KeysToSanitize utils.StringSet `json:"keys-to-sanitize"`
}

func BindEnvProperties

func BindEnvProperties(ctx *bootstrap.ApplicationContext) EnvProperties

BindHealthProperties create and bind SessionProperties, with a optional prefix

func NewEnvProperties

func NewEnvProperties() *EnvProperties

NewSessionProperties create a SessionProperties with default values

type Input

type Input struct {
	Pattern string `form:"match"`
}

type PSourceDescriptor

type PSourceDescriptor struct {
	Name       string                      `json:"name"`
	Properties map[string]PValueDescriptor `json:"properties,omitempty"`
	// contains filtered or unexported fields
}

type PValueDescriptor

type PValueDescriptor struct {
	Value  interface{} `json:"value,omitempty"`
	Origin string      `json:"origin,omitempty"`
}

type Sanitizer

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

func NewSanitizer

func NewSanitizer(keyPatterns []string) *Sanitizer

func (Sanitizer) Sanitize

func (s Sanitizer) Sanitize(ctx context.Context, key string, value interface{}) interface{}