logs

package

v0.9.1 Latest Latest Go to latest Published: Apr 4, 2024 License: MPL-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package logs handles log output from a run

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	*otfapi.Client
}

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

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

	RunAuthorizer internal.Authorizer
}

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(ctx context.Context, opts PhaseWriterOptions) *PhaseWriter

func (w *PhaseWriter) Close() error

Close must be called to complete writing job logs

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

Write uploads a chunk of logs to the server.

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

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

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)

GetChunk reads a chunk of logs for a phase.

NOTE: unauthenticated - access granted only via signed URL

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

PutChunk writes a chunk of logs for a phase

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 (s *Service) WatchLogs(ctx context.Context) (<-chan pubsub.Event[internal.Chunk], func())