module Ohai::Mixin::AzureMetadata

This code parses the Azure Instance Metadata API to provide details of the running instance.

The code probes the instance metadata endpoint for available versions, determines the most advanced version known to work and executes the metadata retrieval using that version.

If no compatible version is found, an empty hash is returned.

Public Instance Methods

best_api_version() click to toggle source
# File lib/ohai/mixin/azure_metadata.rb, line 47
def best_api_version
  @api_version ||= begin
    logger.trace("Mixin AzureMetadata: Fetching http://#{AZURE_METADATA_ADDR}/metadata/instance to determine the latest supported metadata release")
    response = http_get("/metadata/instance")
    if response.code == "404"
      logger.trace("Mixin AzureMetadata: Received HTTP 404 from metadata server while determining API version, assuming #{AZURE_SUPPORTED_VERSIONS.last}")
      return AZURE_SUPPORTED_VERSIONS.last
    elsif response.code != "400" # 400 is actually what we want
      raise "Mixin AzureMetadata: Unable to determine Azure metadata version (returned #{response.code} response)"
    end

    # azure returns a list of the 3 latest versions it supports
    versions = parse_json(response.body).fetch("newest-versions", [])
    versions.sort!

    until versions.empty? || AZURE_SUPPORTED_VERSIONS.include?(versions.last)
      pv = versions.pop
      logger.trace("Mixin AzureMetadata: Azure metadata version #{pv} is not present in the versions provided by the Azure Instance Metadata service")
    end

    if versions.empty?
      logger.debug "Mixin AzureMetadata: The short list of supported versions provided by Azure Instance Metadata service doesn't match any known versions to Ohai. Using the latest supported release known to Ohai instead: #{AZURE_SUPPORTED_VERSIONS.last}"
      return AZURE_SUPPORTED_VERSIONS.last
    end

    logger.trace("Mixin AzureMetadata: Latest supported Azure metadata version: #{versions.last}")
    versions.last
  end
end
fetch_metadata(_api_version = nil) click to toggle source
# File lib/ohai/mixin/azure_metadata.rb, line 88
def fetch_metadata(_api_version = nil)
  metadata_url = "/metadata/instance?api-version=#{best_api_version}"
  logger.trace("Mixin AzureMetadata: Fetching metadata from host #{AZURE_METADATA_ADDR} at #{metadata_url}")
  response = http_get(metadata_url)
  if response.code == "200"
    json_data = parse_json(response.body)
    if json_data.nil?
      logger.warn("Mixin AzureMetadata: Metadata response is NOT valid JSON")
    end
    json_data
  else
    logger.warn("Mixin AzureMetadata: Received response code #{response.code} requesting metadata")
    nil
  end
end
http_get(uri) click to toggle source

fetch the meta content with a timeout and the required header and a read timeout of 6s

@param [String] the relative uri to fetch from the Azure Metadata Service URL

@return [Net::HTTP]

# File lib/ohai/mixin/azure_metadata.rb, line 82
def http_get(uri)
  conn = Net::HTTP.start(AZURE_METADATA_ADDR)
  conn.read_timeout = 6
  conn.get(uri, { "Metadata" => "true" })
end