[APP-6612] Add Filters for Downloading Logs #4673

JosephBorodach · 2025-01-03T17:57:10Z

This PR implements additional filters to the machines logs CLI command, specifically: keyword, start time, end time and log level. Below are the details and test cases for the command:

See ticket here

Invalid: Without any arguments

go run cli/viam/main.go machines logs

With Keyword Filter

go run cli/viam/main.go machines logs -machine="1" --organization="viam-dev" --location="office temp" --keyword="stack"

With Error Level

go run cli/viam/main.go machines logs -machine="1" --organization="viam-dev" --location="office temp" --levels="error"

Start Time

Start from after the last log

go run cli/viam/main.go machines logs --machine="1" --organization="viam-dev" --location="office temp" --start="2025-01-10T21:30:00Z"

Start from a time with only a few logs

go run cli/viam/main.go machines logs --machine="1" --organization="viam-dev" --location="office temp" --start="2025-01-10T21:30:00Z"

End Time

Notice how in the second screenshot, we skip the logs passed 15:16.

Start & End Time

End Case

Do we not want to output something prettier if their are no logs to display?

…gs to text or json file

…ng the logs, instead of retrieving all of the logs and then writing them all to the file

…ck when writing to file

…n object

…t arguments to be paired - either both are provided, or an error will be displated

…ds called on the *viamClient

… logs cli command

purplenicole730

LGTM! There were some changes in flag names that were recently merged in, but I don't suspect it should affect your PR too much

purplenicole730 · 2025-01-07T15:02:31Z

cli/app.go

+						&cli.StringFlag{
+							Name:  logsFlagOutputFile,
+							Usage: "path to output file",
+						},
+						&cli.StringFlag{
+							Name:  logsFlagFormat,
+							Usage: "file format (text or json)",
+						},


maybe mention needs format flag, needs output flag for the users in the usage text? Not sure if necessary, but a suggestion, since I feel like I would read that as being able to format it when printing to console as well

You can decide the format when printing to the console! The command will default to text if the format flag is not included. Are you suggesting something else?

Oh, you can also format it for the console! Ignore me then :)

stuqdog

A couple small things but generally lgtm

stuqdog · 2025-01-07T16:02:11Z

cli/app.go

+	logsFlagFormat     = "format"
+	logsFlagOutputFile = "output"
+	logsFlagKeyword    = "keyword"
+	logsFlagLevels     = "levels"
+	logsFlagStartTime  = "start"
+	logsFlagEndTime    = "end"
+	logsFlagErrors     = "errors"
+	logsFlagTail       = "tail"
+	logsFlagCount      = "count"


it looks like some of these were added in a separate PR already. Would you mind pulling down main so we can get a more up-to-date look at what the diff is precisely?

stuqdog · 2025-01-07T16:04:28Z

cli/app.go

+	logsFlagStartTime  = "start"
+	logsFlagEndTime    = "end"


(minor) I'm gonna ask you to do a bit of bookkeeping for us here if you don't mind! We already have a "start" flag and an "end" flag (dataFlagStart and dataFlagEnd). Would you be willing to rename those to generalFlagStart and generalFlagEnd and then update call sites so that there's only the single instance of a --start or --end flag?

…s-For-Downloading-Logs

…Time to generalFlagStart and generalFlagEnd

JosephBorodach added 11 commits December 31, 2024 15:41

Support downloading logs

386db8c

Restructure RobotsLogsAction to extend functionality for outputing lo…

232f143

…gs to text or json file

Refactor saveLogsToDisk to handle large log files efficiently

6a02466

Restructure fetchAndSaveLogs to write logs to the file while retrievi…

e14e9be

…ng the logs, instead of retrieving all of the logs and then writing them all to the file

Add nolint for not checking the error returned when closing the file

761d6fe

add headers to log output for file downloads

05dc2c2

Add constant variable for FormatJSON to appease linter. Add error che…

921a908

…ck when writing to file

Make the json format consecutive json object instead of one large jso…

690b887

…n object

Make error handling more comprehensive for requiring Output and Forma…

e2786a5

…t arguments to be paired - either both are provided, or an error will be displated

Make fetchAndSaveLogs, streamLogsForPart and printLogsToConsole metho…

225b5cb

…ds called on the *viamClient

Add filters including keyword, levels, and start and end times to the…

b0698af

… logs cli command

JosephBorodach requested a review from a team as a code owner January 3, 2025 17:57

JosephBorodach requested review from stuqdog and purplenicole730 and removed request for a team January 3, 2025 17:57

Base automatically changed from APP-6612-Support-Downloading-Logs to main January 7, 2025 14:17

purplenicole730 approved these changes Jan 7, 2025

View reviewed changes

stuqdog reviewed Jan 7, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into APP-6612-Add-Filter…

b3e00d3

…s-For-Downloading-Logs

viambot added the safe to test This pull request is marked safe to test from a trusted zone label Jan 8, 2025

Replace dataFlagStart, dataFlagEnd, logsFlagStartTime and logsFlagEnd…

bf0df5f

…Time to generalFlagStart and generalFlagEnd

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 8, 2025

Add logic to streamLogsForPart for the filters

7abd091

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 8, 2025

Remove validation checks

0c6c6f9

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 8, 2025

viambot added the safe to test This pull request is marked safe to test from a trusted zone label Jan 8, 2025

Remove constant variables for formatJSON and formatText

b292477

JosephBorodach force-pushed the APP-6612-Add-Filters-For-Downloading-Logs branch from e627f4b to b292477 Compare January 8, 2025 18:53

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 8, 2025

Correct cli argument types to strings from timestamps

0d65512

JosephBorodach force-pushed the APP-6612-Add-Filters-For-Downloading-Logs branch from cb55d25 to 0d65512 Compare January 9, 2025 15:59

viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Jan 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[APP-6612] Add Filters for Downloading Logs #4673

[APP-6612] Add Filters for Downloading Logs #4673

JosephBorodach commented Jan 3, 2025 •

edited

Loading

purplenicole730 left a comment

purplenicole730 Jan 7, 2025

JosephBorodach Jan 8, 2025

purplenicole730 Jan 9, 2025

stuqdog left a comment

stuqdog Jan 7, 2025

stuqdog Jan 7, 2025

[APP-6612] Add Filters for Downloading Logs #4673

Are you sure you want to change the base?

[APP-6612] Add Filters for Downloading Logs #4673

Conversation

JosephBorodach commented Jan 3, 2025 • edited Loading

Invalid: Without any arguments

With Keyword Filter

With Error Level

Start Time

Start from after the last log

Start from a time with only a few logs

End Time

Start & End Time

End Case

purplenicole730 left a comment

Choose a reason for hiding this comment

purplenicole730 Jan 7, 2025

Choose a reason for hiding this comment

JosephBorodach Jan 8, 2025

Choose a reason for hiding this comment

purplenicole730 Jan 9, 2025

Choose a reason for hiding this comment

stuqdog left a comment

Choose a reason for hiding this comment

stuqdog Jan 7, 2025

Choose a reason for hiding this comment

stuqdog Jan 7, 2025

Choose a reason for hiding this comment

JosephBorodach commented Jan 3, 2025 •

edited

Loading