mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-15 02:12:07 -05:00
3ec5be3f51
This file was never truly necessary and has never actually been used in the history of Tailscale's open source releases. A Brief History of AUTHORS files --- The AUTHORS file was a pattern developed at Google, originally for Chromium, then adopted by Go and a bunch of other projects. The problem was that Chromium originally had a copyright line only recognizing Google as the copyright holder. Because Google (and most open source projects) do not require copyright assignemnt for contributions, each contributor maintains their copyright. Some large corporate contributors then tried to add their own name to the copyright line in the LICENSE file or in file headers. This quickly becomes unwieldy, and puts a tremendous burden on anyone building on top of Chromium, since the license requires that they keep all copyright lines intact. The compromise was to create an AUTHORS file that would list all of the copyright holders. The LICENSE file and source file headers would then include that list by reference, listing the copyright holder as "The Chromium Authors". This also become cumbersome to simply keep the file up to date with a high rate of new contributors. Plus it's not always obvious who the copyright holder is. Sometimes it is the individual making the contribution, but many times it may be their employer. There is no way for the proejct maintainer to know. Eventually, Google changed their policy to no longer recommend trying to keep the AUTHORS file up to date proactively, and instead to only add to it when requested: https://opensource.google/docs/releasing/authors. They are also clear that: > Adding contributors to the AUTHORS file is entirely within the > project's discretion and has no implications for copyright ownership. It was primarily added to appease a small number of large contributors that insisted that they be recognized as copyright holders (which was entirely their right to do). But it's not truly necessary, and not even the most accurate way of identifying contributors and/or copyright holders. In practice, we've never added anyone to our AUTHORS file. It only lists Tailscale, so it's not really serving any purpose. It also causes confusion because Tailscalars put the "Tailscale Inc & AUTHORS" header in other open source repos which don't actually have an AUTHORS file, so it's ambiguous what that means. Instead, we just acknowledge that the contributors to Tailscale (whoever they are) are copyright holders for their individual contributions. We also have the benefit of using the DCO (developercertificate.org) which provides some additional certification of their right to make the contribution. The source file changes were purely mechanical with: git ls-files | xargs sed -i -e 's/\(Tailscale Inc &\) AUTHORS/\1 contributors/g' Updates #cleanup Change-Id: Ia101a4a3005adb9118051b3416f5a64a4a45987d Signed-off-by: Will Norris <will@tailscale.com>
84 lines
2.4 KiB
Go
84 lines
2.4 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// Package logknob provides a helpful wrapper that allows enabling logging
|
|
// based on either an envknob or other methods of enablement.
|
|
package logknob
|
|
|
|
import (
|
|
"sync/atomic"
|
|
|
|
"tailscale.com/envknob"
|
|
"tailscale.com/tailcfg"
|
|
"tailscale.com/types/logger"
|
|
)
|
|
|
|
// TODO(andrew-d): should we have a package-global registry of logknobs? It
|
|
// would allow us to update from a netmap in a central location, which might be
|
|
// reason enough to do it...
|
|
|
|
// LogKnob allows configuring verbose logging, with multiple ways to enable. It
|
|
// supports enabling logging via envknob, via atomic boolean (for use in e.g.
|
|
// c2n log level changes), and via capabilities from a NetMap (so users can
|
|
// enable logging via the ACL JSON).
|
|
type LogKnob struct {
|
|
capName tailcfg.NodeCapability
|
|
cap atomic.Bool
|
|
env func() bool
|
|
manual atomic.Bool
|
|
}
|
|
|
|
// NewLogKnob creates a new LogKnob, with the provided environment variable
|
|
// name and/or NetMap capability.
|
|
func NewLogKnob(env string, cap tailcfg.NodeCapability) *LogKnob {
|
|
if env == "" && cap == "" {
|
|
panic("must provide either an environment variable or capability")
|
|
}
|
|
|
|
lk := &LogKnob{
|
|
capName: cap,
|
|
}
|
|
if env != "" {
|
|
lk.env = envknob.RegisterBool(env)
|
|
} else {
|
|
lk.env = func() bool { return false }
|
|
}
|
|
return lk
|
|
}
|
|
|
|
// Set will cause logs to be printed when called with Set(true). When called
|
|
// with Set(false), logs will not be printed due to an earlier call of
|
|
// Set(true), but may be printed due to either the envknob and/or capability of
|
|
// this LogKnob.
|
|
func (lk *LogKnob) Set(v bool) {
|
|
lk.manual.Store(v)
|
|
}
|
|
|
|
// NetMap is an interface for the parts of netmap.NetworkMap that we care
|
|
// about; we use this rather than a concrete type to avoid a circular
|
|
// dependency.
|
|
type NetMap interface {
|
|
HasSelfCapability(tailcfg.NodeCapability) bool
|
|
}
|
|
|
|
// UpdateFromNetMap will enable logging if the SelfNode in the provided NetMap
|
|
// contains the capability provided for this LogKnob.
|
|
func (lk *LogKnob) UpdateFromNetMap(nm NetMap) {
|
|
if lk.capName == "" {
|
|
return
|
|
}
|
|
lk.cap.Store(nm.HasSelfCapability(lk.capName))
|
|
}
|
|
|
|
// Do will call log with the provided format and arguments if any of the
|
|
// configured methods for enabling logging are true.
|
|
func (lk *LogKnob) Do(log logger.Logf, format string, args ...any) {
|
|
if lk.shouldLog() {
|
|
log(format, args...)
|
|
}
|
|
}
|
|
|
|
func (lk *LogKnob) shouldLog() bool {
|
|
return lk.manual.Load() || lk.env() || lk.cap.Load()
|
|
}
|