Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
b33aaccf
Commit
b33aaccf
authored
Oct 19, 2021
by
Hordur Freyr Yngvason
Committed by
Gabriel Mazetto
Oct 19, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Port prometheus health check to cluster integration
parent
ac6d25e8
Changes
11
Hide whitespace changes
Inline
Side-by-side
Showing
11 changed files
with
70 additions
and
41 deletions
+70
-41
app/models/clusters/cluster.rb
app/models/clusters/cluster.rb
+1
-3
app/models/clusters/integrations/prometheus.rb
app/models/clusters/integrations/prometheus.rb
+7
-0
app/services/clusters/integrations/prometheus_health_check_service.rb
.../clusters/integrations/prometheus_health_check_service.rb
+23
-9
app/workers/all_queues.yml
app/workers/all_queues.yml
+2
-2
app/workers/clusters/integrations/check_prometheus_health_worker.rb
...s/clusters/integrations/check_prometheus_health_worker.rb
+3
-3
db/migrate/20211008193137_add_health_status_column_on_clusters_integration_prometheus.rb
...ealth_status_column_on_clusters_integration_prometheus.rb
+8
-0
db/schema_migrations/20211008193137
db/schema_migrations/20211008193137
+1
-0
db/structure.sql
db/structure.sql
+2
-1
spec/models/clusters/cluster_spec.rb
spec/models/clusters/cluster_spec.rb
+3
-3
spec/services/clusters/integrations/prometheus_health_check_service_spec.rb
...ters/integrations/prometheus_health_check_service_spec.rb
+16
-16
spec/workers/clusters/integrations/check_prometheus_health_worker_spec.rb
...sters/integrations/check_prometheus_health_worker_spec.rb
+4
-4
No files found.
app/models/clusters/cluster.rb
View file @
b33aaccf
...
...
@@ -150,9 +150,7 @@ module Clusters
scope
:for_project_namespace
,
->
(
namespace_id
)
{
joins
(
:projects
).
where
(
projects:
{
namespace_id:
namespace_id
})
}
scope
:with_name
,
->
(
name
)
{
where
(
name:
name
)
}
# with_application_prometheus scope is deprecated, and scheduled for removal
# in %14.0. See https://gitlab.com/groups/gitlab-org/-/epics/4280
scope
:with_application_prometheus
,
->
{
includes
(
:application_prometheus
).
joins
(
:application_prometheus
)
}
scope
:with_integration_prometheus
,
->
{
includes
(
:integration_prometheus
).
joins
(
:integration_prometheus
)
}
scope
:with_project_http_integrations
,
->
(
project_ids
)
do
conditions
=
{
projects: :alert_management_http_integrations
}
includes
(
conditions
).
joins
(
conditions
).
where
(
projects:
{
id:
project_ids
})
...
...
app/models/clusters/integrations/prometheus.rb
View file @
b33aaccf
...
...
@@ -14,6 +14,13 @@ module Clusters
validates
:cluster
,
presence:
true
validates
:enabled
,
inclusion:
{
in:
[
true
,
false
]
}
# Periodically checked and kept up to date for Monitor demo projects
enum
health_status:
{
unknown:
0
,
healthy:
1
,
unhealthy:
2
}
attr_encrypted
:alert_manager_token
,
mode: :per_attribute_iv
,
key:
Settings
.
attr_encrypted_db_key_base_32
,
...
...
app/services/clusters/
applic
ations/prometheus_health_check_service.rb
→
app/services/clusters/
integr
ations/prometheus_health_check_service.rb
View file @
b33aaccf
# frozen_string_literal: true
module
Clusters
module
Applic
ations
module
Integr
ations
class
PrometheusHealthCheckService
include
Gitlab
::
Utils
::
StrongMemoize
include
Gitlab
::
Routing
...
...
@@ -14,7 +14,7 @@ module Clusters
def
execute
raise
'Invalid cluster type. Only project types are allowed.'
unless
@cluster
.
project_type?
return
unless
prometheus_
application
.
installed?
return
unless
prometheus_
integration
.
enabled
project
=
@cluster
.
clusterable
...
...
@@ -28,32 +28,46 @@ module Clusters
send_notification
(
project
)
if
became_unhealthy?
prometheus_
application
.
update_columns
(
healthy:
currently_healthy?
)
if
health_changed?
prometheus_
integration
.
update_columns
(
health_status:
current_health_status
)
if
health_changed?
end
private
def
prometheus_application
strong_memoize
(
:prometheus_application
)
do
@cluster
.
application_prometheus
def
prometheus_integration
strong_memoize
(
:prometheus_integration
)
do
@cluster
.
integration_prometheus
end
end
def
current_health_status
if
currently_healthy?
:healthy
else
:unhealthy
end
end
def
currently_healthy?
strong_memoize
(
:currently_healthy
)
do
prometheus_
applic
ation
.
prometheus_client
.
healthy?
prometheus_
integr
ation
.
prometheus_client
.
healthy?
end
end
def
became_unhealthy?
strong_memoize
(
:became_unhealthy
)
do
(
was_healthy?
||
was_
healthy?
.
nil
?
)
&&
!
currently_healthy?
(
was_healthy?
||
was_
unknown
?
)
&&
!
currently_healthy?
end
end
def
was_healthy?
strong_memoize
(
:was_healthy
)
do
prometheus_application
.
healthy
prometheus_integration
.
healthy?
end
end
def
was_unknown?
strong_memoize
(
:was_unknown
)
do
prometheus_integration
.
unknown?
end
end
...
...
app/workers/all_queues.yml
View file @
b33aaccf
...
...
@@ -1069,8 +1069,8 @@
:idempotent:
:tags:
- :needs_own_queue
-
:name: incident_management:clusters_
applic
ations_check_prometheus_health
:worker_name: Clusters::
Applic
ations::CheckPrometheusHealthWorker
-
:name: incident_management:clusters_
integr
ations_check_prometheus_health
:worker_name: Clusters::
Integr
ations::CheckPrometheusHealthWorker
:feature_category: :incident_management
:has_external_dependencies:
true
:urgency: :low
...
...
app/workers/clusters/
applic
ations/check_prometheus_health_worker.rb
→
app/workers/clusters/
integr
ations/check_prometheus_health_worker.rb
View file @
b33aaccf
# frozen_string_literal: true
module
Clusters
module
Applic
ations
module
Integr
ations
class
CheckPrometheusHealthWorker
include
ApplicationWorker
...
...
@@ -22,11 +22,11 @@ module Clusters
def
perform
demo_project_ids
=
Gitlab
::
Monitor
::
DemoProjects
.
primary_keys
clusters
=
Clusters
::
Cluster
.
with_
applic
ation_prometheus
clusters
=
Clusters
::
Cluster
.
with_
integr
ation_prometheus
.
with_project_http_integrations
(
demo_project_ids
)
# Move to a seperate worker with scoped context if expanded to do work on customer projects
clusters
.
each
{
|
cluster
|
Clusters
::
Applic
ations
::
PrometheusHealthCheckService
.
new
(
cluster
).
execute
}
clusters
.
each
{
|
cluster
|
Clusters
::
Integr
ations
::
PrometheusHealthCheckService
.
new
(
cluster
).
execute
}
end
end
end
...
...
db/migrate/20211008193137_add_health_status_column_on_clusters_integration_prometheus.rb
0 → 100644
View file @
b33aaccf
# frozen_string_literal: true
class
AddHealthStatusColumnOnClustersIntegrationPrometheus
<
Gitlab
::
Database
::
Migration
[
1.0
]
def
change
# For now, health checks will only run on monitor demo projects
add_column
:clusters_integration_prometheus
,
:health_status
,
:smallint
,
limit:
2
,
default:
0
,
null:
false
end
end
db/schema_migrations/20211008193137
0 → 100644
View file @
b33aaccf
97efc3bb2039b66dac98135d93baefc780a62571bd80aa39d7458f37ce92905b
\ No newline at end of file
db/structure.sql
View file @
b33aaccf
...
...
@@ -12620,7 +12620,8 @@ CREATE TABLE clusters_integration_prometheus (
cluster_id bigint NOT NULL,
enabled boolean DEFAULT false NOT NULL,
encrypted_alert_manager_token text,
encrypted_alert_manager_token_iv text
encrypted_alert_manager_token_iv text,
health_status smallint DEFAULT 0 NOT NULL
);
CREATE TABLE clusters_kubernetes_namespaces (
spec/models/clusters/cluster_spec.rb
View file @
b33aaccf
...
...
@@ -178,13 +178,13 @@ RSpec.describe Clusters::Cluster, :use_clean_rails_memory_store_caching do
end
end
describe
'.with_
applic
ation_prometheus'
do
subject
{
described_class
.
with_
applic
ation_prometheus
}
describe
'.with_
integr
ation_prometheus'
do
subject
{
described_class
.
with_
integr
ation_prometheus
}
let!
(
:cluster
)
{
create
(
:cluster
)
}
context
'cluster has prometheus application'
do
let!
(
:application
)
{
create
(
:clusters_
applications_prometheus
,
:installed
,
cluster:
cluster
)
}
let!
(
:application
)
{
create
(
:clusters_
integrations_prometheus
,
cluster:
cluster
)
}
it
{
is_expected
.
to
include
(
cluster
)
}
end
...
...
spec/services/clusters/
applic
ations/prometheus_health_check_service_spec.rb
→
spec/services/clusters/
integr
ations/prometheus_health_check_service_spec.rb
View file @
b33aaccf
...
...
@@ -2,7 +2,7 @@
require
'spec_helper'
RSpec
.
describe
Clusters
::
Applic
ations
::
PrometheusHealthCheckService
,
'#execute'
do
RSpec
.
describe
Clusters
::
Integr
ations
::
PrometheusHealthCheckService
,
'#execute'
do
let
(
:service
)
{
described_class
.
new
(
cluster
)
}
subject
{
service
.
execute
}
...
...
@@ -26,10 +26,10 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
end
RSpec
.
shared_examples
'correct health stored'
do
it
'stores the correct health of prometheus
app
'
do
it
'stores the correct health of prometheus'
do
subject
expect
(
prometheus
.
healthy
).
to
eq
(
client_healthy
)
expect
(
prometheus
.
healthy
?
).
to
eq
(
client_healthy
)
end
end
...
...
@@ -43,19 +43,19 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
let_it_be
(
:project
)
{
create
(
:project
)
}
let_it_be
(
:integration
)
{
create
(
:alert_management_http_integration
,
project:
project
)
}
let
(
:
applications_prometheus_healthy
)
{
true
}
let
(
:prometheus
)
{
create
(
:clusters_
applications_prometheus
,
status:
prometheus_status_value
,
healthy:
applications_prometheus_healthy
)
}
let
(
:cluster
)
{
create
(
:cluster
,
:project
,
applic
ation_prometheus:
prometheus
,
projects:
[
project
])
}
let
(
:
previous_health_status
)
{
:healthy
}
let
(
:prometheus
)
{
create
(
:clusters_
integrations_prometheus
,
enabled:
prometheus_enabled
,
health_status:
previous_health_status
)
}
let
(
:cluster
)
{
create
(
:cluster
,
:project
,
integr
ation_prometheus:
prometheus
,
projects:
[
project
])
}
context
'when prometheus not
instal
led'
do
let
(
:prometheus_
status_value
)
{
Clusters
::
Applications
::
Prometheus
.
state_machine
.
states
[
:installing
].
valu
e
}
context
'when prometheus not
enab
led'
do
let
(
:prometheus_
enabled
)
{
fals
e
}
it
{
expect
(
subject
).
to
eq
(
nil
)
}
include_examples
'no alert'
end
context
'when prometheus
instal
led'
do
let
(
:prometheus_
status_value
)
{
Clusters
::
Applications
::
Prometheus
.
state_machine
.
states
[
:installed
].
val
ue
}
context
'when prometheus
enab
led'
do
let
(
:prometheus_
enabled
)
{
tr
ue
}
before
do
client
=
instance_double
(
'PrometheusClient'
,
healthy?:
client_healthy
)
...
...
@@ -63,7 +63,7 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
end
context
'when newly unhealthy'
do
let
(
:
applications_prometheus_healthy
)
{
true
}
let
(
:
previous_health_status
)
{
:healthy
}
let
(
:client_healthy
)
{
false
}
include_examples
'sends alert'
...
...
@@ -71,7 +71,7 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
end
context
'when newly healthy'
do
let
(
:
applications_prometheus_healthy
)
{
false
}
let
(
:
previous_health_status
)
{
:unhealthy
}
let
(
:client_healthy
)
{
true
}
include_examples
'no alert'
...
...
@@ -79,7 +79,7 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
end
context
'when continuously unhealthy'
do
let
(
:
applications_prometheus_healthy
)
{
false
}
let
(
:
previous_health_status
)
{
:unhealthy
}
let
(
:client_healthy
)
{
false
}
include_examples
'no alert'
...
...
@@ -87,7 +87,7 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
end
context
'when continuously healthy'
do
let
(
:
applications_prometheus_healthy
)
{
true
}
let
(
:
previous_health_status
)
{
:healthy
}
let
(
:client_healthy
)
{
true
}
include_examples
'no alert'
...
...
@@ -95,7 +95,7 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
end
context
'when first health check and healthy'
do
let
(
:
applications_prometheus_healthy
)
{
nil
}
let
(
:
previous_health_status
)
{
:unknown
}
let
(
:client_healthy
)
{
true
}
include_examples
'no alert'
...
...
@@ -103,7 +103,7 @@ RSpec.describe Clusters::Applications::PrometheusHealthCheckService, '#execute'
end
context
'when first health check and not healthy'
do
let
(
:
applications_prometheus_healthy
)
{
nil
}
let
(
:
previous_health_status
)
{
:unknown
}
let
(
:client_healthy
)
{
false
}
include_examples
'sends alert'
...
...
spec/workers/clusters/
applic
ations/check_prometheus_health_worker_spec.rb
→
spec/workers/clusters/
integr
ations/check_prometheus_health_worker_spec.rb
View file @
b33aaccf
...
...
@@ -2,16 +2,16 @@
require
'spec_helper'
RSpec
.
describe
Clusters
::
Applic
ations
::
CheckPrometheusHealthWorker
,
'#perform'
do
RSpec
.
describe
Clusters
::
Integr
ations
::
CheckPrometheusHealthWorker
,
'#perform'
do
subject
{
described_class
.
new
.
perform
}
it
'triggers health service'
do
cluster
=
create
(
:cluster
)
allow
(
Gitlab
::
Monitor
::
DemoProjects
).
to
receive
(
:primary_keys
)
allow
(
Clusters
::
Cluster
).
to
receive_message_chain
(
:with_
applic
ation_prometheus
,
:with_project_http_integrations
).
and_return
([
cluster
])
allow
(
Clusters
::
Cluster
).
to
receive_message_chain
(
:with_
integr
ation_prometheus
,
:with_project_http_integrations
).
and_return
([
cluster
])
service_instance
=
instance_double
(
Clusters
::
Applic
ations
::
PrometheusHealthCheckService
)
expect
(
Clusters
::
Applic
ations
::
PrometheusHealthCheckService
).
to
receive
(
:new
).
with
(
cluster
).
and_return
(
service_instance
)
service_instance
=
instance_double
(
Clusters
::
Integr
ations
::
PrometheusHealthCheckService
)
expect
(
Clusters
::
Integr
ations
::
PrometheusHealthCheckService
).
to
receive
(
:new
).
with
(
cluster
).
and_return
(
service_instance
)
expect
(
service_instance
).
to
receive
(
:execute
)
subject
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment