gitproviderreceiver

README

Git Provider Receiver

Status
Stability	development: metrics
Distributions	liatrio
Issues

The Git Provider receiver scrapes data from Git vendors.

As a starting point, this receiver can infer many of the same core git metrics across vendors, while being able to receive additional data specific to vendors.

The current default set of metrics common across all vendors can be found in documentation.md.

These default metrics can be used as leading indicators to the DORA metrics; helping provide insight into modern-day engineering practices.

GitHub Metrics

The current metrics available via scraping from GitHub are:

• Repository count
• Repository branch time
• Repository branch count
• Repository contributor count
• Repository pull request time
• Repository pull request merge time
• Repository pull request approval time
• Repository pull request deployment time

Note: Some metrics may be disabled by default and have to be explicitly enabled. For example, the repository contributor count metric is one such metric. This is because this metric relies on the REST API which is subject to lower rate limits.

GitLab Metrics

The current metrics available via scraping from GitLab are:

• Repository count
• Repository branch time
• Repository branch count
• Repository contributor count
• Repository pull request time
• Repository pull request merge time
• Repository pull request approval time
• Repository pull request deployment time

Getting Started

The collection interval is common to all scrapers and is set to 30 seconds by default.

Note: Generally speaking, if the vendor allows for anonymous API calls, then you won't have to configure any authentication, but you may only see public repositories and organizations.

gitprovider:
    collection_interval: <duration> #default = 30s
    scrapers:
        <scraper1>:
        <scraper2>:
        ...

A more complete example using the GitHub & GitLab scrapers with authentication is as follows:

extensions:
    basicauth/github:
        client_auth:
            username: ${env:GH_USER}
            password: ${env:GH_PAT}
    bearertokenauth/gitlab:
        token: ${env:GITLAB_PAT}

receivers:
    gitprovider:
        initial_delay: 1s
        collection_interval: 60s
        scrapers:
            github:
                metrics:
                    git.repository.contributor.count:
                        enabled: true
                github_org: myfancyorg
                search_query: "org:myfancyorg topic:o11yalltheway" #optional query override, defaults to "{org,user}:<github_org>"
                endpoint: "https://selfmanagedenterpriseserver.com"
                auth:
                    authenticator: basicauth/github
service:
    extensions: [basicauth/github, bearertokenauth/gitlab]
    pipelines:
        metrics:
            receivers: [..., gitprovider]
            processors: []
            exporters: [...]

This receiver is developed upstream in the liatrio-otel-collector distribution where a quick start exists with an example config

The available scrapers are:

Scraper	Description
[github]	Git Metrics from GitHub
[gitlab]	Git Metrics from GitLab

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (cfg *Config) Unmarshal(componentParser *confmap.Conf) error
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for the git provider receiver

Types

type Config

type Config struct {
	scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
	Scrapers                                map[string]internal.Config `mapstructure:"scrapers"`
	metadata.MetricsBuilderConfig           `mapstructure:",squash"`
}

Config that is exposed to this github receiver through the OTEL config.yaml

func (*Config) Unmarshal

func (cfg *Config) Unmarshal(componentParser *confmap.Conf) error

Unmarshal a config.Parser into the config struct.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate the configuration passed through the OTEL config.yaml