[jira] [Commented] (GEODE-8798) export logs command with --start-time or --end-time arguments needs improvement

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/GEODE-8798?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17259109#comment-17259109 ] 

ASF GitHub Bot commented on GEODE-8798:
---------------------------------------

karensmolermiller commented on a change in pull request #5863:
URL: https://github.com/apache/geode/pull/5863#discussion_r552110565



##########
File path: geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
##########
@@ -183,7 +183,9 @@ Latest\server1\region2_20121001.gfd on host : 192.0.2.0
 
 Export logs to a given directory.
 
-All files that have logs in the specified time range will be exported. If no time range is specified, all logs will be exported.
+All files that have logs in the specified time range will be exported. If no time range is specified, all logs will be exported. It should be noted that when specifying an `--end-time` argument using a date only, the time is assumed to be `00:00`, meaning that no logs that were written on the date provided will be exported, only those written up until `23:59:59.999` on the day prior.
+
+When using the `yyyy/MM/dd/HH/mm/ss/SSS/z` format for `--start-time` or `--end-time`, the time zone, denoted `z`, should be specified as either a 3-letter time zone such as `PST` or as an offset to GMT/UTC such as `GMT+08:00`.

Review comment:
       I'd like to see these format descriptions/improvements in the description of the parameters.
   
   I think that your wording is adequate, but I came up with this possibility for a rewrite of the added info for the end time info.  Use it if you like.
   "An end time specified by only a date implements a time of `00:00`. This exports logs written up until `23:59:59.999` on the date prior to the one specified.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> export logs command with --start-time or --end-time arguments needs improvement
> -------------------------------------------------------------------------------
>
>                 Key: GEODE-8798
>                 URL: https://issues.apache.org/jira/browse/GEODE-8798
>             Project: Geode
>          Issue Type: Improvement
>          Components: docs, gfsh
>    Affects Versions: 1.12.0, 1.14.0, 1.13.1
>            Reporter: Donal Evans
>            Assignee: Donal Evans
>            Priority: Major
>              Labels: pull-request-available
>
> If an invalid or improperly formatted argument for --start-time or --end-time is provided to the export logs gfsh command, the actual time cutoffs used to determine which logs to export may be inconsistent or unexpected, but no indication is given to the user that anything is wrong.
> In addition to this, the documentation for the command could be made clearer to better allow users to understand the correct use of the arguments.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)