initial github enhancement

plugins/inputs/all/all.go

@@ -48,6 +48,7 @@ import (
 	_ "github.com/influxdata/telegraf/plugins/inputs/fireboard"
 	_ "github.com/influxdata/telegraf/plugins/inputs/fluentd"
 	_ "github.com/influxdata/telegraf/plugins/inputs/github"
+	_ "github.com/influxdata/telegraf/plugins/inputs/githubenhance"
 	_ "github.com/influxdata/telegraf/plugins/inputs/graylog"
 	_ "github.com/influxdata/telegraf/plugins/inputs/haproxy"
 	_ "github.com/influxdata/telegraf/plugins/inputs/hddtemp"

plugins/inputs/githubenhance/README.md

@@ -0,0 +1,21 @@
+# GitHub Enhanced Input Plugin
+
+Gather Pull Requests, Commits, and Issues information from [GitHub][] hosted repositories.
+
+### Configuration
+
+```toml
+[[inputs.githubenhanced]]
+  ## List of repositories to monitor
+  repositories = [
+	  "influxdata/telegraf",
+	  "influxdata/influxdb"
+  ]
+
+  ## Github API access token.  Unauthenticated requests are limited to 60 per hour.
+  # access_token = ""
+```
+
+### Metrics
+TODO
+

plugins/inputs/githubenhance/githubenhance.go

@@ -0,0 +1,287 @@
+package githubenhance
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/google/go-github/github"
+	"github.com/influxdata/telegraf"
+	"github.com/influxdata/telegraf/internal"
+	"github.com/influxdata/telegraf/plugins/inputs"
+	"github.com/influxdata/telegraf/selfstat"
+	"golang.org/x/oauth2"
+)
+
+// GitHub - plugin main structure
+type GitHub struct {
+	Repositories      []string          `toml:"repositories"`
+	AccessToken       string            `toml:"access_token"`
+	EnterpriseBaseURL string            `toml:"enterprise_base_url"`
+	HTTPTimeout       internal.Duration `toml:"http_timeout"`
+	githubClient      *github.Client
+
+	obfusticatedToken string
+
+	RateLimit       selfstat.Stat
+	RateLimitErrors selfstat.Stat
+	RateRemaining   selfstat.Stat
+}
+
+const sampleConfig = `
+  ## List of repositories to monitor.
+  repositories = [
+	  "communitybridge/ledger",
+  ]
+
+  ## Github API access token.  Unauthenticated requests are limited to 60 per hour.
+  # access_token = ""
+
+  ## Github API enterprise url. Github Enterprise accounts must specify their base url.
+  # enterprise_base_url = ""
+
+  ## Timeout for HTTP requests.
+  # http_timeout = "5s"
+`
+
+// SampleConfig returns sample configuration for this plugin.
+func (g *GitHub) SampleConfig() string {
+	return sampleConfig
+}
+
+// Description returns the plugin description.
+func (g *GitHub) Description() string {
+	return "Gather Pull Requests, Commits, and Issues information from github hosted repositories."
+}
+
+// Create GitHub Client
+func (g *GitHub) createGitHubClient(ctx context.Context) (*github.Client, error) {
+	httpClient := &http.Client{
+		Transport: &http.Transport{
+			Proxy: http.ProxyFromEnvironment,
+		},
+		Timeout: g.HTTPTimeout.Duration,
+	}
+
+	g.obfusticatedToken = "Unauthenticated"
+
+	if g.AccessToken != "" {
+		tokenSource := oauth2.StaticTokenSource(
+			&oauth2.Token{AccessToken: g.AccessToken},
+		)
+		oauthClient := oauth2.NewClient(ctx, tokenSource)
+		ctx = context.WithValue(ctx, oauth2.HTTPClient, oauthClient)
+
+		g.obfusticatedToken = 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 dumpMap(space string, m map[string]interface{}) {
+	for k, v := range m {
+		if mv, ok := v.(map[string]interface{}); ok {
+			fmt.Printf("{ \"%v\": \n", k)
+			dumpMap(space+"\t", mv)
+			fmt.Printf("}\n")
+		} else {
+			fmt.Printf("%v %v : %v\n", space, k, v)
+		}
+	}
+}
+
+// Gather GitHub Metrics
+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.obfusticatedToken,
+		}
+
+		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)
+	}
+
+	for _, repository := range g.Repositories {
+
+		owner, repository, err := splitRepositoryName(repository)
+		if err != nil {
+			acc.AddError(err)
+			return nil
+		}
+
+		repositoryInfo, response, err := g.githubClient.Repositories.Get(ctx, owner, repository)
+
+		if _, ok := err.(*github.RateLimitError); ok {
+			g.RateLimitErrors.Incr(1)
+		}
+
+		if err != nil {
+			acc.AddError(err)
+			return nil
+		}
+
+		g.RateLimit.Set(int64(response.Rate.Limit))
+		g.RateRemaining.Set(int64(response.Rate.Remaining))
+
+		now := time.Now()
+		tags := getTags(repositoryInfo)
+		fields := getFields(repositoryInfo)
+
+		acc.AddFields("github_repository", fields, tags, now)
+
+		// Repository PullRequest data
+		pullRequestListOptions := github.PullRequestListOptions{State: "all"}
+		pullRequests, _, err := g.githubClient.PullRequests.List(ctx, owner, repository, &pullRequestListOptions)
+		for _, pullRequest := range pullRequests {
+
+			pullRequestJSON, err := json.Marshal(pullRequest)
+			if err != nil {
+				fmt.Println(err)
+			}
+
+			pullRequestFields := make(map[string]interface{})
+			err = json.Unmarshal([]byte(pullRequestJSON), &pullRequestFields)
+			if err != nil {
+				panic(err)
+			}
+
+			// User
+			if pullRequest.User != nil {
+				pullRequestFields["user_id"] = pullRequest.User.ID
+				pullRequestFields["user_login"] = pullRequest.User.Login
+				pullRequestFields["user_name"] = pullRequest.User.Name
+				pullRequestFields["user_avatar_url"] = pullRequest.User.AvatarURL
+			}
+
+			// Assignee
+			if pullRequest.Assignee != nil {
+				pullRequestFields["assignee_id"] = pullRequest.Assignee.ID
+				pullRequestFields["assignee_login"] = pullRequest.Assignee.Login
+				pullRequestFields["assignee_name"] = pullRequest.Assignee.Name
+				pullRequestFields["assignee_avatar_url"] = pullRequest.Assignee.AvatarURL
+			}
+
+			// Merger
+			if pullRequest.MergedBy != nil {
+				pullRequestFields["merger_id"] = pullRequest.MergedBy.ID
+				pullRequestFields["merger_login"] = pullRequest.MergedBy.Login
+				pullRequestFields["merger_name"] = pullRequest.MergedBy.Name
+				pullRequestFields["merger_avatar_url"] = pullRequest.MergedBy.AvatarURL
+			}
+
+			pullRequestTags := map[string]string{
+				"pull_request_id": strconv.FormatUint(uint64(*pullRequest.ID), 10),
+			}
+
+			acc.AddFields("github_pull_requests", pullRequestFields, pullRequestTags, time.Now())
+		}
+
+		// Repository commit data
+		commitsListOptions := github.CommitsListOptions{}
+		commits, _, err := g.githubClient.Repositories.ListCommits(ctx, owner, repository, &commitsListOptions)
+		for _, commit := range commits {
+
+			commitJSON, err := json.Marshal(commit)
+			if err != nil {
+				fmt.Println(err)
+			}
+
+			commitFields := make(map[string]interface{})
+			err = json.Unmarshal([]byte(commitJSON), &commitFields)
+			if err != nil {
+				panic(err)
+			}
+
+			// Author
+			commitFields["author_id"] = commit.Author.ID
+			commitFields["author_login"] = commit.Author.Login
+			commitFields["author_name"] = commit.Author.Name
+			commitFields["author_avatar_url"] = commit.Author.AvatarURL
+
+			// Committer
+			commitFields["committer_id"] = commit.Committer.ID
+			commitFields["committer_login"] = commit.Committer.Login
+			commitFields["committer_name"] = commit.Committer.Name
+			commitFields["committer_avatar_url"] = commit.Committer.AvatarURL
+
+			commitTags := map[string]string{
+				"commit_sha": *commit.SHA,
+			}
+
+			acc.AddFields("github_commits", commitFields, commitTags, time.Now())
+		}
+	}
+
+	return nil
+}
+
+func splitRepositoryName(repositoryName string) (string, string, 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 init() {
+	inputs.Add("githubenhance", func() telegraf.Input {
+		return &GitHub{
+			HTTPTimeout: internal.Duration{Duration: time.Second * 5},
+		}
+	})
+}