mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-10 10:12:27 +01: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>
89 lines
2.7 KiB
Go
89 lines
2.7 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// This file contains user-facing metrics that are used by multiple packages.
|
|
// Use it to define more common metrics. Any changes to the registry and
|
|
// metric types should be in usermetric.go.
|
|
|
|
package usermetric
|
|
|
|
import (
|
|
"sync"
|
|
|
|
"tailscale.com/feature/buildfeatures"
|
|
)
|
|
|
|
// Metrics contains user-facing metrics that are used by multiple packages.
|
|
type Metrics struct {
|
|
initOnce sync.Once
|
|
|
|
droppedPacketsInbound *MultiLabelMap[DropLabels]
|
|
droppedPacketsOutbound *MultiLabelMap[DropLabels]
|
|
}
|
|
|
|
// DropReason is the reason why a packet was dropped.
|
|
type DropReason string
|
|
|
|
const (
|
|
// ReasonACL means that the packet was not permitted by ACL.
|
|
ReasonACL DropReason = "acl"
|
|
|
|
// ReasonMulticast means that the packet was dropped because it was a multicast packet.
|
|
ReasonMulticast DropReason = "multicast"
|
|
|
|
// ReasonLinkLocalUnicast means that the packet was dropped because it was a link-local unicast packet.
|
|
ReasonLinkLocalUnicast DropReason = "link_local_unicast"
|
|
|
|
// ReasonTooShort means that the packet was dropped because it was a bad packet,
|
|
// this could be due to a short packet.
|
|
ReasonTooShort DropReason = "too_short"
|
|
|
|
// ReasonFragment means that the packet was dropped because it was an IP fragment.
|
|
ReasonFragment DropReason = "fragment"
|
|
|
|
// ReasonUnknownProtocol means that the packet was dropped because it was an unknown protocol.
|
|
ReasonUnknownProtocol DropReason = "unknown_protocol"
|
|
|
|
// ReasonError means that the packet was dropped because of an error.
|
|
ReasonError DropReason = "error"
|
|
)
|
|
|
|
// DropLabels contains common label(s) for dropped packet counters.
|
|
type DropLabels struct {
|
|
Reason DropReason
|
|
}
|
|
|
|
// initOnce initializes the common metrics.
|
|
func (r *Registry) initOnce() {
|
|
if !buildfeatures.HasUserMetrics {
|
|
return
|
|
}
|
|
r.m.initOnce.Do(func() {
|
|
r.m.droppedPacketsInbound = NewMultiLabelMapWithRegistry[DropLabels](
|
|
r,
|
|
"tailscaled_inbound_dropped_packets_total",
|
|
"counter",
|
|
"Counts the number of dropped packets received by the node from other peers",
|
|
)
|
|
r.m.droppedPacketsOutbound = NewMultiLabelMapWithRegistry[DropLabels](
|
|
r,
|
|
"tailscaled_outbound_dropped_packets_total",
|
|
"counter",
|
|
"Counts the number of packets dropped while being sent to other peers",
|
|
)
|
|
})
|
|
}
|
|
|
|
// DroppedPacketsOutbound returns the outbound dropped packet metric, creating it
|
|
// if necessary.
|
|
func (r *Registry) DroppedPacketsOutbound() *MultiLabelMap[DropLabels] {
|
|
r.initOnce()
|
|
return r.m.droppedPacketsOutbound
|
|
}
|
|
|
|
// DroppedPacketsInbound returns the inbound dropped packet metric.
|
|
func (r *Registry) DroppedPacketsInbound() *MultiLabelMap[DropLabels] {
|
|
r.initOnce()
|
|
return r.m.droppedPacketsInbound
|
|
}
|