Annotee: Allow annotation subpath to be specified.

logdog/client/annotee/processor.go

 // Copyright 2015 The LUCI Authors. All rights reserved.
 // Use of this source code is governed under the Apache License, Version 2.0
 // that can be found in the LICENSE file.
 
 package annotee
 
 import (
         "bufio"
         "bytes"
         "fmt"
@@ skipping 19 matching lines @@
         // DefaultBufferSize is the Stream BufferSize value that will be used if no
         // buffer size is provided.
         DefaultBufferSize = 8192
 )
 
 const (
         // STDOUT is the system STDOUT stream name.
         STDOUT = types.StreamName("stdout")
         // STDERR is the system STDERR stream.
         STDERR = types.StreamName("stderr")
+
+        // DefaultAnnotationSubpath is the default annotation subpath. It will be used
+        // if an explicit subpath is not provided.
+        DefaultAnnotationSubpath = types.StreamName("annotations")
 )
 
 // Stream describes a single process stream.
 type Stream struct {
         // Reader is the stream data reader. It will be processed until it returns
         // an error or io.EOF.
         Reader io.Reader
         // Name is the logdog stream name.
         Name types.StreamName
         // Tee, if not nil, is a writer where all consumed stream data should be
@@ skipping 27 matching lines @@
         //
         // If no link could be generated, GetLink may return an empty string.
         GetLink(name ...types.StreamName) string
 }
 
 // Options are the configuration options for a Processor.
 type Options struct {
         // Base is the base log stream name. This is prepended to every log name, as
         // well as any generate log names.
         Base types.StreamName
+        // AnnotationSubpath is the path underneath of Base where the annotation
+        // stream will be written.
+        //
+        // If empty, DefaultAnnotationSubpath will be used.
+        AnnotationSubpath types.StreamName
 
         // LinkGenerator generates links to alias for a given log stream.
         //
         // If nil, no link annotations will be injected.
         LinkGenerator LinkGenerator
 
         // Client is the LogDog Butler Client to use for stream creation.
         Client streamclient.Client
 
         // Execution describes the current applicaton's execution parameters. This
@@ skipping 67 matching lines @@
 }
 
 // initialize initializes p's annotation stream handling system. If it is called
 // more than once, it is a no-op.
 func (p *Processor) initialize() (err error) {
         // If we're already initialized, do nothing.
         if p.annotationStream != nil {
                 return nil
         }
 
+        annotationPath := p.o.AnnotationSubpath
+        if annotationPath == "" {
+                annotationPath = DefaultAnnotationSubpath
+        }
+        annotationPath = p.astate.RootStep().BaseStream(annotationPath)
+
         // Create our annotation stream.
-        if p.annotationStream, err = p.createStream(p.astate.AnnotationStream(), &metadataStreamArchetype); err != nil {
+        if p.annotationStream, err = p.createStream(annotationPath, &metadataStreamArchetype); err != nil {
                 log.WithError(err).Errorf(p.ctx, "Failed to create annotation stream.")
                 return
         }
 
         // Complete initialization and start our annotation meter.
         p.annotationC = make(chan annotationSignal)
         p.annotationFinishedC = make(chan struct{})
         p.allEmittedStreams = map[*Stream]struct{}{}
 
         // Run our annotation meter in a separate goroutine.
@@ skipping 581 matching lines @@
         return "@@@" + strings.Join(append(v, params...), "@") + "@@@"
 }
 
 func isContentAnnotation(a string) bool {
         // Strip out any annotation arguments.
         if idx := strings.IndexRune(a, '@'); idx > 0 {
                 a = a[:idx]
         }
         return a == "STEP_LOG_LINE"
 }