luci: go.chromium.org/luci/logdog/client/butlerlib/bootstrap Index | Files

package bootstrap

import "go.chromium.org/luci/logdog/client/butlerlib/bootstrap"

Index

Package Files

bootstrap.go environment.go

Constants

const (
    // EnvStreamServerPath is the path to the Butler's stream server endpoint.
    //
    // This can be used by applications to initiate a new Butler stream with an
    // existing Butler stream server process. If a subprocess is launched with a
    // stream server configuration, it will propagate this path to its child
    // processes.
    EnvStreamServerPath = "LOGDOG_STREAM_SERVER_PATH"

    // EnvStreamProject is the environment variable set to the configured stream
    // project name.
    EnvStreamProject = "LOGDOG_STREAM_PROJECT"

    // EnvStreamPrefix is the environment variable set to the configured
    // stream name prefix.
    EnvStreamPrefix = "LOGDOG_STREAM_PREFIX"

    // EnvCoordinatorHost is the environment variable set to the host name of
    // the upstream Coordinator service.
    EnvCoordinatorHost = "LOGDOG_COORDINATOR_HOST"
)

Environment variable names

Variables

var ErrNotBootstrapped = errors.New("not bootstrapped")

ErrNotBootstrapped is returned by Get when the current process is not bootstrapped.

type Bootstrap Uses

type Bootstrap struct {
    // CoordinatorHost is the name of the upstream Coordinator host.
    //
    // This is just the host name ("example.appspot.com"), not a full URL.
    //
    // If this instance is not configured using a production Coordinator Output,
    // this will be empty.
    CoordinatorHost string

    // Project is the Butler instance project name.
    Project types.ProjectName
    // Prefix is the Butler instance prefix.
    Prefix types.StreamName

    // Client is the streamclient for this instance, or nil if the Butler has no
    // streamserver.
    Client streamclient.Client
}

Bootstrap contains information about the configured bootstrap environment.

The bootstrap environment is loaded by probing the local application environment for variables emitted by a bootstrapping Butler.

func Get Uses

func Get() (*Bootstrap, error)

Get loads a Bootstrap instance from the environment. It will return an error if the bootstrap data is invalid, and will return ErrNotBootstrapped if the current process is not bootstrapped.

func (*Bootstrap) GetViewerURL Uses

func (bs *Bootstrap) GetViewerURL(paths ...types.StreamPath) (string, error)

GetViewerURL returns a log stream viewer URL to the aggregate set of supplied stream paths.

If both the Project and CoordinatorHost values are not populated, an error will be returned.

func (*Bootstrap) GetViewerURLForStreams Uses

func (bs *Bootstrap) GetViewerURLForStreams(streams ...streamclient.Stream) (string, error)

GetViewerURLForStreams returns a log stream viewer URL to the aggregate set of supplied streams.

If the any of the Prefix, Project, or CoordinatorHost values is not populated, an error will be returned.

Package bootstrap imports 6 packages (graph) and is imported by 3 packages. Updated 2018-12-14. Refresh now. Tools for package owners.