Class: Chef::Telemeter::Sender

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/telemeter/sender.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session_files, config) ⇒ Sender

Returns a new instance of Sender.



48
49
50
51
 
# File 'lib/chef/telemeter/sender.rb', line 48

def initialize(session_files, config)
  @session_files = session_files
  @config = config
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



29
30
31
 
# File 'lib/chef/telemeter/sender.rb', line 29

def config
  @config
end

#session_files ⇒ Object (readonly)

Returns the value of attribute session_files.



29
30
31
 
# File 'lib/chef/telemeter/sender.rb', line 29

def session_files
  @session_files
end

Class Method Details

.find_session_files(config) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/chef/telemeter/sender.rb', line 40

def self.find_session_files(config)
  Telemeter::Log.info("Looking for telemetry data to submit")
  session_search = File.join(config[:payload_dir], "telemetry-payload-*.yml")
  session_files = Dir.glob(session_search)
  Telemeter::Log.info("Found #{session_files.length} sessions to submit")
  session_files
end

.start_upload_thread(config) ⇒ Object 



31
32
33
34
35
36
37
38
 
# File 'lib/chef/telemeter/sender.rb', line 31

def self.start_upload_thread(config)
  # Find the files before we spawn the thread - otherwise
  # we may accidentally pick up the current run's session file if it
  # finishes before the thread scans for new files
  session_files = Sender.find_session_files(config)
  sender = Sender.new(session_files, config)
  Thread.new { sender.run }
end

Instance Method Details

#process_session(path) ⇒ Object 



75
76
77
78
79
 
# File 'lib/chef/telemeter/sender.rb', line 75

def process_session(path)
  Telemeter::Log.info("Processing telemetry entries from #{path}")
  content = load_and_clear_session(path)
  submit_session(content)
end

#run ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/chef/telemeter/sender.rb', line 53

def run
  if Telemeter.enabled?
    Telemeter::Log.info("Telemetry enabled, beginning upload of previous session(s)")
    # dev mode telemetry gets sent to a different location

    if config[:dev_mode]
      ENV["CHEF_TELEMETRY_ENDPOINT"] ||= "https://telemetry-acceptance.chef.io"
    end
    session_files.each { |path| process_session(path) }
  else
    # If telemetry is not enabled, just clean up and return. Even though
    # the telemetry gem will not send if disabled, log output saying that we're submitting
    # it when it has been disabled can be alarming.
    Telemeter::Log.info("Telemetry disabled, clearing any existing session captures without sending them.")
    session_files.each { |path| FileUtils.rm_rf(path) }
  end
  FileUtils.rm_rf(config[:session_file])
  Telemeter::Log.info("Terminating, nothing more to do.")
rescue => e
  Telemeter::Log.fatal "Sender thread aborted: '#{e}' failed at  #{e.backtrace[0]}"
end

#submit_entry(telemetry, entry, sequence, total) ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/chef/telemeter/sender.rb', line 100

def submit_entry(telemetry, entry, sequence, total)
  Telemeter::Log.info("Submitting telemetry entry #{sequence}/#{total}: #{entry} ")
  telemetry.deliver(entry)
  Telemeter::Log.info("Entry #{sequence}/#{total} submitted.")
rescue => e
  # No error handling in telemetry lib, so at least track the failrue
  Telemeter::Log.error("Failed to send entry #{sequence}/#{total}: #{e}")
  Telemeter::Log.error("Backtrace: #{e.backtrace} ")
end

#submit_session(content) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/chef/telemeter/sender.rb', line 81

def submit_session(content)
  # Each file contains the actions taken within a single run of the chef tool.
  # Each run is one session, so we'll first remove remove the session file
  # to force creating a new one.
  FileUtils.rm_rf(config[:session_file])
  # We'll use the version captured in the sesion file
  entries = content["entries"]
  total = entries.length
  product_info = config[:product] || {}
  telemetry = Telemetry.new(product: product_info[:name] || "chef-workstation",
                            origin: product_info[:origin] || "command-line",
                            product_version: product_info[:version] || content["version"],
                            install_context: product_info[:install_context] || "omnibus")
  total = entries.length
  entries.each_with_index do |entry, x|
    submit_entry(telemetry, entry, x + 1, total)
  end
end