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
  30 property :command, :kind_of => String
  31 property :options, :kind_of => [String, Array]
  32 property :environment, :kind_of => Hash, :default => {}
  33 property :protect_proc, String
  34 property :proc_subset, String
  35 property :private_devices, [true, false]
  36 property :protect_clock, [true, false]
  37 property :restrict_address_families, [String, Array]
  38 property :system_call_filter, [String, Array]
  39 property :service, :kind_of => String
  40 property :scrape_interval, :kind_of => String
  41 property :scrape_timeout, :kind_of => String
  42 property :metric_relabel, :kind_of => Array
  43 property :register_target, :kind_of => [TrueClass, FalseClass], :default => true
  44
  45 action :create do
  46   systemd_service service_name do
  47     after "network-online.target"
  48     wants "network-online.target"
  49     description "Prometheus #{new_resource.exporter} exporter"
  50     type "simple"
  51     user new_resource.user
  52     dynamic_user new_resource.user.nil?
  53     environment new_resource.environment
  54     exec_start "#{executable_path} #{new_resource.command} #{executable_options}"
  55     sandbox :enable_network => true
  56     protect_proc new_resource.protect_proc if new_resource.property_is_set?(:protect_proc)
  57     proc_subset new_resource.proc_subset if new_resource.property_is_set?(:proc_subset)
  58     private_devices new_resource.private_devices if new_resource.property_is_set?(:private_devices)
  59     protect_clock new_resource.protect_clock if new_resource.property_is_set?(:protect_clock)
  60     restrict_address_families new_resource.restrict_address_families if new_resource.property_is_set?(:restrict_address_families)
  61     system_call_filter new_resource.system_call_filter if new_resource.property_is_set?(:system_call_filter)
  62   end
  63
  64   service service_name do
  65     action [:enable, :start]
  66     subscribes :restart, "systemd_service[#{service_name}]"
  67   end
  68
  69   firewall_rule "accept-prometheus-#{new_resource.exporter}" do
  70     action :accept
  71     source "osm"
  72     dest "fw"
  73     proto "tcp:syn"
  74     dest_ports new_resource.port
  75     only_if { node[:prometheus][:mode] == "external" }
  76   end
  77
  78   node.default[:prometheus][:addresses][new_resource.exporter] = listen_address
  79
  80   if new_resource.register_target
  81     node.default[:prometheus][:exporters][new_resource.port] = {
  82       :name => new_resource.exporter,
  83       :address => listen_address,
  84       :scrape_interval => new_resource.scrape_interval,
  85       :scrape_timeout => new_resource.scrape_timeout,
  86       :metric_relabel => new_resource.metric_relabel
  87     }
  88   end
  89 end
  90
  91 action :delete do
  92   service service_name do
  93     action [:disable, :stop]
  94   end
  95
  96   systemd_service service_name do
  97     action :delete
  98   end
  99 end
 100
 101 action :restart do
 102   service service_name do
 103     action :restart
 104     only_if { service_exists? }
 105   end
 106 end
 107
 108 action_class do
 109   def service_name
 110     if new_resource.service
 111       "prometheus-#{new_resource.service}-exporter"
 112     else
 113       "prometheus-#{new_resource.exporter}-exporter"
 114     end
 115   end
 116
 117   def service_exists?
 118     ::File.exist?("/etc/systemd/system/#{service_name}.service")
 119   end
 120
 121   def executable_path
 122     if ::File.exist?("#{executable_directory}/#{executable_name}_#{executable_architecture}")
 123       "#{executable_directory}/#{executable_name}_#{executable_architecture}"
 124     else
 125       "#{executable_directory}/#{executable_name}"
 126     end
 127   end
 128
 129   def executable_directory
 130     "/opt/prometheus-exporters/exporters/#{new_resource.exporter}"
 131   end
 132
 133   def executable_name
 134     "#{new_resource.exporter}_exporter"
 135   end
 136
 137   def executable_architecture
 138     node[:kernel][:machine]
 139   end
 140
 141   def executable_options
 142     "--#{new_resource.listen_switch}=#{listen_argument} #{Array(new_resource.options).join(' ')}"
 143   end
 144
 145   def listen_argument
 146     case new_resource.listen_type
 147     when "address" then listen_address
 148     when "url" then "http://#{listen_address}/metrics"
 149     end
 150   end
 151
 152   def listen_address
 153     if new_resource.address
 154       "#{new_resource.address}:#{new_resource.port}"
 155     elsif node[:prometheus][:mode] == "wireguard"
 156       "[#{node[:prometheus][:address]}]:#{new_resource.port}"
 157     else
 158       "#{node[:prometheus][:address]}:#{new_resource.port}"
 159     end
 160   end
 161 end
 162
 163 def after_created
 164   subscribes :restart, "git[/opt/prometheus-exporters]"
 165 end