Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add in progress tasks metric #275

Merged
merged 2 commits into from
Apr 8, 2024
Merged

chore: add in progress tasks metric #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a95730d
chore: add in progress tasks metric
shini4i Apr 6, 2024
2e99c18
fix logic
shini4i Apr 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions cmd/argo-watcher/argocd/argo_status_updater.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ func (updater *ArgoStatusUpdater) collectInitialAppStatus(task *models.Task) err
}

func (updater *ArgoStatusUpdater) WaitForRollout(task models.Task) {
// increment in progress task counter
updater.argo.metrics.AddInProgressTask()

// notify about the deployment start
sendWebhookEvent(task, updater.webhookService)

Expand All @@ -85,6 +88,8 @@ func (updater *ArgoStatusUpdater) WaitForRollout(task models.Task) {
updater.argo.metrics.AddFailedDeployment(task.App)
// update task status regarding failure
updater.handleArgoAPIFailure(task, err)
// decrement in progress task counter
updater.argo.metrics.RemoveInProgressTask()
return
}

Expand Down Expand Up @@ -118,6 +123,9 @@ func (updater *ArgoStatusUpdater) WaitForRollout(task models.Task) {
task.Status = models.StatusFailedMessage
}

// decrement in progress task counter
updater.argo.metrics.RemoveInProgressTask()

// send webhook event about the deployment result
sendWebhookEvent(task, updater.webhookService)
}
Expand Down
20 changes: 20 additions & 0 deletions cmd/argo-watcher/argocd/argo_status_updater_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(&application, nil).Times(3)
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().ResetFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusDeployedMessage, "")

// run the rollout
Expand Down Expand Up @@ -107,7 +109,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {
// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(&unhealthyApp, nil).Times(2)
apiMock.EXPECT().GetApplication(task.App).Return(&healthyApp, nil).Times(1)
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().ResetFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusDeployedMessage, "")

// run the rollout
Expand Down Expand Up @@ -148,7 +152,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(&application, nil).Times(3)
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().ResetFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusDeployedMessage, "")

// run the rollout
Expand Down Expand Up @@ -189,7 +195,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(&application, nil).Times(3)
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().AddFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusFailedMessage,
"Application deployment failed. Rollout status \"not available\"\n\nList of current images (last app check):\n\ttest-registry/ghcr.io/shini4i/argo-watcher:dev\n\nList of expected images:\n\tghcr.io/shini4i/argo-watcher:dev")

Expand Down Expand Up @@ -219,7 +227,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(nil, fmt.Errorf("applications.argoproj.io \"test-app\" not found"))
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().AddFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusAppNotFoundMessage, "ArgoCD API Error: applications.argoproj.io \"test-app\" not found")

// run the rollout
Expand Down Expand Up @@ -248,7 +258,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(nil, fmt.Errorf(argoUnavailableErrorMessage))
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().AddFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusAborted, "ArgoCD API Error: connect: connection refused")

// run the rollout
Expand Down Expand Up @@ -277,7 +289,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(nil, fmt.Errorf("unexpected failure"))
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().AddFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusFailedMessage, "ArgoCD API Error: unexpected failure")

// run the rollout
Expand Down Expand Up @@ -316,7 +330,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(&application, nil).Times(3)
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().AddFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusFailedMessage,
"Application deployment failed. Rollout status \"not available\"\n\nList of current images (last app check):\n\ttest-image:v0.0.1\n\nList of expected images:\n\tghcr.io/shini4i/argo-watcher:dev")

Expand Down Expand Up @@ -360,7 +376,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(&application, nil).Times(3)
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().AddFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusFailedMessage,
"Application deployment failed. Rollout status \"not synced\"\n\nApp status \"NotWorking\"\nApp message \"Not working test app\"\nResources:\n\t")

Expand Down Expand Up @@ -402,7 +420,9 @@ func TestArgoStatusUpdaterCheck(t *testing.T) {

// mock calls
apiMock.EXPECT().GetApplication(task.App).Return(&application, nil).Times(3)
metricsMock.EXPECT().AddInProgressTask()
metricsMock.EXPECT().AddFailedDeployment(task.App)
metricsMock.EXPECT().RemoveInProgressTask()
stateMock.EXPECT().SetTaskStatus(task.Id, models.StatusFailedMessage,
"Application deployment failed. Rollout status \"not healthy\"\n\nApp sync status \"Synced\"\nApp health status \"NotHealthy\"\nResources:\n\t")

Expand Down
17 changes: 17 additions & 0 deletions cmd/argo-watcher/prometheus/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ type MetricsInterface interface {
ResetFailedDeployment(app string)
AddProcessedDeployment()
SetArgoUnavailable(unavailable bool)
AddInProgressTask()
RemoveInProgressTask()
}

type Metrics struct {
failedDeployment *prometheus.GaugeVec
processedDeployments prometheus.Counter
argocdUnavailable prometheus.Gauge
inProgressTasks prometheus.Gauge
}

func (metrics *Metrics) Init() {
Expand All @@ -33,13 +36,19 @@ func (metrics *Metrics) Init() {
Name: "argocd_unavailable",
Help: "Whether ArgoCD is available for argo-watcher.",
})

metrics.inProgressTasks = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "in_progress_tasks",
Help: "The number of tasks currently in progress.",
})
}

func (metrics *Metrics) Register() {
log.Debug().Msg("Registering prometheus metrics...")
prometheus.MustRegister(metrics.failedDeployment)
prometheus.MustRegister(metrics.processedDeployments)
prometheus.MustRegister(metrics.argocdUnavailable)
prometheus.MustRegister(metrics.inProgressTasks)
}

func (metrics *Metrics) AddFailedDeployment(app string) {
Expand All @@ -54,6 +63,14 @@ func (metrics *Metrics) AddProcessedDeployment() {
metrics.processedDeployments.Inc()
}

func (metrics *Metrics) AddInProgressTask() {
metrics.inProgressTasks.Inc()
}

func (metrics *Metrics) RemoveInProgressTask() {
metrics.inProgressTasks.Dec()
}

func (metrics *Metrics) SetArgoUnavailable(unavailable bool) {
if unavailable {
metrics.argocdUnavailable.Set(1)
Expand Down
27 changes: 27 additions & 0 deletions cmd/argo-watcher/prometheus/metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,30 @@ func testMetricRegistered(metricName string) bool {

return false
}

func TestInProgressTasks(t *testing.T) {
metrics := &Metrics{}
metrics.Init()

t.Run("AddInProgressTask", func(t *testing.T) {
// Call the method to test
metrics.AddInProgressTask()

// Get the current value of the metric
metric := testutil.ToFloat64(metrics.inProgressTasks)

// Check if the metric was incremented
assert.Equal(t, 1.0, metric)
})

t.Run("RemoveInProgressTask", func(t *testing.T) {
// Call the method to test
metrics.RemoveInProgressTask()

// Get the current value of the metric
metric := testutil.ToFloat64(metrics.inProgressTasks)

// Check if the metric was decremented
assert.Equal(t, 0.0, metric)
})
}
Loading