dynamic_resolver.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. package upstream
  2. // Package upstream provides DNS resolution and availability testing for nginx upstream targets,
  3. // with special support for dynamic service discovery and nginx-style SRV record resolution.
  4. //
  5. // # SRV Record Resolution (nginx.org compliant)
  6. //
  7. // This package implements nginx's SRV record resolution rules as documented at nginx.org.
  8. // The service=name parameter enables resolving of DNS SRV records and sets the service name.
  9. //
  10. // Rules for SRV record construction:
  11. //
  12. // 1. If the service name does not contain a dot ("."), then the RFC-compliant name is constructed
  13. // and the TCP protocol is added to the service prefix.
  14. // Example: "backend.example.com service=http resolve" -> "_http._tcp.backend.example.com"
  15. //
  16. // 2. If the service name contains one or more dots, then the name is constructed by joining
  17. // the service prefix and the server name.
  18. // Example: "backend.example.com service=_http._tcp resolve" -> "_http._tcp.backend.example.com"
  19. // Example: "example.com service=server1.backend resolve" -> "server1.backend.example.com"
  20. //
  21. // # Dynamic DNS Integration
  22. //
  23. // The resolver supports various DNS interfaces for service discovery:
  24. // - DNS servers (e.g., Consul DNS on 127.0.0.1:8600, CoreDNS, etc.)
  25. // - Service registration and health checking
  26. // - SRV record-based load balancing with proper priority handling
  27. //
  28. // # Usage Examples
  29. //
  30. // // Create resolver with DNS server
  31. // resolver := NewDynamicResolver("127.0.0.1:8600")
  32. //
  33. // // Resolve nginx-style service URL
  34. // addresses, err := resolver.ResolveService("backend.example.com service=http resolve")
  35. // // This queries "_http._tcp.backend.example.com" SRV records
  36. //
  37. // // Resolve with dotted service name
  38. // addresses, err := resolver.ResolveService("example.com service=server1.backend resolve")
  39. // // This queries "server1.backend.example.com" SRV records
  40. import (
  41. "context"
  42. "fmt"
  43. "net"
  44. "strings"
  45. "time"
  46. )
  47. // DynamicResolver handles DNS resolution through dynamic DNS servers
  48. type DynamicResolver struct {
  49. resolver string // e.g., "127.0.0.1:8600"
  50. }
  51. // NewDynamicResolver creates a new dynamic resolver
  52. func NewDynamicResolver(resolver string) *DynamicResolver {
  53. return &DynamicResolver{
  54. resolver: resolver,
  55. }
  56. }
  57. // ServiceInfo contains parsed service information from nginx config
  58. type ServiceInfo struct {
  59. Hostname string // e.g., "backend.example.com" or "service.consul"
  60. ServiceName string // e.g., "http", "_http._tcp", "server1.backend"
  61. }
  62. // ResolveService resolves a nginx service to actual IP addresses and ports
  63. func (dr *DynamicResolver) ResolveService(serviceURL string) ([]string, error) {
  64. // Parse service URL to extract hostname and service name
  65. serviceInfo, err := dr.parseServiceURL(serviceURL)
  66. if err != nil {
  67. return nil, fmt.Errorf("failed to parse service URL %s: %v", serviceURL, err)
  68. }
  69. // Create a custom resolver that uses the DNS server
  70. dialer := &net.Dialer{
  71. Timeout: 5 * time.Second,
  72. }
  73. resolver := &net.Resolver{
  74. PreferGo: true,
  75. Dial: func(ctx context.Context, network, address string) (net.Conn, error) {
  76. return dialer.DialContext(ctx, network, dr.resolver)
  77. },
  78. }
  79. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  80. defer cancel()
  81. // Construct SRV query domain according to nginx rules
  82. srvDomain := dr.constructSRVDomain(serviceInfo)
  83. // Query for service SRV records
  84. _, srvRecords, err := resolver.LookupSRV(ctx, "", "", srvDomain)
  85. if err != nil {
  86. // Fallback to A record lookup if SRV fails
  87. ips, err := resolver.LookupIPAddr(ctx, srvDomain)
  88. if err != nil {
  89. return nil, fmt.Errorf("failed to resolve service %s: %v", srvDomain, err)
  90. }
  91. // Return IP addresses with default port (80)
  92. var addresses []string
  93. for _, ip := range ips {
  94. addresses = append(addresses, fmt.Sprintf("%s:80", ip.IP.String()))
  95. }
  96. return addresses, nil
  97. }
  98. // Convert SRV records to address:port format
  99. var addresses []string
  100. for _, srv := range srvRecords {
  101. // Resolve the target hostname to IP
  102. ips, err := resolver.LookupIPAddr(ctx, srv.Target)
  103. if err != nil {
  104. continue // Skip this record if resolution fails
  105. }
  106. for _, ip := range ips {
  107. addresses = append(addresses, fmt.Sprintf("%s:%d", ip.IP.String(), srv.Port))
  108. }
  109. }
  110. if len(addresses) == 0 {
  111. return nil, fmt.Errorf("no addresses found for service %s", srvDomain)
  112. }
  113. return addresses, nil
  114. }
  115. // parseServiceURL parses nginx service URL and extracts hostname and service name
  116. func (dr *DynamicResolver) parseServiceURL(serviceURL string) (*ServiceInfo, error) {
  117. serviceURL = strings.TrimSpace(serviceURL)
  118. if serviceURL == "" {
  119. return nil, fmt.Errorf("empty service URL")
  120. }
  121. // Parse nginx format: "hostname service=servicename resolve"
  122. parts := strings.Fields(serviceURL)
  123. if len(parts) < 3 {
  124. return nil, fmt.Errorf("invalid service URL format: %s", serviceURL)
  125. }
  126. hostname := parts[0]
  127. var serviceName string
  128. // Find service=name parameter
  129. for _, part := range parts[1:] {
  130. if strings.HasPrefix(part, "service=") {
  131. serviceName = strings.TrimPrefix(part, "service=")
  132. serviceName = strings.TrimSpace(serviceName)
  133. break
  134. }
  135. }
  136. if serviceName == "" {
  137. return nil, fmt.Errorf("service parameter not found in: %s", serviceURL)
  138. }
  139. return &ServiceInfo{
  140. Hostname: hostname,
  141. ServiceName: serviceName,
  142. }, nil
  143. }
  144. // constructSRVDomain constructs SRV query domain according to nginx.org rules
  145. func (dr *DynamicResolver) constructSRVDomain(serviceInfo *ServiceInfo) string {
  146. // According to nginx.org documentation:
  147. // 1. If service name does not contain a dot ("."), then RFC-compliant name is constructed
  148. // and TCP protocol is added to the service prefix.
  149. // Example: service=http -> _http._tcp.hostname
  150. // 2. If service name contains one or more dots, then the name is constructed by joining
  151. // the service prefix and the server name.
  152. // Example: service=_http._tcp -> _http._tcp.hostname
  153. // Example: service=server1.backend -> server1.backend.hostname
  154. if !strings.Contains(serviceInfo.ServiceName, ".") {
  155. // Case 1: No dots - construct RFC-compliant name with TCP protocol
  156. return fmt.Sprintf("_%s._tcp.%s", serviceInfo.ServiceName, serviceInfo.Hostname)
  157. } else {
  158. // Case 2: Contains dots - join service prefix and hostname
  159. return fmt.Sprintf("%s.%s", serviceInfo.ServiceName, serviceInfo.Hostname)
  160. }
  161. }
  162. // extractServiceName extracts the service name from service URL
  163. // Deprecated: Use parseServiceURL instead for proper nginx-style parsing
  164. func (dr *DynamicResolver) extractServiceName(serviceURL string) string {
  165. serviceInfo, err := dr.parseServiceURL(serviceURL)
  166. if err != nil {
  167. // Fallback to old parsing logic for backward compatibility
  168. serviceURL = strings.TrimSpace(serviceURL)
  169. // Handle empty input
  170. if serviceURL == "" {
  171. return ""
  172. }
  173. // Parse "service.consul service=redacted-net resolve" format
  174. if strings.Contains(serviceURL, "service=") {
  175. parts := strings.Fields(serviceURL)
  176. for _, part := range parts {
  177. if strings.HasPrefix(part, "service=") {
  178. serviceName := strings.TrimPrefix(part, "service=")
  179. // Handle edge cases like "service=" or "service= "
  180. serviceName = strings.TrimSpace(serviceName)
  181. if serviceName == "" {
  182. return ""
  183. }
  184. return serviceName
  185. }
  186. }
  187. }
  188. // Fallback: try to extract from hostname format like "my-service.service.consul"
  189. if strings.Contains(serviceURL, ".service.consul") {
  190. parts := strings.Split(serviceURL, ".")
  191. if len(parts) > 0 {
  192. serviceName := strings.TrimSpace(parts[0])
  193. if serviceName == "" {
  194. return ""
  195. }
  196. return serviceName
  197. }
  198. }
  199. return ""
  200. }
  201. return serviceInfo.ServiceName
  202. }
  203. // TestDynamicTargets performs availability test specifically for dynamic DNS targets
  204. func TestDynamicTargets(dynamicTargets []ProxyTarget) map[string]*Status {
  205. result := make(map[string]*Status)
  206. // Group dynamic targets by resolver
  207. dynamicTargetsByResolver := make(map[string][]ProxyTarget)
  208. for _, target := range dynamicTargets {
  209. if target.Resolver != "" {
  210. dynamicTargetsByResolver[target.Resolver] = append(dynamicTargetsByResolver[target.Resolver], target)
  211. } else {
  212. // No resolver specified, mark as offline
  213. key := formatSocketAddress(target.Host, target.Port)
  214. result[key] = &Status{
  215. Online: false,
  216. Latency: 0,
  217. }
  218. }
  219. }
  220. // Test each resolver group
  221. for resolver, targets := range dynamicTargetsByResolver {
  222. dynamicResolver := NewDynamicResolver(resolver)
  223. for _, target := range targets {
  224. key := formatSocketAddress(target.Host, target.Port)
  225. // Try to resolve the service
  226. addresses, err := dynamicResolver.ResolveService(target.ServiceURL)
  227. if err != nil {
  228. // If resolution fails, mark as offline
  229. result[key] = &Status{
  230. Online: false,
  231. Latency: 0,
  232. }
  233. continue
  234. }
  235. // Test the first resolved address as representative
  236. if len(addresses) > 0 {
  237. addressResults := AvailabilityTest(addresses[:1])
  238. if status, exists := addressResults[addresses[0]]; exists {
  239. result[key] = status
  240. } else {
  241. result[key] = &Status{
  242. Online: false,
  243. Latency: 0,
  244. }
  245. }
  246. } else {
  247. result[key] = &Status{
  248. Online: false,
  249. Latency: 0,
  250. }
  251. }
  252. }
  253. }
  254. return result
  255. }
  256. // EnhancedAvailabilityTest performs availability test with dynamic DNS resolution support
  257. // Deprecated: Use TestDynamicTargets for dynamic targets and AvailabilityTest for regular targets
  258. func EnhancedAvailabilityTest(targets []ProxyTarget) map[string]*Status {
  259. result := make(map[string]*Status)
  260. // Group targets by type
  261. dynamicTargets := make([]ProxyTarget, 0)
  262. regularTargets := make([]string, 0)
  263. for _, target := range targets {
  264. if target.IsConsul && target.Resolver != "" {
  265. dynamicTargets = append(dynamicTargets, target)
  266. } else {
  267. // Regular target - use properly formatted socket address for traditional AvailabilityTest
  268. key := formatSocketAddress(target.Host, target.Port)
  269. regularTargets = append(regularTargets, key)
  270. }
  271. }
  272. // Use traditional AvailabilityTest for regular targets (more efficient)
  273. if len(regularTargets) > 0 {
  274. regularResults := AvailabilityTest(regularTargets)
  275. // Merge results
  276. for k, v := range regularResults {
  277. result[k] = v
  278. }
  279. }
  280. // Test dynamic targets with DNS resolution
  281. if len(dynamicTargets) > 0 {
  282. dynamicResults := TestDynamicTargets(dynamicTargets)
  283. for k, v := range dynamicResults {
  284. result[k] = v
  285. }
  286. }
  287. return result
  288. }