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