Class: NewRelic::Agent::UtilizationData

Inherits:
Object
  • Object
show all
Defined in:
lib/new_relic/agent/utilization_data.rb

Constant Summary collapse

METADATA_VERSION = 
5
VENDORS = 
{
  Utilization::AWS => :'utilization.detect_aws',
  Utilization::GCP => :'utilization.detect_gcp',
  Utilization::Azure => :'utilization.detect_azure',
  Utilization::PCF => :'utilization.detect_pcf'
}
KUBERNETES_SERVICE_HOST = 
'KUBERNETES_SERVICE_HOST'.freeze

Instance Method Summary collapse

Instance Method Details

#append_boot_id(collector_hash) ⇒ Object 



114
115
116
117
118
 
# File 'lib/new_relic/agent/utilization_data.rb', line 114

def append_boot_id(collector_hash)
  if bid = ::NewRelic::Agent::SystemInfo.boot_id
    collector_hash[:boot_id] = bid
  end
end

#append_configured_values(collector_hash) ⇒ Object 



110
111
112
 
# File 'lib/new_relic/agent/utilization_data.rb', line 110

def append_configured_values(collector_hash)
  collector_hash[:config] = config_hash unless config_hash.empty?
end

#append_docker_info(collector_hash) ⇒ Object 



101
102
103
104
105
106
107
108
 
# File 'lib/new_relic/agent/utilization_data.rb', line 101

def append_docker_info(collector_hash)
  return unless Agent.config[:'utilization.detect_docker']

  if docker_container_id = container_id
    collector_hash[:vendors] ||= {}
    collector_hash[:vendors][:docker] = {:id => docker_container_id}
  end
end

#append_full_hostname(collector_hash) ⇒ Object 



138
139
140
141
142
143
 
# File 'lib/new_relic/agent/utilization_data.rb', line 138

def append_full_hostname(collector_hash)
  full_hostname = fqdn
  return if full_hostname.nil? || full_hostname.empty?

  collector_hash[:full_hostname] = full_hostname
end

#append_ip_address(collector_hash) ⇒ Object 



120
121
122
123
 
# File 'lib/new_relic/agent/utilization_data.rb', line 120

def append_ip_address(collector_hash)
  ips = ip_addresses
  collector_hash[:ip_address] = ips unless ips.empty?
end

#append_kubernetes_info(collector_hash) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/new_relic/agent/utilization_data.rb', line 127

def append_kubernetes_info(collector_hash)
  return unless Agent.config[:'utilization.detect_kubernetes']

  if host = ENV[KUBERNETES_SERVICE_HOST]
    collector_hash[:vendors] ||= {}
    collector_hash[:vendors][:kubernetes] = {
      kubernetes_service_host: host
    }
  end
end

#append_vendor_info(collector_hash) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/new_relic/agent/utilization_data.rb', line 87

def append_vendor_info(collector_hash)
  VENDORS.each_pair do |klass, config_option|
    next unless Agent.config[config_option]

    vendor = klass.new

    if vendor.detect
      collector_hash[:vendors] ||= {}
      collector_hash[:vendors][vendor.vendor_name.to_sym] = vendor.metadata
      break
    end
  end
end

#config_hash ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/new_relic/agent/utilization_data.rb', line 145

def config_hash
  config_hash = {}

  if hostname = configured_hostname
    config_hash[:hostname] = hostname
  end

  if logical_processors = configured_logical_processors
    config_hash[:logical_processors] = logical_processors
  end

  if total_ram_mib = configured_total_ram_mib
    config_hash[:total_ram_mib] = total_ram_mib
  end

  config_hash
end

#configured_hostname ⇒ Object 



47
48
49
 
# File 'lib/new_relic/agent/utilization_data.rb', line 47

def configured_hostname
  Agent.config[:'utilization.billing_hostname']
end

#configured_logical_processors ⇒ Object

this is slightly ugly, but if a string value is passed in for the env var: NEW_RELIC_UTILIZATION_LOGICAL_PROCESSORS the coercion from EnvironmentSource will turn that into a numerical 0, which is not a reasonable value for logical_processes and should not be sent up



56
57
58
59
 
# File 'lib/new_relic/agent/utilization_data.rb', line 56

def configured_logical_processors
  logical_processors = Agent.config[:'utilization.logical_processors']
  logical_processors unless logical_processors == 0
end

#configured_total_ram_mib ⇒ Object

see comment above as the situation is the same for: NEW_RELIC_UTILIZATION_TOTAL_RAM_MIB



63
64
65
66
 
# File 'lib/new_relic/agent/utilization_data.rb', line 63

def configured_total_ram_mib
  total_ram = Agent.config[:'utilization.total_ram_mib']
  total_ram unless total_ram == 0
end

#container_id ⇒ Object 



34
35
36
 
# File 'lib/new_relic/agent/utilization_data.rb', line 34

def container_id
  ::NewRelic::Agent::SystemInfo.docker_container_id
end

#cpu_count ⇒ Object 



38
39
40
41
 
# File 'lib/new_relic/agent/utilization_data.rb', line 38

def cpu_count
  ::NewRelic::Agent::SystemInfo.clear_processor_info
  ::NewRelic::Agent::SystemInfo.num_logical_processors
end

#fqdn ⇒ Object 



26
27
28
 
# File 'lib/new_relic/agent/utilization_data.rb', line 26

def fqdn
  NewRelic::Agent::Hostname.get_fqdn
end

#hostname ⇒ Object 



22
23
24
 
# File 'lib/new_relic/agent/utilization_data.rb', line 22

def hostname
  NewRelic::Agent::Hostname.get
end

#ip_addresses ⇒ Object 



30
31
32
 
# File 'lib/new_relic/agent/utilization_data.rb', line 30

def ip_addresses
  ::NewRelic::Agent::SystemInfo.ip_addresses
end

#ram_in_mib ⇒ Object 



43
44
45
 
# File 'lib/new_relic/agent/utilization_data.rb', line 43

def ram_in_mib
  ::NewRelic::Agent::SystemInfo.ram_in_mib
end

#to_collector_hash ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/new_relic/agent/utilization_data.rb', line 68

def to_collector_hash
  result = {
    :metadata_version => METADATA_VERSION,
    :logical_processors => cpu_count,
    :total_ram_mib => ram_in_mib,
    :hostname => hostname
  }

  append_vendor_info(result)
  append_docker_info(result)
  append_configured_values(result)
  append_boot_id(result)
  append_ip_address(result)
  append_full_hostname(result)
  append_kubernetes_info(result)

  result
end