boshupdate_exporter

GithubRelease Prometheus Exporter

A Prometheus exporter for Github. The exporter exports informational metrics about available releases on github. It is also capable of analyzing [BOSH][bosh] deployment manifests in order to extract recommended versions of [BOSH][bosh] releases.

Installation

Binaries

Download the already existing binaries for your platform:

$ ./githubrelease_exporter <flags>

Docker

To run the githubrelease exporter as a Docker container, run:

$ docker run -p 9362:9362 orangeopensource/githubrelease-exporter <flags>

BOSH

This exporter can be deployed using the [Githubexporter BOSH Release][githubexporter-boshrelease].

Usage

Github Token

In order to connect to the Github API a token must be provided. The token can be created by following the Github HowTo

Configuration

The provided sample configuration is a good starting point.

Detailed Specification

• General structure

github-token: <string> # valid token for github api
bosh-deployment: map[string, *deployment*]
github-release:  map[string, *release*]

• deployment

<name>:
    types: *release-types*
    format: *release-formatter*
    owner: <string>     # github project's owner or organization
    repo: <string>      # github project's name
    manifest: <string>  # remote path to main BOSH manifest
    ops: list[string]   # list of remote ops-file paths to apply to main manifest
    vars: list[string]  # list of remote vars-file paths to apply to main manifest

• release

<name>:
    types: *release-types*
    format: *release-formatter*
    owner: <string>     # github project's owner or organization
    repo: <string>      # github project's name

• types

# List of objects types to consider as a release.
list[string]

# String must be one or more of the following values:
# - release:       Github release which is neither in 'draft' nor 'pre' state
# - pre_release:   Github release in 'pre' state
# - draft_release: Github release in 'draft' state
# - tag:           Github tag

• format

# Format tells how to parse detected release name into a version
format:
  match: <regexp>   # a regex to match release name
  replace: <string> # a replacement for matched release name

# When not provided, the default format value is
# format:
#   match: "v([0-9.]+)"
#  replace: "${1}"

Flags

Metrics

The exporter returns the following metrics:

Contributing

Refer to the contributing guidelines.

License

Apache License 2.0, see LICENSE.