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