Module: Datadog::Core::Utils::Network

Defined in:

lib/datadog/core/utils/network.rb

Overview

Common Network utility functions.

Constant Summary

DEFAULT_IP_HEADERS_NAMES =

%w[
  x-forwarded-for
  x-real-ip
  true-client-ip
  x-client-ip
  x-forwarded
  forwarded-for
  x-cluster-client-ip
  fastly-client-ip
  cf-connecting-ip
  cf-connecting-ipv6
].freeze

Class Method Summary

• .stripped_ip(ip) ⇒ String^?
• .stripped_ip_from_request_headers(headers, ip_headers_to_check: DEFAULT_IP_HEADERS_NAMES) ⇒ String^?

  Returns a client IP associated with the request if it was retrieved successfully.

Class Method Details

.stripped_ip(ip) ⇒ String^?

Parameters:

• IP (String) —

  value.

Returns:

• (String) —

  IP value without the port and the zone indentifier.

• (nil) —

  when no valid IP value found.

# File 'lib/datadog/core/utils/network.rb', line 41

def stripped_ip(ip)
  ip = ip_to_ipaddr(ip)
  ip ? ip.to_s : nil
end

.stripped_ip_from_request_headers(headers, ip_headers_to_check: DEFAULT_IP_HEADERS_NAMES) ⇒ String^?

Returns a client IP associated with the request if it was

retrieved successfully.

Parameters:

• headers (Datadog::Core::HeaderCollection, #get, nil) —

  The request headers

• list (Array<String>) —

  of headers to check.

Returns:

• (String) —

  IP value without the port and the zone indentifier.

• (nil) —

  when no valid IP value found.

# File 'lib/datadog/core/utils/network.rb', line 32

def stripped_ip_from_request_headers(headers, ip_headers_to_check: DEFAULT_IP_HEADERS_NAMES)
  ip = ip_header(headers, ip_headers_to_check)

  ip ? ip.to_s : nil
end