luci: Index | Files | Directories

package service

import ""


Package Files

rt.go service.go


var (
    // ErrInvalidConfig is an error that is returned when the supplied
    // configuration is invalid.
    ErrInvalidConfig = errors.New("invalid configuration")

    // CoordinatorScopes is the set of OAuth2 scopes to use for the Coordinator
    // client.
    CoordinatorScopes = []string{

type Service Uses

type Service struct {
    // Name is the name of this service. It is used for logging, metrics, and
    // user agent string generation.
    // If empty, a service name will be inferred from the command-line arguments.
    Name string

    // DefaultAuthOptions provide default values for authentication related
    // options (most notably SecretsDir: a directory with token cache).
    DefaultAuthOptions commonAuth.Options

    // Flags is the set of flags that will be used by the Service.
    Flags flag.FlagSet
    // contains filtered or unexported fields

Service is a base class full of common LogDog service application parameters.

func (*Service) Coordinator Uses

func (s *Service) Coordinator() logdog.ServicesClient

Coordinator returns the cached Coordinator client.

func (*Service) GSClient Uses

func (s *Service) GSClient(c context.Context, project string) (gs.Client, error)

GSClient returns an authenticated Google Storage client instance.

func (*Service) IntermediateStorage Uses

func (s *Service) IntermediateStorage(c context.Context, rw bool) (storage.Storage, error)

IntermediateStorage instantiates the configured intermediate Storage instance.

If "rw" is true, Read/Write access will be requested. Otherwise, read-only access will be requested.

func (*Service) ProjectConfig Uses

func (s *Service) ProjectConfig(c context.Context, project string) (*svcconfig.ProjectConfig, error)

ProjectConfig returns the current service's project configuration for project.

func (*Service) ProjectConfigPath Uses

func (s *Service) ProjectConfigPath(project string) (cfglib.Set, string)

ProjectConfigPath returns the ConfigSet and path to the current service's project configuration for project.

func (*Service) PubSubSubscriberClient Uses

func (s *Service) PubSubSubscriberClient(c context.Context, projectID string) (*pubsub.Client, error)

PubSubSubscriberClient returns a Pub/Sub client instance that is authenticated with Pub/Sub subscriber scopes.

func (*Service) Run Uses

func (s *Service) Run(c context.Context, f func(context.Context) error)

Run performs service-wide initialization and invokes the specified run function.

func (*Service) ServiceConfig Uses

func (s *Service) ServiceConfig() *svcconfig.Config

ServiceConfig returns the configuration data for the current service.

func (*Service) ServiceConfigPath Uses

func (s *Service) ServiceConfigPath() (cfglib.Set, string)

ServiceConfigPath returns the ConfigSet and path to the current service's configuration.

func (*Service) ServiceID Uses

func (s *Service) ServiceID() string

ServiceID returns the service ID.

This is synonymous with the cloud "project ID" and the AppEngine "app ID".

func (*Service) SetShutdownFunc Uses

func (s *Service) SetShutdownFunc(f func())

SetShutdownFunc sets the service shutdown function.


configPackage config implements common LogDog daemon configuration.

Package service imports 48 packages (graph). Updated 2020-04-05. Refresh now. Tools for package owners.