Add file path examples to logging flags
@ConfigValue(section = LOGGING_SECTION, name = "http-logs", example = "true")
private Boolean httpLogs = DEFAULT_HTTP_LOGS;
- @Parameter(description = "File to write out logs", names = "--log", arity = 1)
- @ConfigValue(section = LOGGING_SECTION, name = "log-file", example = "true")
+ @Parameter(description = "File to write out logs. "
+ + "Ensure the file path is compatible with the operating system's file path.\n"
+ + "Windows path example : \\\\path\\to\\file\\gridlog.log OR "
+ + "C:\\path\\path\\to\\file\\gridlog.log \n"
+ + "Linux/Unix/MacOS path example : /path/to/file/gridlog.log \n"
+ , names = "--log", arity = 1)
+ @ConfigValue(section = LOGGING_SECTION, name = "log-file", example = {"'\\\\path\\to\\file\\gridlog.log'",
+ "'C:\\path\\path\\to\\file\\gridlog.log'",
+ "'/path/to/file/gridlog.log'"})
private String logFile;
@Parameter(description = "Log encoding", names = "--log-encoding", arity = 1)
