/
scraper.go
87 lines (71 loc) · 2.81 KB
/
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
// 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 internal
import (
"context"
"go.uber.org/zap"
"go.opentelemetry.io/collector/consumer/pdata"
)
// BaseScraper gathers metrics from the host machine.
type BaseScraper interface {
// Initialize performs any timely initialization tasks such as
// setting up performance counters for initial collection.
Initialize(ctx context.Context) error
// Close should clean up any unmanaged resources such as
// performance counter handles.
Close(ctx context.Context) error
}
// BaseFactory for creating Scrapers.
type BaseFactory interface {
// CreateDefaultConfig creates the default configuration for the Scraper.
CreateDefaultConfig() Config
}
// Scraper gathers metrics from the host machine.
type Scraper interface {
BaseScraper
// ScrapeMetrics returns relevant scraped metrics. If errors occur
// scraping some metrics, an error should be returned, but any
// metrics that were successfully scraped should still be returned.
ScrapeMetrics(ctx context.Context) (pdata.MetricSlice, error)
}
// ScraperFactory can create a MetricScraper.
type ScraperFactory interface {
BaseFactory
// CreateMetricsScraper creates a scraper based on this config.
// If the config is not valid, error will be returned instead.
CreateMetricsScraper(ctx context.Context, logger *zap.Logger, cfg Config) (Scraper, error)
}
// ResourceScraper gathers metrics from a low-level resource such as
// a process.
type ResourceScraper interface {
BaseScraper
// ScrapeMetrics returns relevant scraped metrics per resource.
// If errors occur scraping some metrics, an error should be
// returned, but any metrics that were successfully scraped
// should still be returned.
ScrapeMetrics(ctx context.Context) (pdata.ResourceMetricsSlice, error)
}
// ResourceScraperFactory can create a ResourceScraper.
type ResourceScraperFactory interface {
BaseFactory
// CreateMetricsScraper creates a resource scraper based on this
// config. If the config is not valid, error will be returned instead.
CreateMetricsScraper(ctx context.Context, logger *zap.Logger, cfg Config) (ResourceScraper, error)
}
// Config is the configuration of a scraper.
type Config interface {
}
// ConfigSettings provides common settings for scraper configuration.
type ConfigSettings struct {
}