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