Module: Chef::DataCollector::Messages::Helpers

Included in:
Client::UUIDFetcher, Chef::DataCollector::Messages
Defined in:
lib/chef/data_collector/messages/helpers.rb

Instance Method Summary collapse

Instance Method Details

#chef_server_fqdn ⇒ String

Fully-qualified domain name of the Chef Server configured in Chef::Config If the chef_server_url cannot be parsed as a URI, the node attribute will be returned, or “localhost” if the run_status is unavailable to us.

Returns:

  • (String) —

    FQDN of the configured Chef Server, or node/localhost if not found.



32
33
34
35
36
37
38
39
40
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 32

def chef_server_fqdn
  if !Chef::Config[:chef_server_url].nil?
    URI(Chef::Config[:chef_server_url]).host
  elsif !Chef::Config[:node_name].nil?
    Chef::Config[:node_name]
  else
    "localhost"
  end
end

#chef_server_organization ⇒ String

Return the organization assumed by the configured chef_server_url.

We must parse this from the Chef::Config because a node has no knowledge of an organization or to which organization is belongs.

If we cannot determine the organization, we return “unknown_organization”

Returns:

  • (String) —

    shortname of the Chef Server organization



74
75
76
77
78
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 74

def chef_server_organization
  return "unknown_organization" unless Chef::Config[:chef_server_url]

  Chef::Config[:chef_server_url].match(%r{/+organizations/+([a-z0-9][a-z0-9_-]{0,254})}).nil? ? "unknown_organization" : $1
end

#collector_source ⇒ String

The source of the data collecting during this run, used by the DataCollector endpoint to determine if Chef was in Solo mode or not.

Returns:

  • (String) —

    “chef_solo” if in Solo mode, “chef_client” if in Client mode



86
87
88
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 86

def collector_source
  solo_run? ? "chef_solo" : "chef_client"
end

#data_collector_organization ⇒ String

Returns the user-configured organization, or “chef_solo” if none is configured.

This is only used when Chef is run in Solo mode.

Returns:

  • (String) —

    Data-collector-specific organization used when running in Chef Solo



60
61
62
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 60

def data_collector_organization
  Chef::Config[:data_collector][:organization] || "chef_solo"
end

#generate_node_uuid ⇒ String

Generates a UUID for the node via SecureRandom.uuid and writes out metadata file so the UUID persists between runs.

Returns:

  • (String) —

    UUID for the node



118
119
120
121
122
123
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 118

def generate_node_uuid
  uuid = SecureRandom.uuid
  update_metadata("node_uuid", uuid)

  uuid
end

#metadata ⇒ Hash

Returns the DataCollector metadata for this node

If the metadata file does not exist in the file cache path, an empty hash will be returned.

Returns:

  • (Hash) —

    DataCollector metadata for this node



142
143
144
145
146
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 142

def metadata
  Chef::JSONCompat.parse(Chef::FileCache.load(metadata_filename))
rescue Chef::Exceptions::FileNotFound
  {}
end

#metadata_filename ⇒ Object 



153
154
155
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 153

def metadata_filename
  "data_collector_metadata.json"
end

#node_uuid ⇒ String

Returns a UUID that uniquely identifies this node for reporting reasons.

The node is read in from disk if it exists, or it’s generated if it does does not exist.

Returns:

  • (String) —

    UUID for the node



108
109
110
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 108

def node_uuid
  Chef::Config[:chef_guid] || read_node_uuid || generate_node_uuid
end

#organization ⇒ String

The organization name the node is associated with. For Chef Solo runs, a user-configured organization string is returned, or the string “chef_solo” if such a string is not configured.

Returns:

  • (String) —

    Organization to which the node is associated



49
50
51
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 49

def organization
  solo_run? ? data_collector_organization : chef_server_organization
end

#read_node_uuid ⇒ String

Reads in the node UUID from the node metadata file

Returns:

  • (String) —

    UUID for the node



130
131
132
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 130

def read_node_uuid
  metadata["node_uuid"]
end

#solo_run? ⇒ Boolean

If we’re running in Solo (legacy) mode, or in Solo (formerly “Chef Client Local Mode”), we’re considered to be in a “solo run”.

Returns:

  • (Boolean) —

    Whether we’re in a solo run or not



96
97
98
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 96

def solo_run?
  Chef::Config[:solo] || Chef::Config[:local_mode]
end

#update_metadata(key, value) ⇒ Object 



148
149
150
151
 
# File 'lib/chef/data_collector/messages/helpers.rb', line 148

def update_metadata(key, value)
  updated_metadata = metadata.tap { |x| x[key] = value }
  Chef::FileCache.store(metadata_filename, Chef::JSONCompat.to_json(updated_metadata), 0644)
end