client/internal/logdog/butler/output/doc.go - Issue 1211053004: LogDog: Add Butler Output package.

Side by Side Diff

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Side by Side Diff: client/internal/logdog/butler/output/doc.go

Issue 1211053004: LogDog: Add Butler Output package. (Closed) Base URL: https://github.com/luci/luci-go@logdog-review-streamserver

Patch Set: Added some doc.go's. Created 5 years, 1 month ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

OLD	NEW
(Empty)
	1 // Copyright 2015 The Chromium Authors. All rights reserved.

	2 // Use of this source code is governed by a BSD-style license that can be

	3 // found in the LICENSE file.

	4

	5 // Package output contains interfaces and implementations for Butler Outputs,

	6 // which are responsible for delivering Butler protobufs to LogDog collection

	7 // endpoints.

	8 //

	9 // Output instances must be goroutine-safe. The Butler may elect to output
	estaab 2015/11/19 23:57:24 Wait, "must be" or "are"? I'm reading this is as: Wait, "must be" or "are"? I'm reading this is as: users can safely use Output instances in goroutines but anyone changing this code must ensure it stays this way. Is that right? It sort of looks like instructions to the user of the code so perhaps disambiguate this statement by explicitly mentioning caller vs author. (and only here, not in the implementation files, it's much more obvious where the audience is there) dnj 2015/11/20 01:55:12 Must. The Output interface contract promises gorou Show quoted text On 2015/11/19 23:57:24, estaab wrote: > Wait, "must be" or "are"? I'm reading this is as: users can safely use Output > instances in goroutines but anyone changing this code must ensure it stays this > way. Is that right? It sort of looks like instructions to the user of the code > so perhaps disambiguate this statement by explicitly mentioning caller vs > author. > > (and only here, not in the implementation files, it's much more obvious where > the audience is there) Must. The Output interface contract promises goroutine-safety.
	10 // multiple messages at the same time.

	11 //

	12 // The package current provides the following implementations:

	13 // - gcps: Write logs to Google Cloud Pub/Sub.
	estaab 2015/11/19 23:57:24 A better name might be just "pubsub" since it's in A better name might be just "pubsub" since it's instantly recognizable. dnj 2015/11/20 01:55:12 Hmm ... okay, agreed. Show quoted text On 2015/11/19 23:57:24, estaab wrote: > A better name might be just "pubsub" since it's instantly recognizable. Hmm ... okay, agreed.
	14 // - log: (Debug/testing) data is dumped to the installed Logger instance.

	15 package output

OLD	NEW

« no previous file with comments | « no previous file | client/internal/logdog/butler/output/gcps/doc.go » ('j') | client/internal/logdog/butler/output/gcps/doc.go » ('J')