Improve logging when MacOSDnsServerAddressStreamProvider cannot be found/loaded (#12732)

violetagg · wleese · web-flow · commit 8957a2e36a0d · 2022-08-25T07:55:59.000+02:00
Motivation: When `MacOSDnsServerAddressStreamProvider` cannot be found/loaded, a warning/error appears in the logs, specifying that without this functionality the DNS resolution might be incorrect. However there is no guidance how this can be fixed. Modifications: - Extend the log message with information for the dependency that is needed in order to resolve this issue. Result: Users will be informed for the missing dependency that will resolve the issue. Related to #11020 Co-authored-by: wvl <nlwilliam@icloud.com>
diff --git a/resolver-dns/src/main/java/io/netty/resolver/dns/DnsServerAddressStreamProviders.java b/resolver-dns/src/main/java/io/netty/resolver/dns/DnsServerAddressStreamProviders.java
@@ -68,10 +68,12 @@ public Object run() {
                 }
             } catch (ClassNotFoundException cause) {
                 LOGGER.warn("Can not find {} in the classpath, fallback to system defaults. This may result in "
-                        + "incorrect DNS resolutions on MacOS.", MACOS_PROVIDER_CLASS_NAME);
+                        + "incorrect DNS resolutions on MacOS. Check whether you have a dependency on "
+                        + "'io.netty:netty-resolver-dns-native-macos'", MACOS_PROVIDER_CLASS_NAME);
             } catch (Throwable cause) {
                 LOGGER.error("Unable to load {}, fallback to system defaults. This may result in "
-                        + "incorrect DNS resolutions on MacOS.", MACOS_PROVIDER_CLASS_NAME, cause);
+                        + "incorrect DNS resolutions on MacOS. Check whether you have a dependency on "
+                        + "'io.netty:netty-resolver-dns-native-macos'", MACOS_PROVIDER_CLASS_NAME, cause);
                 constructor = null;
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -68,10 +68,12 @@ public Object run() {`
`68`	`68`	`}`
`69`	`69`	`} catch (ClassNotFoundException cause) {`
`70`	`70`	`LOGGER.warn("Can not find {} in the classpath, fallback to system defaults. This may result in "`
`71`		`- + "incorrect DNS resolutions on MacOS.", MACOS_PROVIDER_CLASS_NAME);`
	`71`	`+ + "incorrect DNS resolutions on MacOS. Check whether you have a dependency on "`
	`72`	`+ + "'io.netty:netty-resolver-dns-native-macos'", MACOS_PROVIDER_CLASS_NAME);`
`72`	`73`	`} catch (Throwable cause) {`
`73`	`74`	`LOGGER.error("Unable to load {}, fallback to system defaults. This may result in "`
`74`		`- + "incorrect DNS resolutions on MacOS.", MACOS_PROVIDER_CLASS_NAME, cause);`
	`75`	`+ + "incorrect DNS resolutions on MacOS. Check whether you have a dependency on "`
	`76`	`+ + "'io.netty:netty-resolver-dns-native-macos'", MACOS_PROVIDER_CLASS_NAME, cause);`
`75`	`77`	`constructor = null;`
`76`	`78`	`}`
`77`	`79`	`}`