Adding upstream version 1.34.4.

Signed-off-by: Daniel Baumann <daniel@debian.org>

plugins/inputs/github/github.go

@@ -0,0 +1,229 @@
+//go:generate ../../../tools/readme_config_includer/generator
+package github
+
+import (
+	"context"
+	_ "embed"
+	"errors"
+	"fmt"
+	"net/http"
+	"strings"
+	"sync"
+	"time"
+
+	"github.com/google/go-github/v32/github"
+	"golang.org/x/oauth2"
+
+	"github.com/influxdata/telegraf"
+	"github.com/influxdata/telegraf/config"
+	"github.com/influxdata/telegraf/plugins/inputs"
+	"github.com/influxdata/telegraf/selfstat"
+)
+
+//go:embed sample.conf
+var sampleConfig string
+
+type GitHub struct {
+	Repositories      []string        `toml:"repositories"`
+	AccessToken       string          `toml:"access_token"`
+	AdditionalFields  []string        `toml:"additional_fields"`
+	EnterpriseBaseURL string          `toml:"enterprise_base_url"`
+	HTTPTimeout       config.Duration `toml:"http_timeout"`
+
+	githubClient    *github.Client
+	obfuscatedToken string
+
+	rateLimit       selfstat.Stat
+	rateLimitErrors selfstat.Stat
+	rateRemaining   selfstat.Stat
+}
+
+func (*GitHub) SampleConfig() string {
+	return sampleConfig
+}
+
+func (g *GitHub) Gather(acc telegraf.Accumulator) error {
+	ctx := context.Background()
+
+	if g.githubClient == nil {
+		githubClient, err := g.createGitHubClient(ctx)
+		if err != nil {
+			return err
+		}
+
+		g.githubClient = githubClient
+
+		tokenTags := map[string]string{
+			"access_token": g.obfuscatedToken,
+		}
+
+		g.rateLimitErrors = selfstat.Register("github", "rate_limit_blocks", tokenTags)
+		g.rateLimit = selfstat.Register("github", "rate_limit_limit", tokenTags)
+		g.rateRemaining = selfstat.Register("github", "rate_limit_remaining", tokenTags)
+	}
+
+	var wg sync.WaitGroup
+	wg.Add(len(g.Repositories))
+
+	for _, repository := range g.Repositories {
+		go func(repositoryName string, acc telegraf.Accumulator) {
+			defer wg.Done()
+
+			owner, repository, err := splitRepositoryName(repositoryName)
+			if err != nil {
+				acc.AddError(err)
+				return
+			}
+
+			repositoryInfo, response, err := g.githubClient.Repositories.Get(ctx, owner, repository)
+			g.handleRateLimit(response, err)
+			if err != nil {
+				acc.AddError(err)
+				return
+			}
+
+			now := time.Now()
+			tags := getTags(repositoryInfo)
+			fields := getFields(repositoryInfo)
+
+			for _, field := range g.AdditionalFields {
+				switch field {
+				case "pull-requests":
+					// Pull request properties
+					addFields, err := g.getPullRequestFields(ctx, owner, repository)
+					if err != nil {
+						acc.AddError(err)
+						continue
+					}
+
+					for k, v := range addFields {
+						fields[k] = v
+					}
+				default:
+					acc.AddError(fmt.Errorf("unknown additional field %q", field))
+					continue
+				}
+			}
+
+			acc.AddFields("github_repository", fields, tags, now)
+		}(repository, acc)
+	}
+
+	wg.Wait()
+	return nil
+}
+
+func (g *GitHub) createGitHubClient(ctx context.Context) (*github.Client, error) {
+	httpClient := &http.Client{
+		Transport: &http.Transport{
+			Proxy: http.ProxyFromEnvironment,
+		},
+		Timeout: time.Duration(g.HTTPTimeout),
+	}
+
+	g.obfuscatedToken = "Unauthenticated"
+
+	if g.AccessToken != "" {
+		tokenSource := oauth2.StaticTokenSource(
+			&oauth2.Token{AccessToken: g.AccessToken},
+		)
+		oauthClient := oauth2.NewClient(ctx, tokenSource)
+		_ = context.WithValue(ctx, oauth2.HTTPClient, oauthClient)
+
+		g.obfuscatedToken = g.AccessToken[0:4] + "..." + g.AccessToken[len(g.AccessToken)-3:]
+
+		return g.newGithubClient(oauthClient)
+	}
+
+	return g.newGithubClient(httpClient)
+}
+
+func (g *GitHub) newGithubClient(httpClient *http.Client) (*github.Client, error) {
+	if g.EnterpriseBaseURL != "" {
+		return github.NewEnterpriseClient(g.EnterpriseBaseURL, "", httpClient)
+	}
+	return github.NewClient(httpClient), nil
+}
+
+func (g *GitHub) handleRateLimit(response *github.Response, err error) {
+	var rlErr *github.RateLimitError
+	if err == nil {
+		g.rateLimit.Set(int64(response.Rate.Limit))
+		g.rateRemaining.Set(int64(response.Rate.Remaining))
+	} else if errors.As(err, &rlErr) {
+		g.rateLimitErrors.Incr(1)
+	}
+}
+
+func splitRepositoryName(repositoryName string) (owner, repository string, err error) {
+	splits := strings.SplitN(repositoryName, "/", 2)
+
+	if len(splits) != 2 {
+		return "", "", fmt.Errorf("%v is not of format 'owner/repository'", repositoryName)
+	}
+
+	return splits[0], splits[1], nil
+}
+
+func getLicense(rI *github.Repository) string {
+	if licenseName := rI.GetLicense().GetName(); licenseName != "" {
+		return licenseName
+	}
+
+	return "None"
+}
+
+func getTags(repositoryInfo *github.Repository) map[string]string {
+	return map[string]string{
+		"owner":    repositoryInfo.GetOwner().GetLogin(),
+		"name":     repositoryInfo.GetName(),
+		"language": repositoryInfo.GetLanguage(),
+		"license":  getLicense(repositoryInfo),
+	}
+}
+
+func getFields(repositoryInfo *github.Repository) map[string]interface{} {
+	return map[string]interface{}{
+		"stars":       repositoryInfo.GetStargazersCount(),
+		"subscribers": repositoryInfo.GetSubscribersCount(),
+		"watchers":    repositoryInfo.GetWatchersCount(),
+		"networks":    repositoryInfo.GetNetworkCount(),
+		"forks":       repositoryInfo.GetForksCount(),
+		"open_issues": repositoryInfo.GetOpenIssuesCount(),
+		"size":        repositoryInfo.GetSize(),
+	}
+}
+
+func (g *GitHub) getPullRequestFields(ctx context.Context, owner, repo string) (map[string]interface{}, error) {
+	options := github.SearchOptions{
+		TextMatch: false,
+		ListOptions: github.ListOptions{
+			PerPage: 100,
+			Page:    1,
+		},
+	}
+
+	classes := []string{"open", "closed"}
+	fields := make(map[string]interface{})
+	for _, class := range classes {
+		q := fmt.Sprintf("repo:%s/%s is:pr is:%s", owner, repo, class)
+		searchResult, response, err := g.githubClient.Search.Issues(ctx, q, &options)
+		g.handleRateLimit(response, err)
+		if err != nil {
+			return fields, err
+		}
+
+		f := class + "_pull_requests"
+		fields[f] = searchResult.GetTotal()
+	}
+
+	return fields, nil
+}
+
+func init() {
+	inputs.Add("github", func() telegraf.Input {
+		return &GitHub{
+			HTTPTimeout: config.Duration(time.Second * 5),
+		}
+	})
+}