cookbooks/prometheus/resources/exporter.rb

   1 #
   2 # Cookbook:: prometheus
   3 # Resource:: prometheus_exporter
   4 #
   5 # Copyright:: 2020, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #     https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 unified_mode true
  21
  22 default_action :create
  23
  24 property :exporter, :kind_of => String, :name_property => true
  25 property :address, :kind_of => String
  26 property :port, :kind_of => Integer, :required => [:create]
  27 property :listen_switch, :kind_of => String, :default => "web.listen-address"
  28 property :listen_type, :kind_of => String, :default => "address"
  29 property :user, :kind_of => String, :default => "root"
  30 property :command, :kind_of => String
  31 property :options, :kind_of => [String, Array]
  32 property :environment, :kind_of => Hash, :default => {}
  33 property :service, :kind_of => String
  34 property :scrape_interval, :kind_of => String
  35 property :scrape_timeout, :kind_of => String
  36 property :metric_relabel, :kind_of => Array
  37 property :register_target, :kind_of => [TrueClass, FalseClass], :default => true
  38
  39 action :create do
  40   systemd_service service_name do
  41     after "network-online.target"
  42     wants "network-online.target"
  43     description "Prometheus #{new_resource.exporter} exporter"
  44     type "simple"
  45     user new_resource.user
  46     environment new_resource.environment
  47     exec_start "#{executable_path} #{new_resource.command} #{executable_options}"
  48     private_tmp true
  49     protect_system "strict"
  50     protect_home true
  51     no_new_privileges true
  52   end
  53
  54   service service_name do
  55     action [:enable, :start]
  56     subscribes :restart, "systemd_service[#{service_name}]"
  57   end
  58
  59   firewall_rule "accept-prometheus-#{new_resource.exporter}" do
  60     action :accept
  61     source "osm"
  62     dest "fw"
  63     proto "tcp:syn"
  64     dest_ports new_resource.port
  65     only_if { node[:prometheus][:mode] == "external" }
  66   end
  67
  68   node.default[:prometheus][:addresses][new_resource.exporter] = listen_address
  69
  70   if new_resource.register_target
  71     node.default[:prometheus][:exporters][new_resource.port] = {
  72       :name => new_resource.exporter,
  73       :address => listen_address,
  74       :scrape_interval => new_resource.scrape_interval,
  75       :scrape_timeout => new_resource.scrape_timeout,
  76       :metric_relabel => new_resource.metric_relabel
  77     }
  78   end
  79 end
  80
  81 action :delete do
  82   service service_name do
  83     action [:disable, :stop]
  84   end
  85
  86   systemd_service service_name do
  87     action :delete
  88   end
  89 end
  90
  91 action :restart do
  92   service service_name do
  93     action :restart
  94     only_if { service_exists? }
  95   end
  96 end
  97
  98 action_class do
  99   def service_name
 100     if new_resource.service
 101       "prometheus-#{new_resource.service}-exporter"
 102     else
 103       "prometheus-#{new_resource.exporter}-exporter"
 104     end
 105   end
 106
 107   def service_exists?
 108     ::File.exist?("/etc/systemd/system/#{service_name}.service")
 109   end
 110
 111   def executable_path
 112     "/opt/prometheus-exporters/exporters/#{new_resource.exporter}/#{new_resource.exporter}_exporter"
 113   end
 114
 115   def executable_options
 116     "--#{new_resource.listen_switch}=#{listen_argument} #{Array(new_resource.options).join(' ')}"
 117   end
 118
 119   def listen_argument
 120     case new_resource.listen_type
 121     when "address" then listen_address
 122     when "url" then "http://#{listen_address}/metrics"
 123     end
 124   end
 125
 126   def listen_address
 127     if new_resource.address
 128       "#{new_resource.address}:#{new_resource.port}"
 129     elsif node[:prometheus][:mode] == "wireguard"
 130       "[#{node[:prometheus][:address]}]:#{new_resource.port}"
 131     else
 132       "#{node[:prometheus][:address]}:#{new_resource.port}"
 133     end
 134   end
 135 end
 136
 137 def after_created
 138   subscribes :restart, "git[/opt/prometheus-exporters]"
 139 end