/
obsreport_scraper.go
120 lines (105 loc) · 3.71 KB
/
obsreport_scraper.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// Copyright The OpenTelemetry Authors
//
// 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 obsreport
import (
"context"
"go.opencensus.io/stats"
"go.opencensus.io/tag"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"go.opentelemetry.io/collector/config"
"go.opentelemetry.io/collector/config/configtelemetry"
"go.opentelemetry.io/collector/internal/obsreportconfig"
"go.opentelemetry.io/collector/internal/obsreportconfig/obsmetrics"
"go.opentelemetry.io/collector/receiver/scrapererror"
)
// ScraperContext adds the keys used when recording observability metrics to
// the given context returning the newly created context. This context should
// be used in related calls to the obsreport functions so metrics are properly
// recorded.
func ScraperContext(
ctx context.Context,
receiverID config.ComponentID,
scraper config.ComponentID,
) context.Context {
ctx, _ = tag.New(
ctx,
tag.Upsert(obsmetrics.TagKeyReceiver, receiverID.String(), tag.WithTTL(tag.TTLNoPropagation)),
tag.Upsert(obsmetrics.TagKeyScraper, scraper.String(), tag.WithTTL(tag.TTLNoPropagation)))
return ctx
}
// Scraper is a helper to add observability to a component.Scraper.
type Scraper struct {
receiverID config.ComponentID
scraper config.ComponentID
tracer trace.Tracer
}
// ScraperSettings are settings for creating a Scraper.
type ScraperSettings struct {
ReceiverID config.ComponentID
Scraper config.ComponentID
}
// NewScraper creates a new Scraper.
func NewScraper(cfg ScraperSettings) *Scraper {
return &Scraper{
receiverID: cfg.ReceiverID,
scraper: cfg.Scraper,
tracer: otel.GetTracerProvider().Tracer(cfg.Scraper.String()),
}
}
// StartMetricsOp is called when a scrape operation is started. The
// returned context should be used in other calls to the obsreport functions
// dealing with the same scrape operation.
func (s *Scraper) StartMetricsOp(
scraperCtx context.Context,
) context.Context {
spanName := obsmetrics.ScraperPrefix + s.receiverID.String() + obsmetrics.NameSep + s.scraper.String() + obsmetrics.ScraperMetricsOperationSuffix
ctx, _ := s.tracer.Start(scraperCtx, spanName)
return ctx
}
// EndMetricsOp completes the scrape operation that was started with
// StartMetricsOp.
func (s *Scraper) EndMetricsOp(
scraperCtx context.Context,
numScrapedMetrics int,
err error,
) {
numErroredMetrics := 0
if err != nil {
if partialErr, isPartial := err.(scrapererror.PartialScrapeError); isPartial {
numErroredMetrics = partialErr.Failed
} else {
numErroredMetrics = numScrapedMetrics
numScrapedMetrics = 0
}
}
span := trace.SpanFromContext(scraperCtx)
if obsreportconfig.Level != configtelemetry.LevelNone {
stats.Record(
scraperCtx,
obsmetrics.ScraperScrapedMetricPoints.M(int64(numScrapedMetrics)),
obsmetrics.ScraperErroredMetricPoints.M(int64(numErroredMetrics)))
}
// end span according to errors
if span.IsRecording() {
span.SetAttributes(
attribute.String(obsmetrics.FormatKey, string(config.MetricsDataType)),
attribute.Int64(obsmetrics.ScrapedMetricPointsKey, int64(numScrapedMetrics)),
attribute.Int64(obsmetrics.ErroredMetricPointsKey, int64(numErroredMetrics)),
)
recordError(span, err)
}
span.End()
}