logs

Documentation

Overview

Package logs handles log output from a run

Index

• type Client
  • func (c *Client) PutChunk(ctx context.Context, opts internal.PutChunkOptions) error
• type Options
• type PhaseWriter
  • func NewPhaseWriter(ctx context.Context, opts PhaseWriterOptions) *PhaseWriter
  • func (w *PhaseWriter) Close() error
  • func (w *PhaseWriter) Write(p []byte) (int, error)
• type PhaseWriterOptions
• type Service
  • func NewService(opts Options) *Service
  • func (s *Service) AddHandlers(r *mux.Router)
  • func (s *Service) GetChunk(ctx context.Context, opts internal.GetChunkOptions) (internal.Chunk, error)
  • func (s *Service) PutChunk(ctx context.Context, opts internal.PutChunkOptions) error
  • func (s *Service) Tail(ctx context.Context, opts internal.GetChunkOptions) (<-chan internal.Chunk, error)
  • func (s *Service) WatchLogs(ctx context.Context) (<-chan pubsub.Event[internal.Chunk], func())

Types

type Client

type Client struct {
	*otfapi.Client
}

func (*Client) PutChunk

func (c *Client) PutChunk(ctx context.Context, opts internal.PutChunkOptions) error

type Options

type Options struct {
	logr.Logger
	internal.Cache
	*sql.DB
	*sql.Listener
	internal.Verifier

	RunAuthorizer internal.Authorizer
}

type PhaseWriter

type PhaseWriter struct {
	internal.PutChunkService // for uploading logs to server
	// contains filtered or unexported fields
}

PhaseWriter writes logs on behalf of a run phase.

func NewPhaseWriter

func NewPhaseWriter(ctx context.Context, opts PhaseWriterOptions) *PhaseWriter

func (*PhaseWriter) Close

func (w *PhaseWriter) Close() error

Close must be called to complete writing job logs

func (*PhaseWriter) Write

func (w *PhaseWriter) Write(p []byte) (int, error)

Write uploads a chunk of logs to the server.

type PhaseWriterOptions

type PhaseWriterOptions struct {
	RunID  string
	Phase  internal.PhaseType
	Writer internal.PutChunkService
}

type Service

type Service struct {
	logr.Logger
	// contains filtered or unexported fields
}

func NewService

func NewService(opts Options) *Service

func (*Service) AddHandlers

func (s *Service) AddHandlers(r *mux.Router)

func (*Service) GetChunk

func (s *Service) GetChunk(ctx context.Context, opts internal.GetChunkOptions) (internal.Chunk, error)

GetChunk reads a chunk of logs for a phase.

NOTE: unauthenticated - access granted only via signed URL

func (*Service) PutChunk

func (s *Service) PutChunk(ctx context.Context, opts internal.PutChunkOptions) error

PutChunk writes a chunk of logs for a phase

func (*Service) Tail

func (s *Service) Tail(ctx context.Context, opts internal.GetChunkOptions) (<-chan internal.Chunk, error)

Tail logs for a phase. Offset specifies the number of bytes into the logs from which to start tailing.

func (*Service) WatchLogs

func (s *Service) WatchLogs(ctx context.Context) (<-chan pubsub.Event[internal.Chunk], func())