Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.39 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.39 KB

build status-badge Github go.mod Go version

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.
  • Quality gate status of project

Requirements

Required

Provide your SonarCloud organization; --organization <string> or as env variable SC_ORGANIZATION.

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

Optional

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

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

Add Metric Name; --metricsName comma-separated list of metrics to enable or as env variable METRICS_NAME. Default = all

Helm

You can find a helm chart to install the exporter here.