Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/whyeasy/sonarcloud-exporter

A Prometheus Exporter for SonarCloud
https://github.com/whyeasy/sonarcloud-exporter

golang observability prometheus prometheus-exporter sonarcloud

Last synced: about 1 month ago
JSON representation

A Prometheus Exporter for SonarCloud

Awesome Lists containing this project

README

        

![build](https://github.com/Whyeasy/sonarcloud-exporter/workflows/build/badge.svg)
![status-badge](https://goreportcard.com/badge/github.com/Whyeasy/sonarcloud-exporter)
![Github go.mod Go version](https://img.shields.io/github/go-mod/go-version/Whyeasy/sonarcloud-exporter)

# sonarcloud-exporter

A Prometheus Exporter for SonarCloud

Currently this exporter retrieves the following metrics:

- Project info within a given organization.
- Lines of Code within a project.
- Code Coverage of a project.
- Amount of bugs within a project.
- Amount of Code smells within a project.
- Amount of vulnerabilities within a project.

## Requirements

### Required

Provide your SonarCloud organization; `--organization ` or as env variable `SC_ORGANIZATION`.

Provide a SonarCloud Access Token to access the API; `--scToken ` or as env variable `SC_TOKEN`.

### Optional

Change listening port of the exporter; `--listenAddress ` or as env variable `LISTEN_ADDRESS`. Default = `8080`

Change listening path of the exporter; `--listenPath ` or as env variable `LISTEN_PATH`. Default = `/metrics`

## Helm

You can find a helm chart to install the exporter [here](https://github.com/Whyeasy/helm-charts/tree/master/charts/sonarcloud-exporter).