log

package

v0.6.0 Latest Latest Go to latest Published: May 7, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tektoncd/results

Links

Documentation ¶

Index ¶

Constants
Variables
func FilePath(log *v1alpha2.Log) (string, error)
func FormatName(parent, name string) string
func ParseName(raw string) (parent, result, name string, err error)
func ToStorage(record *pb.Record, config *config.Config) ([]byte, error)
type Stream

Constants ¶

View Source

const (
	// DefaultBufferSize is the default buffer size. This based on the recommended
	// gRPC message size for streamed content, which ranges from 16 to 64 KiB. Choosing 32 KiB as a
	// middle ground between the two.
	DefaultBufferSize = 32 * 1024
)

View Source

const (
	DefaultS3MultiPartSize = 1024 * 1024 * 5
)

Variables ¶

View Source

var (
	// NameRegex matches valid name specs for a Result.
	NameRegex = regexp.MustCompile("(^[a-z0-9_-]{1,63})/results/([a-z0-9_-]{1,63})/logs/([a-z0-9_-]{1,63}$)")
)

Functions ¶

func FilePath ¶

func FilePath(log *v1alpha2.Log) (string, error)

func FormatName ¶

func FormatName(parent, name string) string

FormatName takes in a parent ("a/results/b") and record name ("c") and returns the full resource name ("a/results/b/logs/c").

func ParseName ¶

func ParseName(raw string) (parent, result, name string, err error)

ParseName splits a full Result name into its individual (parent, result, name) components.

func ToStorage ¶

func ToStorage(record *pb.Record, config *config.Config) ([]byte, error)

Types ¶

type Stream ¶

type Stream interface {
	io.ReaderFrom
	io.WriterTo
	Type() string
	Delete() error
	Flush() error
}

func NewFileStream ¶

func NewFileStream(ctx context.Context, log *v1alpha2.Log, config *config.Config) (Stream, error)

NewFileStream returns a LogStreamer that streams directly from a log file on local disk.

func NewS3Stream ¶

func NewS3Stream(ctx context.Context, log *v1alpha2.Log, config *server.Config) (Stream, error)

func NewStream ¶

func NewStream(ctx context.Context, log *v1alpha2.Log, config *config.Config) (Stream, error)

NewStream returns a LogStreamer for the given Log. LogStreamers do the following:

1. Write log data from their respective source to an io.Writer interface. 2. Read log data from a source, and store it in the respective backend if that behavior is supported.

All LogStreamers support writing log data to an io.Writer from the provided source. LogStreamers do not need to receive and store data from the provided source.

NewStream may mutate the Log object's status, to provide implementation information for reading and writing files.

func ToStream ¶

func ToStream(ctx context.Context, record *db.Record, config *config.Config) (Stream, *v1alpha2.Log, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL