diff options
Diffstat (limited to 'vendor/cloud.google.com/go/trace/sampling.go')
| -rw-r--r-- | vendor/cloud.google.com/go/trace/sampling.go | 117 |
1 files changed, 0 insertions, 117 deletions
diff --git a/vendor/cloud.google.com/go/trace/sampling.go b/vendor/cloud.google.com/go/trace/sampling.go deleted file mode 100644 index d609290b9..000000000 --- a/vendor/cloud.google.com/go/trace/sampling.go +++ /dev/null @@ -1,117 +0,0 @@ -// Copyright 2016 Google Inc. All Rights Reserved. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package trace - -import ( - crand "crypto/rand" - "encoding/binary" - "fmt" - "math/rand" - "sync" - "time" - - "golang.org/x/time/rate" -) - -type SamplingPolicy interface { - // Sample returns a Decision. - // If Trace is false in the returned Decision, then the Decision should be - // the zero value. - Sample(p Parameters) Decision -} - -// Parameters contains the values passed to a SamplingPolicy's Sample method. -type Parameters struct { - HasTraceHeader bool // whether the incoming request has a valid X-Cloud-Trace-Context header. -} - -// Decision is the value returned by a call to a SamplingPolicy's Sample method. -type Decision struct { - Trace bool // Whether to trace the request. - Sample bool // Whether the trace is included in the random sample. - Policy string // Name of the sampling policy. - Weight float64 // Sample weight to be used in statistical calculations. -} - -type sampler struct { - fraction float64 - skipped float64 - *rate.Limiter - *rand.Rand - sync.Mutex -} - -func (s *sampler) Sample(p Parameters) Decision { - s.Lock() - x := s.Float64() - d := s.sample(p, time.Now(), x) - s.Unlock() - return d -} - -// sample contains the a deterministic, time-independent logic of Sample. -func (s *sampler) sample(p Parameters, now time.Time, x float64) (d Decision) { - d.Sample = x < s.fraction - d.Trace = p.HasTraceHeader || d.Sample - if !d.Trace { - // We have no reason to trace this request. - return Decision{} - } - // We test separately that the rate limit is not tiny before calling AllowN, - // because of overflow problems in x/time/rate. - if s.Limit() < 1e-9 || !s.AllowN(now, 1) { - // Rejected by the rate limit. - if d.Sample { - s.skipped++ - } - return Decision{} - } - if d.Sample { - d.Policy, d.Weight = "default", (1.0+s.skipped)/s.fraction - s.skipped = 0.0 - } - return -} - -// NewLimitedSampler returns a sampling policy that randomly samples a given -// fraction of requests. It also enforces a limit on the number of traces per -// second. It tries to trace every request with a trace header, but will not -// exceed the qps limit to do it. -func NewLimitedSampler(fraction, maxqps float64) (SamplingPolicy, error) { - if !(fraction >= 0) { - return nil, fmt.Errorf("invalid fraction %f", fraction) - } - if !(maxqps >= 0) { - return nil, fmt.Errorf("invalid maxqps %f", maxqps) - } - // Set a limit on the number of accumulated "tokens", to limit bursts of - // traced requests. Use one more than a second's worth of tokens, or 100, - // whichever is smaller. - // See https://godoc.org/golang.org/x/time/rate#NewLimiter. - maxTokens := 100 - if maxqps < 99.0 { - maxTokens = 1 + int(maxqps) - } - var seed int64 - if err := binary.Read(crand.Reader, binary.LittleEndian, &seed); err != nil { - seed = time.Now().UnixNano() - } - s := sampler{ - fraction: fraction, - Limiter: rate.NewLimiter(rate.Limit(maxqps), maxTokens), - Rand: rand.New(rand.NewSource(seed)), - } - return &s, nil -} |
