pblog

Documentation

Overview

Package pblog is the client for a logger using gRPC. Additional non-logging functionality needed for provisioning is included. Including the additional functionality in this package rather than another is merely for convenience - in production implementations, it may be preferred to separate them.

The protocol buffer/grpc definitions are in the pb sub-package, and the server impl is in the server sub-package.

Index

• Constants
• func UseRKeeper()
• func UseRLoggerSetup()
• type AllInOne
  • func AddPBLog(endpoint, sn string, flags flags.Flag) (AllInOne, error)
• type Pbl
  • func (p *Pbl) AddEntry(e log.LogEntry)
  • func (p *Pbl) Finalize()
  • func (p *Pbl) ForwardTo(sl log.StackableLogger)
  • func (p *Pbl) GetCredentials(ident string) common.Credentials
  • func (p *Pbl) GetTime() string
  • func (p *Pbl) Ident() string
  • func (p *Pbl) Next() log.StackableLogger
  • func (p *Pbl) ReportCodename(c string)
  • func (p *Pbl) ReportFailure(f string)
  • func (p *Pbl) ReportFinished(f string)
  • func (p *Pbl) ReportState(state string)
  • func (*Pbl) SetEP(string)
  • func (p *Pbl) SetUnit(u common.Unit)
  • func (p *Pbl) StoreDocument(name string, doctype rkeep.PrintedDocType, body []byte)
  • func (p *Pbl) StoreIPMIMACs(im []string)
  • func (p *Pbl) StoreMACs(m []string)
• type RLogSetup
  • func (*RLogSetup) Setup(endpoint, id string) error

Constants

const LogIdent = "PBLog"

Functions

func UseRKeeper

func UseRKeeper()

func UseRLoggerSetup

func UseRLoggerSetup()

Types

type AllInOne

type AllInOne interface {
	log.StackableLogger
	rkeep.RecordKeeper
	common.Credentialer
}

func AddPBLog

func AddPBLog(endpoint, sn string, flags flags.Flag) (AllInOne, error)

type Pbl

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

func (*Pbl) AddEntry

func (p *Pbl) AddEntry(e log.LogEntry)

Must be callable even when conn is not open, as something may try to log after Finalize() at shutdown.

func (*Pbl) Finalize

func (p *Pbl) Finalize()

func (*Pbl) ForwardTo

func (p *Pbl) ForwardTo(sl log.StackableLogger)

func (*Pbl) GetCredentials

func (p *Pbl) GetCredentials(ident string) common.Credentials

GetCredentials is part of imaging.Credentialer interface.

func (*Pbl) GetTime

func (p *Pbl) GetTime() string

func (*Pbl) Ident

func (p *Pbl) Ident() string

func (*Pbl) Next

func (p *Pbl) Next() log.StackableLogger

func (*Pbl) ReportCodename

func (p *Pbl) ReportCodename(c string)

func (*Pbl) ReportFailure

func (p *Pbl) ReportFailure(f string)

func (*Pbl) ReportFinished

func (p *Pbl) ReportFinished(f string)

func (*Pbl) ReportState

func (p *Pbl) ReportState(state string)

func (*Pbl) SetEP

func (*Pbl) SetEP(string)

SetEP is part of imaging.Credentialer interface. no-op.

func (*Pbl) SetUnit

func (p *Pbl) SetUnit(u common.Unit)

func (*Pbl) StoreDocument

func (p *Pbl) StoreDocument(name string, doctype rkeep.PrintedDocType, body []byte)

func (*Pbl) StoreIPMIMACs

func (p *Pbl) StoreIPMIMACs(im []string)

func (*Pbl) StoreMACs

func (p *Pbl) StoreMACs(m []string)

type RLogSetup

type RLogSetup struct{}

func (*RLogSetup) Setup

func (*RLogSetup) Setup(endpoint, id string) error