[APP-6612] Add Filters for Downloading Logs

cli/app.go

@@ -20,11 +20,16 @@ const (
 	disableProfilesFlag = "disable-profiles"
 	profileFlagName     = "profile-name"
 
+	generalFlagStart = "start"
+	generalFlagEnd   = "end"
+
 	// TODO: RSDK-6683.
 	quietFlag = "quiet"
 
 	logsFlagFormat     = "format"
 	logsFlagOutputFile = "output"
+	logsFlagKeyword    = "keyword"
+	logsFlagLevels     = "levels"
 	logsFlagErrors     = "errors"
 	logsFlagTail       = "tail"
 	logsFlagCount      = "count"
@@ -114,8 +119,6 @@ const (
 	dataFlagResourceName                   = "resource-name"
 	dataFlagMethod                         = "method"
 	dataFlagMimeTypes                      = "mime-types"
-	dataFlagStart                          = "start"
-	dataFlagEnd                            = "end"
 	dataFlagParallelDownloads              = "parallel"
 	dataFlagTags                           = "tags"
 	dataFlagBboxLabels                     = "bbox-labels"
@@ -211,11 +214,11 @@ var commonFilterFlags = []cli.Flag{
 		Usage: "mime types filter",
 	},
 	&cli.StringFlag{
-		Name:  dataFlagStart,
+		Name:  generalFlagStart,
 		Usage: "ISO-8601 timestamp in RFC3339 format indicating the start of the interval filter",
 	},
 	&cli.StringFlag{
-		Name:  dataFlagEnd,
+		Name:  generalFlagEnd,
 		Usage: "ISO-8601 timestamp in RFC3339 format indicating the end of the interval filter",
 	},
 	&cli.StringSliceFlag{
@@ -1060,12 +1063,12 @@ var app = &cli.App{
 									Usage:    "orgs filter",
 								},
 								&cli.StringFlag{
-									Name:     dataFlagStart,
+									Name:     generalFlagStart,
 									Required: true,
 									Usage:    "ISO-8601 timestamp in RFC3339 format indicating the start of the interval filter",
 								},
 								&cli.StringFlag{
-									Name:     dataFlagEnd,
+									Name:     generalFlagEnd,
 									Required: true,
 									Usage:    "ISO-8601 timestamp in RFC3339 format indicating the end of the interval filter",
 								},
@@ -1792,9 +1795,21 @@ var app = &cli.App{
 							Name:  logsFlagFormat,
 							Usage: "file format (text or json)",
 						},
-						&cli.BoolFlag{
-							Name:  logsFlagErrors,
-							Usage: "show only errors",
+						&cli.StringFlag{
+							Name:  logsFlagKeyword,
+							Usage: "filter logs by keyword",
+						},
+						&cli.StringSliceFlag{
+							Name:  logsFlagLevels,
+							Usage: "filter logs by levels (e.g., info, warn, error)",
+						},
+						&cli.StringFlag{
+							Name:  generalFlagStart,
+							Usage: "ISO-8601 timestamp in RFC3339 format indicating the start of the interval filter",
+						},
+						&cli.StringFlag{
+							Name:  generalFlagEnd,
+							Usage: "ISO-8601 timestamp in RFC3339 format indicating the end of the interval filter",
 						},
 						&cli.IntFlag{
 							Name:        logsFlagCount,

cli/client.go

@@ -747,7 +747,10 @@ type robotsLogsArgs struct {
 	Machine      string
 	Output       string
 	Format       string
-	Errors       bool
+	Keyword      string
+	Levels       []string
+	Start        string
+	End          string
 	Count        int
 }
 
@@ -758,6 +761,16 @@ func RobotsLogsAction(c *cli.Context, args robotsLogsArgs) error {
 		return err
 	}
 
+	// Check if both start time and count are provided
+	if args.Start != "" && args.Count > 0 && args.End == "" {
+		return errors.New("unsupported functionality: specifying both a start time and a count without an end time is not supported. " +
+			"This behavior can be counterintuitive because logs are currently only sorted in descending order. " +
+			"For example, if there are 200 logs after the specified start time and you request 10 logs, it will return the 10 most recent logs, " +
+			"rather than the 10 logs closest to the start time. " +
+			"Please provide either a start time and an end time to define a clear range, or a count without a start time for recent logs",
+		)
+	}
+
 	orgStr := args.Organization
 	locStr := args.Location
 	robotStr := args.Machine
@@ -823,32 +836,39 @@ func (c *viamClient) streamLogsForPart(part *apppb.RobotPart, args robotsLogsArg
 		return err
 	}
 
+	startTime, err := parseTimeString(args.Start)
+	if err != nil {
+		return errors.Wrap(err, "invalid start time format")
+	}
+	endTime, err := parseTimeString(args.End)
+	if err != nil {
+		return errors.Wrap(err, "invalid end time format")
+	}
+
 	// Write logs for this part
 	var pageToken string
 	for logsFetched := 0; logsFetched < numLogs; {
+		remainingLogs := int64(numLogs - logsFetched)
+		if remainingLogs > 100 {
+			remainingLogs = int64(100)
+		}
 		resp, err := c.client.GetRobotPartLogs(c.c.Context, &apppb.GetRobotPartLogsRequest{
-			Id:         part.Id,
-			ErrorsOnly: args.Errors,
-			PageToken:  &pageToken,
+			Id:        part.Id,
+			Filter:    &args.Keyword,
+			PageToken: &pageToken,
+			Levels:    args.Levels,
+			Start:     startTime,
+			End:       endTime,
+			Limit:     &remainingLogs,
 		})
 		if err != nil {
 			return errors.Wrap(err, "failed to fetch logs")
 		}
 
-		pageToken = resp.NextPageToken
-		// Break in the event of no logs in GetRobotPartLogsResponse or when
-		// page token is empty (no more pages).
-		if resp.Logs == nil || pageToken == "" {
+		if len(resp.Logs) == 0 {
 			break
 		}
 
-		// Truncate this intermediate slice of resp.Logs based on how many logs
-		// are still required by numLogs.
-		remainingLogsNeeded := numLogs - logsFetched
-		if remainingLogsNeeded < len(resp.Logs) {
-			resp.Logs = resp.Logs[:remainingLogsNeeded]
-		}
-
 		for _, log := range resp.Logs {
 			formattedLog, err := formatLog(log, part.Name, args.Format)
 			if err != nil {
@@ -861,6 +881,12 @@ func (c *viamClient) streamLogsForPart(part *apppb.RobotPart, args robotsLogsArg
 		}
 
 		logsFetched += len(resp.Logs)
+		pageToken = resp.NextPageToken
+
+		if pageToken == "" {
+			// End of pages
+			break
+		}
 	}
 
 	return nil

cli/data.go

@@ -23,7 +23,6 @@ import (
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/encoding/protojson"
-	"google.golang.org/protobuf/types/known/timestamppb"
 
 	"go.viam.com/rdk/data"
 )
@@ -308,23 +307,14 @@ func createExportTabularRequest(c *cli.Context) (*datapb.ExportTabularDataReques
 }
 
 func createCaptureInterval(startStr, endStr string) (*datapb.CaptureInterval, error) {
-	var start *timestamppb.Timestamp
-	var end *timestamppb.Timestamp
-	timeLayout := time.RFC3339
-
-	if startStr != "" {
-		t, err := time.Parse(timeLayout, startStr)
-		if err != nil {
-			return nil, errors.Wrap(err, "could not parse start flag")
-		}
-		start = timestamppb.New(t)
+	start, err := parseTimeString(startStr)
+	if err != nil {
+		return nil, err
 	}
-	if endStr != "" {
-		t, err := time.Parse(timeLayout, endStr)
-		if err != nil {
-			return nil, errors.Wrap(err, "could not parse end flag")
-		}
-		end = timestamppb.New(t)
+
+	end, err := parseTimeString(endStr)
+	if err != nil {
+		return nil, err
 	}
 
 	return &datapb.CaptureInterval{

cli/utils.go

@@ -5,9 +5,11 @@ import (
 	"path/filepath"
 	"regexp"
 	"strings"
+	"time"
 
 	"github.com/pkg/errors"
 	apppb "go.viam.com/api/app/v1"
+	"google.golang.org/protobuf/types/known/timestamppb"
 )
 
 // samePath returns true if abs(path1) and abs(path2) are the same.
@@ -93,6 +95,19 @@ func parseBillingAddress(address string) (*apppb.BillingAddress, error) {
 	}, nil
 }
 
+func parseTimeString(timeStr string) (*timestamppb.Timestamp, error) {
+	if timeStr == "" {
+		return nil, nil
+	}
+
+	t, err := time.Parse(time.RFC3339, timeStr)
+	if err != nil {
+		return nil, errors.Wrapf(err, "could not parse time string: %s", timeStr)
+	}
+
+	return timestamppb.New(t), nil
+}
+
 func formatStringForOutput(protoString, prefixToTrim string) string {
 	return strings.ToLower(strings.TrimPrefix(protoString, prefixToTrim))
 }