From bfe9674c708a843bcfd052b60aed64f0deaf00b6 Mon Sep 17 00:00:00 2001 From: Bianca Lisle <40155621+blva@users.noreply.github.com> Date: Wed, 11 Sep 2024 09:42:24 +0100 Subject: [PATCH] CLOUDP-272621: Update log downloads docs (#3253) --- docs/command/atlas-deployments-logs.txt | 2 +- docs/command/atlas-logs-download.txt | 2 +- docs/command/atlas-streams-instances-download.txt | 2 +- internal/usage/usage.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/command/atlas-deployments-logs.txt b/docs/command/atlas-deployments-logs.txt index b44808faa0..9d4c889676 100644 --- a/docs/command/atlas-deployments-logs.txt +++ b/docs/command/atlas-deployments-logs.txt @@ -42,7 +42,7 @@ Options * - --end - int - false - - UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp. + - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. * - --force - - false diff --git a/docs/command/atlas-logs-download.txt b/docs/command/atlas-logs-download.txt index 79f8010fc4..576714f0de 100644 --- a/docs/command/atlas-logs-download.txt +++ b/docs/command/atlas-logs-download.txt @@ -68,7 +68,7 @@ Options * - --end - int - false - - UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp. + - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. * - --force - - false diff --git a/docs/command/atlas-streams-instances-download.txt b/docs/command/atlas-streams-instances-download.txt index ef29452abd..8cee843c81 100644 --- a/docs/command/atlas-streams-instances-download.txt +++ b/docs/command/atlas-streams-instances-download.txt @@ -56,7 +56,7 @@ Options * - --end - int - false - - UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp. + - Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time. * - --force - - false diff --git a/internal/usage/usage.go b/internal/usage/usage.go index 678d8a2bf1..c748ec7b20 100644 --- a/internal/usage/usage.go +++ b/internal/usage/usage.go @@ -92,7 +92,7 @@ dbName and collection are required only for built-in roles.` Email = "Email address for the user." LogOut = "Output file name. This value defaults to the log name." LogStart = "UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp." - LogEnd = "UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp." + LogEnd = "Ending date and time for the range of log messages to retrieve, given in UNIX time. Defaults to the start date plus 24 hours, if the start date is set. If start date is not provided, ending time defaults to the current time." MeasurementStart = "ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request." MeasurementEnd = "ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request." MeasurementType = "Measurements to return. This option returns all measurements by default. Valid values include DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT"