mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-20 05:27:12 +03:00
85 lines
2.6 KiB
Go
85 lines
2.6 KiB
Go
// Copyright 2021 Security Scorecard 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 monitoring defines exporters to be used by opencensus package in the cron job.
|
|
package monitoring
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"time"
|
|
|
|
"contrib.go.opencensus.io/exporter/stackdriver"
|
|
"contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp"
|
|
"go.opencensus.io/stats/view"
|
|
|
|
"github.com/ossf/scorecard/v2/cron/config"
|
|
)
|
|
|
|
var errorUndefinedExporter = errors.New("unsupported exporterType")
|
|
|
|
type exporterType string
|
|
|
|
const (
|
|
stackdriverMetricPrefix = "scorecard-cron"
|
|
stackdriverTimeSeriesQuota = 200
|
|
stackdriverTimeoutMinutes = 10
|
|
stackDriver exporterType = "stackdriver"
|
|
printer exporterType = "printer"
|
|
)
|
|
|
|
// Exporter interface is a custom wrapper to represent an opencensus exporter.
|
|
type Exporter interface {
|
|
ExportView(viewData *view.Data)
|
|
StartMetricsExporter() error
|
|
StopMetricsExporter()
|
|
Flush()
|
|
}
|
|
|
|
// GetExporter defines a factory for returning opencensus Exporter.
|
|
func GetExporter() (Exporter, error) {
|
|
exporter, err := config.GetMetricExporter()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error during GetMetricExporter: %w", err)
|
|
}
|
|
switch exporterType(exporter) {
|
|
case stackDriver:
|
|
return newStackDriverExporter()
|
|
case printer:
|
|
return new(printerExporter), nil
|
|
default:
|
|
return nil, fmt.Errorf("%w: %s", errorUndefinedExporter, exporter)
|
|
}
|
|
}
|
|
|
|
func newStackDriverExporter() (*stackdriver.Exporter, error) {
|
|
projectID, err := config.GetProjectID()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error getting ProjectID: %w", err)
|
|
}
|
|
exporter, err := stackdriver.NewExporter(stackdriver.Options{
|
|
ProjectID: projectID,
|
|
MetricPrefix: stackdriverMetricPrefix,
|
|
MonitoredResource: gcp.Autodetect(),
|
|
Timeout: stackdriverTimeoutMinutes * time.Minute,
|
|
// Stackdriver specific quotas based on https://cloud.google.com/monitoring/quotas
|
|
// `Time series included in a request`
|
|
BundleCountThreshold: stackdriverTimeSeriesQuota,
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error during stackdriver.NewExporter: %w", err)
|
|
}
|
|
return exporter, nil
|
|
}
|