v0.0.0-...-e560ebb Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Jul 13, 2021 License: BSD-3-Clause Imports: 15 Imported by: 0



Package logdog implements a convenient interface wrapping the LogDog, Butler, and Annotee APIs from LUCI.



This section is empty.


This section is empty.


This section is empty.


type Client

type Client struct {
	// contains filtered or unexported fields

Client is the LogDog client interface exported from this package. You must call Close to flush and close all of the resources.

func New

func New(ctx context.Context, o *Options) (c *Client, err error)

New initializes a Client according to the Options.

func (*Client) Close

func (c *Client) Close() (err error)

Close flushes and cleans up all currently initialized components of the Client, and returns the first error encountered.

func (*Client) Stdout

func (c *Client) Stdout() io.Writer

Stdout returns a Writer that is directly connected to the root LogDog stream. This stream is parsed for @@@ annotations. See the annotee/basic package for more information about annotations.

Do not write to this after calling Close on the Client.

type Options

type Options struct {
	// logdog://HOST/PROJECT/PREFIX/+/annotations
	AnnotationStream *types.StreamAddr
	// SourceInfo identifies the LogDog client (like UserAgent in
	// HTTP).
	SourceInfo []string

Options is passed to New to configure client creation.

Jump to

Keyboard shortcuts

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