feat(api): add gitlab host metric (#4)

* feature: add gitlab host metric

* docs + changelog

* tests

---------

Co-authored-by: lexander023 <aleksander@scensei.com>

Author: AleksanderWWW

CHANGELOG.md

@@ -1,4 +1,7 @@
-## [UNRELEASED] prometheus-gitlabci-exporter 0.1.1
+## [UNRELEASED] prometheus-gitlabci-exporter 0.2.0
+
+### Features
+- add GitLab host name metrics ([#4](https://github.com/AleksanderWWW/prometheus-gitlabci-exporter/pull/4))
 
 ### Changes
 - refactor to make code more testable ([#3](https://github.com/AleksanderWWW/prometheus-gitlabci-exporter/pull/3))

README.md

@@ -162,6 +162,8 @@ scrape_configs:
 | `gitlab_pipeline_total` | Counter | Number of pipelines by status |
 | `gitlab_pipeline_last_duration_seconds` | Gauge | Duration of the latest pipeline |
 | `gitlab_probe_success` | Gauge | Indicates if the exporter successfully queried GitLab |
+| `gitlab_host` | Gauge | Host name of the GitLab instance |
+| `exporter_probe_duration_seconds` | Gauge | Duration of the probe in seconds |
 
 ---
 

go.mod

@@ -5,18 +5,21 @@ go 1.24.2
 require (
 	github.com/alecthomas/kingpin/v2 v2.4.0
 	github.com/prometheus/client_golang v1.23.2
+	github.com/stretchr/testify v1.11.1
 	gitlab.com/gitlab-org/api/client-go v0.157.0
 )
 
 require (
 	github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.8 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.6.2 // indirect
 	github.com/prometheus/common v0.66.1 // indirect
 	github.com/prometheus/procfs v0.16.1 // indirect
@@ -27,4 +30,5 @@ require (
 	golang.org/x/sys v0.35.0 // indirect
 	golang.org/x/time v0.12.0 // indirect
 	google.golang.org/protobuf v1.36.10 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

internal/desc.go

@@ -7,6 +7,7 @@ func Describe(ch chan<- *prometheus.Desc) {
 	ch <- successDesc
 	ch <- latestDurationDesc
 	ch <- probeDurationDesc
+	ch <- gitlabHostDesc
 }
 
 var pipelineTotalDesc = prometheus.NewDesc(
@@ -36,3 +37,10 @@ var probeDurationDesc = prometheus.NewDesc(
 	nil,
 	nil,
 )
+
+var gitlabHostDesc = prometheus.NewDesc(
+	"gitlab_host",
+	"Host name of the GitLab instance",
+	[]string{"instance"},
+	nil,
+)

internal/metrics.go

@@ -25,6 +25,7 @@ type Metrics struct {
 	Count          PipelineCount
 	LatestDuration float64
 	ProbeDuration  float64
+	GitlabHost     string
 }
 
 func GetMetrics(client *gitlab.Client, opts *GitlabScrapeOpts) (*Metrics, error) {
@@ -82,5 +83,6 @@ func GetMetrics(client *gitlab.Client, opts *GitlabScrapeOpts) (*Metrics, error)
 		Count:          pc,
 		LatestDuration: duration,
 		ProbeDuration:  probeDuration.Seconds(),
+		GitlabHost:     client.BaseURL().Hostname(),
 	}, nil
 }

internal/send.go

@@ -13,6 +13,7 @@ func (df *DefaultMetricsSender) SendMetrics(ch chan<- prometheus.Metric, metrics
 	sendProbeStatus(ch, true)
 	sendLatestDuration(ch, metrics.LatestDuration)
 	sendProbeDuration(ch, metrics.ProbeDuration)
+	sendGitlabHost(ch, metrics.GitlabHost)
 }
 
 func sendPipelineCountByStatus(ch chan<- prometheus.Metric, metrics *Metrics, opts *GitlabScrapeOpts) {
@@ -80,3 +81,12 @@ func sendProbeDuration(ch chan<- prometheus.Metric, duration float64) {
 		duration,
 	)
 }
+
+func sendGitlabHost(ch chan<- prometheus.Metric, host string) {
+	ch <- prometheus.MustNewConstMetric(
+		gitlabHostDesc,
+		prometheus.GaugeValue,
+		1,
+		host,
+	)
+}

main_test.go

@@ -7,11 +7,13 @@ import (
 	"os"
 	"strings"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
-func TestAPI(t *testing.T) {
-	client := &http.Client{}
+var client *http.Client = &http.Client{}
 
+func TestAPI(t *testing.T) {
 	baseUrl := os.Getenv("TEST_BASE_URL")
 	if baseUrl == "" {
 		baseUrl = "http://localhost:9115/probe"
@@ -64,6 +66,36 @@ func TestAPI(t *testing.T) {
 	}
 }
 
+func TestResponseContent(t *testing.T) {
+	baseUrl := os.Getenv("TEST_BASE_URL")
+	if baseUrl == "" {
+		baseUrl = "http://localhost:9115/probe"
+	}
+
+	url := fmt.Sprintf("%s?group=%s&project=%s", baseUrl, "alwojnarowicz", "some-project1")
+	req, err := http.NewRequest("GET", url, nil)
+	if err != nil {
+		t.Fatalf("creating request: %v", err)
+	}
+
+	resp, err := client.Do(req)
+	if err != nil {
+		t.Fatalf("making request: %v", err)
+	}
+	defer saveCloseRespBody(resp)
+
+	bodyText, err := io.ReadAll(resp.Body)
+	if err != nil {
+		t.Fatalf("reading response body: %v", err)
+	}
+
+	assert.Contains(t, string(bodyText), "gitlab_probe_success")
+	assert.Contains(t, string(bodyText), "gitlab_host")
+	assert.Contains(t, string(bodyText), "gitlab_pipeline_total")
+	assert.Contains(t, string(bodyText), "gitlab_pipeline_total")
+	assert.Contains(t, string(bodyText), "exporter_probe_duration_seconds")
+}
+
 func saveCloseRespBody(resp *http.Response) {
 	err := resp.Body.Close()
 	if err != nil {