logging

Documentation

Overview

Package loggingscope is a generated GoMock package.

Index

• Constants
• Variables
• func BuildWLSLogHome(name string) string
• func BuildWLSLogPath(name string) string
• func GetFluentdConfiguration(templateConfig string, requiresCABundle bool) string
• func GetWlsSpecificContainerEnv() []v1.EnvVar
• type Fluentd
  • func (f *Fluentd) Apply(logInfo *LogInfo, resource vzapi.QualifiedResourceRelation, ...) (bool, error)
  • func (f *Fluentd) Remove(logInfo *LogInfo, resource vzapi.QualifiedResourceRelation, ...) bool
• type FluentdManager
  • func GetFluentd(ctx context.Context, log logr.Logger, client k8sclient.Client) FluentdManager
• type FluentdPod
• type Handler
• type LogInfo
  • func NewLogInfo(fluentdImageOrverride string) (*LogInfo, error)
• type MockFluentdManager
  • func NewMockFluentdManager(ctrl *gomock.Controller) *MockFluentdManager
  • func (m *MockFluentdManager) Apply(arg0 *LogInfo, arg1 v1alpha1.QualifiedResourceRelation, arg2 *FluentdPod) (bool, error)
  • func (m *MockFluentdManager) EXPECT() *MockFluentdManagerMockRecorder
  • func (m *MockFluentdManager) Remove(arg0 *LogInfo, arg1 v1alpha1.QualifiedResourceRelation, arg2 *FluentdPod) bool
• type MockFluentdManagerMockRecorder
  • func (mr *MockFluentdManagerMockRecorder) Apply(arg0, arg1, arg2 interface{}) *gomock.Call
  • func (mr *MockFluentdManagerMockRecorder) Remove(arg0, arg1, arg2 interface{}) *gomock.Call

Constants

const (
	FluentdStdoutSidecarName = "fluentd-stdout-sidecar"

	CAFileConfig = "\n  ca_file /fluentd/secret/ca-bundle"
)

const WlsFluentdParsingRules = `` /* 1808-byte string literal not displayed */

WlsFluentdParsingRules defines the FLUENTD parsing rules for WLS

Variables

var DefaultFluentdImage string

DefaultFluentdImage holds the default FLUENTD image that will be used if it is not specified in the logging logInfo

Functions

func BuildWLSLogHome

func BuildWLSLogHome(name string) string

BuildWLSLogHome builds a log home give a resource name

func BuildWLSLogPath

func BuildWLSLogPath(name string) string

BuildWLSLogPath builds a log path given a resource name

func GetFluentdConfiguration

func GetFluentdConfiguration(templateConfig string, requiresCABundle bool) string

func GetWlsSpecificContainerEnv

func GetWlsSpecificContainerEnv() []v1.EnvVar

GetWlsSpecificContainerEnv builds WLS specific env vars

Types

type Fluentd

type Fluentd struct {
	k8sclient.Client
	Log                    logr.Logger
	Context                context.Context
	ParseRules             string
	StorageVolumeName      string
	StorageVolumeMountPath string
	WorkloadType           string
}

Fluentd is an implementation of FluentdManager.

func (*Fluentd) Apply

func (f *Fluentd) Apply(logInfo *LogInfo, resource vzapi.QualifiedResourceRelation, fluentdPod *FluentdPod) (bool, error)

Apply applies FLUENTD configuration to create/update FLUENTD container, configmap, volumes and volume mounts. Returns true if any changes are made; false otherwise.

func (*Fluentd) Remove

func (f *Fluentd) Remove(logInfo *LogInfo, resource vzapi.QualifiedResourceRelation, fluentdPod *FluentdPod) bool

Remove removes FLUENTD container, configmap, volumes and volume mounts. Returns whether the remove action has been verified so that the caller knows when it is safe to forget the association.

type FluentdManager

type FluentdManager interface {
	Apply(logInfo *LogInfo, resource vzapi.QualifiedResourceRelation, fluentdPod *FluentdPod) (bool, error)
	Remove(logInfo *LogInfo, resource vzapi.QualifiedResourceRelation, fluentdPod *FluentdPod) bool
}

FluentdManager is a general interface to interact with FLUENTD related resources

func GetFluentd

func GetFluentd(ctx context.Context, log logr.Logger, client k8sclient.Client) FluentdManager

GetFluentd creates an instance of FluentManager

type FluentdPod

type FluentdPod struct {
	Containers   []v1.Container
	Volumes      []v1.Volume
	VolumeMounts []v1.VolumeMount
	HandlerEnv   []v1.EnvVar
	LogPath      string
}

FluentdPod contains pod information for pods which require FLUENTD integration

type Handler

type Handler interface {
	Apply(ctx context.Context, resource vzapi.QualifiedResourceRelation, info *LogInfo) (*ctrl.Result, error)
	Remove(ctx context.Context, resource vzapi.QualifiedResourceRelation, info *LogInfo) (bool, error)
}

Handler abstracts the FLUENTD integration for components

type LogInfo

type LogInfo struct {
	// The fluentd image
	FluentdImage string
}

LogInfo contains information needed for logging

func NewLogInfo

func NewLogInfo(fluentdImageOrverride string) (*LogInfo, error)

NewLogInfo creates and populates a new logging info

type MockFluentdManager

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

MockFluentdManager is a mock of FluentdManager interface

func NewMockFluentdManager

func NewMockFluentdManager(ctrl *gomock.Controller) *MockFluentdManager

NewMockFluentdManager creates a new mock instance

func (*MockFluentdManager) Apply

func (m *MockFluentdManager) Apply(arg0 *LogInfo, arg1 v1alpha1.QualifiedResourceRelation, arg2 *FluentdPod) (bool, error)

Apply mocks base method

func (*MockFluentdManager) EXPECT

func (m *MockFluentdManager) EXPECT() *MockFluentdManagerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockFluentdManager) Remove

func (m *MockFluentdManager) Remove(arg0 *LogInfo, arg1 v1alpha1.QualifiedResourceRelation, arg2 *FluentdPod) bool

Remove mocks base method

type MockFluentdManagerMockRecorder

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

MockFluentdManagerMockRecorder is the mock recorder for MockFluentdManager

func (*MockFluentdManagerMockRecorder) Apply

func (mr *MockFluentdManagerMockRecorder) Apply(arg0, arg1, arg2 interface{}) *gomock.Call

Apply indicates an expected call of Apply

func (*MockFluentdManagerMockRecorder) Remove

func (mr *MockFluentdManagerMockRecorder) Remove(arg0, arg1, arg2 interface{}) *gomock.Call

Remove indicates an expected call of Remove