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