添加优维定制化主机信息指标 (#3)

Co-authored-by: jimchen <[email protected]>

Author: JimChenWYU

receiver/hostmetricsreceiver/README.md

@@ -39,6 +39,7 @@ The available scrapers are:
 | Scraper      | Supported OSs                | Description                                            |
 | ------------ | ---------------------------- | ------------------------------------------------------ |
 | [cpu]        | All except Mac<sup>[1]</sup> | CPU utilization metrics                                |
+| [info]       | All                          | easyops host info                                      |
 | [disk]       | All except Mac<sup>[1]</sup> | Disk I/O metrics                                       |
 | [load]       | All                          | CPU load metrics                                       |
 | [filesystem] | All                          | File System utilization metrics                        |
@@ -49,6 +50,7 @@ The available scrapers are:
 | [process]    | Linux, Windows, Mac          | Per process CPU, Memory, and Disk I/O metrics          |
 
 [cpu]: ./internal/scraper/cpuscraper/documentation.md
+[info]: ./internal/scraper/infoscraper/documentation.md
 [disk]: ./internal/scraper/diskscraper/documentation.md
 [filesystem]: ./internal/scraper/filesystemscraper/documentation.md
 [load]: ./internal/scraper/loadscraper/documentation.md

receiver/hostmetricsreceiver/internal/scraper/infoscraper/config.go

@@ -0,0 +1,15 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package infoscraper // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/infoscraper"
+
+import (
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/infoscraper/internal/metadata"
+)
+
+// Config relating to Load Metric Scraper.
+type Config struct {
+	metadata.MetricsBuilderConfig `mapstructure:",squash"`
+	internal.ScraperConfig
+}

receiver/hostmetricsreceiver/internal/scraper/infoscraper/doc.go

@@ -0,0 +1,9 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build !windows
+// +build !windows
+
+//go:generate mdatagen metadata.yaml
+
+package infoscraper // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/infoscraper"

receiver/hostmetricsreceiver/internal/scraper/infoscraper/documentation.md

@@ -0,0 +1,29 @@
+[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
+
+# hostmetricsreceiver/info
+
+## Default Metrics
+
+The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:
+
+```yaml
+metrics:
+  <metric_name>:
+    enabled: false
+```
+
+### info.now
+
+unix timestamp.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| 1 | Gauge | Double |
+
+## Resource Attributes
+
+| Name | Description | Values | Enabled |
+| ---- | ----------- | ------ | ------- |
+| info.cpuNum | cpu num. | Any Int | true |
+| info.hostname | hostname. | Any Str | true |
+| info.org | common org. | Any Str | true |

receiver/hostmetricsreceiver/internal/scraper/infoscraper/factory.go

@@ -0,0 +1,49 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package infoscraper // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/infoscraper"
+
+import (
+	"context"
+
+	"go.opentelemetry.io/collector/receiver"
+	"go.opentelemetry.io/collector/receiver/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/infoscraper/internal/metadata"
+)
+
+// This file implements Factory for Load scraper.
+
+const (
+	// TypeStr the value of "type" key in configuration.
+	TypeStr = "info"
+)
+
+// Factory is the Factory for scraper.
+type Factory struct {
+}
+
+// CreateDefaultConfig creates the default configuration for the Scraper.
+func (f *Factory) CreateDefaultConfig() internal.Config {
+	return &Config{
+		MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
+	}
+}
+
+// CreateMetricsScraper creates a scraper based on provided config.
+func (f *Factory) CreateMetricsScraper(
+	ctx context.Context,
+	settings receiver.CreateSettings,
+	config internal.Config,
+) (scraperhelper.Scraper, error) {
+	cfg := config.(*Config)
+	s := newInfoScraper(ctx, settings, cfg)
+
+	return scraperhelper.NewScraper(
+		TypeStr,
+		s.scrape,
+		scraperhelper.WithStart(s.start),
+		scraperhelper.WithShutdown(s.shutdown),
+	)
+}

receiver/hostmetricsreceiver/internal/scraper/infoscraper/factory_test.go

@@ -0,0 +1,64 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package infoscraper
+
+import (
+	"context"
+	"testing"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal"
+	"github.com/stretchr/testify/assert"
+	"go.opentelemetry.io/collector/receiver"
+)
+
+func TestFactory_CreateDefaultConfig(t *testing.T) {
+	tests := []struct {
+		name string
+		f    *Factory
+		want internal.Config
+	}{
+		{
+			f:    &Factory{},
+			want: &Config{},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := tt.f.CreateDefaultConfig()
+			assert.IsType(t, got, tt.want)
+		})
+	}
+}
+
+func TestFactory_CreateMetricsScraper(t *testing.T) {
+	type args struct {
+		settings receiver.CreateSettings
+		config   internal.Config
+	}
+	tests := []struct {
+		name    string
+		f       *Factory
+		args    args
+		wantErr bool
+	}{
+		{
+			f: &Factory{},
+			args: args{
+				settings: receiver.CreateSettings{},
+				config:   &Config{},
+			},
+			wantErr: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := tt.f.CreateMetricsScraper(context.Background(), tt.args.settings, tt.args.config)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("Factory.CreateMetricsScraper() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			assert.NotNil(t, got)
+		})
+	}
+}

receiver/hostmetricsreceiver/internal/scraper/infoscraper/info_scraper.go

@@ -0,0 +1,83 @@
+// TODO: support windows
+package infoscraper // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/infoscraper"
+
+import (
+	"context"
+	"os"
+	"runtime"
+	"time"
+
+	"github.com/shirou/gopsutil/v3/host"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/pdata/pcommon"
+	"go.opentelemetry.io/collector/pdata/pmetric"
+	"go.opentelemetry.io/collector/receiver"
+	"go.opentelemetry.io/collector/receiver/scrapererror"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/infoscraper/internal/metadata"
+)
+
+const metricsLen = 1
+
+// scraper for Load Metrics
+type scraper struct {
+	settings receiver.CreateSettings
+	config   *Config
+	mb       *metadata.MetricsBuilder
+
+	hostname func() (name string, err error)
+	now      func() time.Time
+	cpuNum   func() int
+	org      func() string
+	// for mocking
+	bootTime func() (uint64, error)
+}
+
+func newInfoScraper(_ context.Context, settings receiver.CreateSettings, cfg *Config) *scraper {
+	return &scraper{
+		settings: settings,
+		config:   cfg,
+
+		now:      time.Now,
+		hostname: os.Hostname,
+		cpuNum:   runtime.NumCPU,
+		org:      org,
+
+		bootTime: host.BootTime,
+	}
+}
+
+func (s *scraper) start(ctx context.Context, _ component.Host) error {
+	bootTime, err := s.bootTime()
+	if err != nil {
+		return err
+	}
+
+	s.mb = metadata.NewMetricsBuilder(s.config.MetricsBuilderConfig, s.settings, metadata.WithStartTime(pcommon.Timestamp(bootTime*1e9)))
+	return nil
+}
+
+// shutdown
+func (s *scraper) shutdown(ctx context.Context) error {
+	return nil
+}
+
+// scrape
+func (s *scraper) scrape(_ context.Context) (pmetric.Metrics, error) {
+	now := pcommon.NewTimestampFromTime(s.now())
+	s.mb.RecordInfoNowDataPoint(now, float64(now.AsTime().Unix()))
+
+	hostname, err := s.hostname()
+	if err != nil {
+		return pmetric.NewMetrics(), scrapererror.NewPartialScrapeError(err, metricsLen)
+	}
+	return s.mb.Emit(
+		metadata.WithInfoOrg(org()),
+		metadata.WithInfoCPUNum(int64(s.cpuNum())),
+		metadata.WithInfoHostname(hostname),
+	), nil
+}
+
+func org() string {
+	return os.Getenv("EASY_ENV_COMMON_ORG")
+}