LogDog: Add project namespace to Butler/Collector.

client/internal/logdog/butler/butler.go

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package butler
 
 import (
         "errors"
         "fmt"
         "io"
         "sort"
         "sync"
         "time"
 
         "github.com/luci/luci-go/client/internal/logdog/butler/bundler"
         "github.com/luci/luci-go/client/internal/logdog/butler/output"
         "github.com/luci/luci-go/client/internal/logdog/butler/streamserver"
         "github.com/luci/luci-go/client/logdog/butlerlib/streamproto"
         "github.com/luci/luci-go/common/clock"
+        "github.com/luci/luci-go/common/config"
         "github.com/luci/luci-go/common/iotools"
         "github.com/luci/luci-go/common/logdog/types"
         log "github.com/luci/luci-go/common/logging"
         "github.com/luci/luci-go/common/paniccatcher"
         "github.com/luci/luci-go/common/parallel"
         "github.com/luci/luci-go/common/proto/google"
         "github.com/luci/luci-go/common/stringset"
         "golang.org/x/net/context"
 )
 
 const (
         // DefaultMaxBufferAge is the default amount of time that a log entry may
         // be buffered before being dispatched.
         DefaultMaxBufferAge = time.Duration(5 * time.Second)
 
         // DefaultOutputWorkers is the default number of output workers to use.
         DefaultOutputWorkers = 16
 
         // streamBufferSize is the maximum amount of stream data to buffer in memory.
         streamBufferSize = 1024 * 1024 * 5
 )
 
 // Config is the set of Butler configuration parameters.
 type Config struct {
         // Output is the output instance to use for log dispatch.
         Output output.Output
         // OutputWorkers is the number of simultaneous goroutines that will be used
         // to output Butler log data. If zero, DefaultOutputWorkers will be used.
         OutputWorkers int
+
+        // Project is the project that the log stream will be bound to.
+        Project config.ProjectName
         // Prefix is the log stream common prefix value.
         Prefix types.StreamName
+        // Secret is the prefix secret that will be used for streams generated by this
+        // Butler.
+        Secret types.PrefixSecret
 
         // BufferLogs, if true, instructs the butler to buffer collected log data
         // before sending it to Output.
         BufferLogs bool
         // If buffering logs, this is the maximum amount of time that a log will
         // be buffered before being marked for dispatch. If this is zero,
         // DefaultMaxBufferAge will be used.
         MaxBufferAge time.Duration
 
         // TeeStdout, if not nil, is the Writer that will be used for streams
         // requesting STDOUT tee.
         TeeStdout io.Writer
         // TeeStderr, if not nil, is the Writer that will be used for streams
         // requesting STDERR tee.
         TeeStderr io.Writer
 }
 
 // Validate validates that the configuration is sufficient to instantiate a
 // Butler instance.
 func (c *Config) Validate() error {
         if c.Output == nil {
                 return errors.New("butler: an Output must be supplied")
         }
+        // TODO(dnj): Empty project should not validate here once projects are
+        // mandatory.
+        if c.Project != "" {
+                if err := c.Project.Validate(); err != nil {
+                        return fmt.Errorf("invalid project: %v", err)
+                }
+        }
         if err := c.Prefix.Validate(); err != nil {
-                return errors.New("butler: invalid Prefix")
+                return fmt.Errorf("invalid prefix: %v", err)
+        }
+        if err := c.Secret.Validate(); err != nil {
+                return fmt.Errorf("invalid secret: %v", err)
         }
         return nil
 }
 
 // Butler is the Butler application structure. The Butler runs until closed.
 // During operation, it acts as a service manager and data router, routing:
 // - Messages from Streams to the attached Output.
 // - Streams from a StreamServer to the Stream list (AddStream).
 type Butler struct {
         c   *Config
@@ skipping 42 matching lines @@
         if err := config.Validate(); err != nil {
                 return nil, err
         }
 
         if config.OutputWorkers <= 0 {
                 config.OutputWorkers = DefaultOutputWorkers
         }
 
         bc := bundler.Config{
                 Clock:            clock.Get(ctx),
+                Project:          config.Project,
+                Prefix:           config.Prefix,
+                Secret:           config.Secret,
                 MaxBufferedBytes: streamBufferSize,
                 MaxBundleSize:    config.Output.MaxSize(),
         }
         if config.BufferLogs {
                 bc.MaxBufferDelay = config.MaxBufferAge
         }
         lb := bundler.New(bc)
 
         b := &Butler{
                 c:   &config,
@@ skipping 384 matching lines @@
         // shutdown prematurely, so this should be reasonably quick.
         b.Activate()
 }
 
 // Returns the configured Butler error.
 func (b *Butler) getRunErr() error {
         b.shutdownMu.Lock()
         defer b.shutdownMu.Unlock()
         return b.runErr
 }