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 :metric_relabel, :kind_of => Array
  36 property :register_target, :kind_of => [TrueClass, FalseClass], :default => true
  37
  38 action :create do
  39   systemd_service service_name do
  40     after "network-online.target"
  41     wants "network-online.target"
  42     description "Prometheus #{new_resource.exporter} exporter"
  43     type "simple"
  44     user new_resource.user
  45     environment new_resource.environment
  46     exec_start "#{executable_path} #{new_resource.command} #{executable_options}"
  47     private_tmp true
  48     protect_system "strict"
  49     protect_home true
  50     no_new_privileges true
  51   end
  52
  53   service service_name do
  54     action [:enable, :start]
  55     subscribes :restart, "systemd_service[#{service_name}]"
  56   end
  57
  58   firewall_rule "accept-prometheus-#{new_resource.exporter}" do
  59     action :accept
  60     source "osm"
  61     dest "fw"
  62     proto "tcp:syn"
  63     dest_ports new_resource.port
  64     only_if { node[:prometheus][:mode] == "external" }
  65   end
  66
  67   node.default[:prometheus][:addresses][new_resource.exporter] = listen_address
  68
  69   if new_resource.register_target
  70     node.default[:prometheus][:exporters][new_resource.port] = {
  71       :name => new_resource.exporter,
  72       :address => listen_address,
  73       :scrape_interval => new_resource.scrape_interval,
  74       :metric_relabel => new_resource.metric_relabel
  75     }
  76   end
  77 end
  78
  79 action :delete do
  80   service service_name do
  81     action [:disable, :stop]
  82   end
  83
  84   systemd_service service_name do
  85     action :delete
  86   end
  87 end
  88
  89 action :restart do
  90   service service_name do
  91     action :restart
  92     only_if { service_exists? }
  93   end
  94 end
  95
  96 action_class do
  97   def service_name
  98     if new_resource.service
  99       "prometheus-#{new_resource.service}-exporter"
 100     else
 101       "prometheus-#{new_resource.exporter}-exporter"
 102     end
 103   end
 104
 105   def service_exists?
 106     ::File.exist?("/etc/systemd/system/#{service_name}.service")
 107   end
 108
 109   def executable_path
 110     "/opt/prometheus-exporters/exporters/#{new_resource.exporter}/#{new_resource.exporter}_exporter"
 111   end
 112
 113   def executable_options
 114     "--#{new_resource.listen_switch}=#{listen_argument} #{Array(new_resource.options).join(' ')}"
 115   end
 116
 117   def listen_argument
 118     case new_resource.listen_type
 119     when "address" then listen_address
 120     when "url" then "http://#{listen_address}/metrics"
 121     end
 122   end
 123
 124   def listen_address
 125     if new_resource.address
 126       "#{new_resource.address}:#{new_resource.port}"
 127     elsif node[:prometheus][:mode] == "wireguard"
 128       "[#{node[:prometheus][:address]}]:#{new_resource.port}"
 129     else
 130       "#{node[:prometheus][:address]}:#{new_resource.port}"
 131     end
 132   end
 133 end
 134
 135 def after_created
 136   subscribes :restart, "git[/opt/prometheus-exporters]"
 137 end