2017-03-07 16:57:42 +00:00
class PrometheusService < MonitoringService
2017-05-09 04:15:34 +00:00
include ReactiveService
2017-03-07 16:57:42 +00:00
self . reactive_cache_lease_timeout = 30 . seconds
self . reactive_cache_refresh_interval = 30 . seconds
self . reactive_cache_lifetime = 1 . minute
# Access to prometheus is directly through the API
prop_accessor :api_url
with_options presence : true , if : :activated? do
validates :api_url , url : true
end
after_save :clear_reactive_cache!
def initialize_properties
if properties . nil?
self . properties = { }
end
end
def title
'Prometheus'
end
def description
2017-11-15 08:42:37 +00:00
s_ ( 'PrometheusService|Prometheus monitoring' )
2017-03-07 16:57:42 +00:00
end
def self . to_param
'prometheus'
end
def fields
[
{
type : 'text' ,
name : 'api_url' ,
title : 'API URL' ,
2017-11-15 08:42:37 +00:00
placeholder : s_ ( 'PrometheusService|Prometheus API Base URL, like http://prometheus.example.com/' ) ,
help : s_ ( 'PrometheusService|By default, Prometheus listens on ‘ http://localhost:9090’ . It’ s not recommended to change the default address and port as this might affect or conflict with other services running on the GitLab server.' ) ,
2017-05-22 10:07:12 +00:00
required : true
2017-03-07 16:57:42 +00:00
}
]
end
# Check we can connect to the Prometheus API
def test ( * args )
client . ping
{ success : true , result : 'Checked API endpoint' }
rescue Gitlab :: PrometheusError = > err
{ success : false , result : err }
end
2018-01-02 19:24:12 +00:00
def with_reactive_cache ( cl , * args )
yield calculate_reactive_cache ( cl , * args )
end
2017-05-09 20:24:24 +00:00
def environment_metrics ( environment )
2017-05-10 09:25:30 +00:00
with_reactive_cache ( Gitlab :: Prometheus :: Queries :: EnvironmentQuery . name , environment . id , & method ( :rename_data_to_metrics ) )
2017-04-26 20:09:03 +00:00
end
def deployment_metrics ( deployment )
2018-01-02 19:24:12 +00:00
metrics = with_reactive_cache ( Gitlab :: Prometheus :: Queries :: DeploymentQuery . name , deployment . environment . id , deployment . id , & method ( :rename_data_to_metrics ) )
2017-06-22 19:19:55 +00:00
metrics & . merge ( deployment_time : deployment . created_at . to_i ) || { }
2017-03-07 16:57:42 +00:00
end
2017-06-07 00:36:59 +00:00
def additional_environment_metrics ( environment )
with_reactive_cache ( Gitlab :: Prometheus :: Queries :: AdditionalMetricsEnvironmentQuery . name , environment . id , & :itself )
end
def additional_deployment_metrics ( deployment )
2018-01-02 19:24:12 +00:00
with_reactive_cache ( Gitlab :: Prometheus :: Queries :: AdditionalMetricsDeploymentQuery . name , deployment . environment . id , deployment . id , & :itself )
2017-06-07 00:36:59 +00:00
end
def matched_metrics
2018-01-02 19:24:12 +00:00
with_reactive_cache ( Gitlab :: Prometheus :: Queries :: MatchedMetricsQuery . name , nil , & :itself )
end
def manual_mode?
false
2017-06-08 10:29:53 +00:00
end
2017-03-07 16:57:42 +00:00
# Cache metrics for specific environment
2018-01-02 19:24:12 +00:00
def calculate_reactive_cache ( query_class_name , environment_id , * args )
2017-03-07 16:57:42 +00:00
return unless active? && project && ! project . pending_delete?
2018-01-02 20:42:24 +00:00
client = client ( environment_id )
2018-01-02 19:24:12 +00:00
2017-03-07 16:57:42 +00:00
2018-01-02 19:24:12 +00:00
data = Kernel . const_get ( query_class_name ) . new ( client ) . query ( environment_id , * args )
2017-03-07 16:57:42 +00:00
{
success : true ,
2017-05-10 09:25:30 +00:00
data : data ,
2017-03-07 16:57:42 +00:00
last_update : Time . now . utc
}
rescue Gitlab :: PrometheusError = > err
{ success : false , result : err . message }
end
2018-01-02 19:24:12 +00:00
def client ( environment_id )
if manual_mode?
2018-01-02 20:42:24 +00:00
Gitlab :: PrometheusClient . new ( RestClient :: Resource . new ( api_url ) )
2018-01-02 19:24:12 +00:00
else
2018-01-02 20:42:24 +00:00
cluster = find_cluster_with_prometheus ( environment_id )
Gitlab :: PrometheusClient . new ( cluster . application_prometheus . proxy_client ) if cluster
2018-01-02 19:24:12 +00:00
end
end
2018-01-02 20:42:24 +00:00
private
2018-01-02 19:24:12 +00:00
def find_cluster_with_prometheus ( environment_id )
clusters = if environment_id
:: Environment . find_by ( id : environment_id ) . try ( :enabled_clusters ) || [ ]
else
project . clusters . enabled . select { | c | c . environment_scope == '*' || c . environment_scope == '' }
end
clusters . detect { | cluster | cluster . application_prometheus . installed? }
2017-03-07 16:57:42 +00:00
end
2017-05-10 09:25:30 +00:00
def rename_data_to_metrics ( metrics )
metrics [ :metrics ] = metrics . delete :data
metrics
end
2017-03-07 16:57:42 +00:00
end