RSDK-12623: Viam cli can work with trace files from viam-server #5552
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benjirewis marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,311 @@ | ||
| package cli | ||
|
|
||
| import ( | ||
| stderrors "errors" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "time" | ||
|
|
||
| "github.com/pkg/errors" | ||
| "github.com/urfave/cli/v2" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc" | ||
| tracepb "go.opentelemetry.io/proto/otlp/trace/v1" | ||
| "go.viam.com/utils/perf" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
|
|
||
| "go.viam.com/rdk/logging" | ||
| "go.viam.com/rdk/protoutils" | ||
| "go.viam.com/rdk/services/shell" | ||
| ) | ||
|
|
||
| var tracesPath = path.Join("~", ".viam", "trace") | ||
|
|
||
| type traceGetRemoteArgs struct { | ||
| Organization string | ||
| Location string | ||
| Machine string | ||
| Part string | ||
| } | ||
|
|
||
| type traceImportRemoteArgs struct { | ||
| Organization string | ||
| Location string | ||
| Machine string | ||
| Part string | ||
| Endpoint string | ||
| } | ||
|
|
||
| type traceImportLocalArgs struct { | ||
| Endpoint string | ||
| } | ||
|
|
||
| func traceImportRemoteAction(ctx *cli.Context, args traceImportRemoteArgs) error { | ||
| client, err := newViamClient(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| globalArgs, err := getGlobalArgs(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| logger := globalArgs.createLogger() | ||
| tmp, err := os.MkdirTemp("", "viamtraceimport") | ||
| if err != nil { | ||
| return err | ||
| } | ||
| //nolint: errcheck | ||
| defer os.RemoveAll(tmp) | ||
| if err := client.tracesGetRemoteAction( | ||
| ctx, | ||
| traceGetRemoteArgs{ | ||
| Organization: args.Organization, | ||
| Location: args.Location, | ||
| Machine: args.Machine, | ||
| Part: args.Part, | ||
| }, | ||
| tmp, | ||
| false, | ||
| globalArgs.Debug, | ||
| logger, | ||
| ); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return traceImportLocal(ctx, traceImportLocalArgs{ | ||
| Endpoint: args.Endpoint, | ||
| }, | ||
| filepath.Join(tmp, "traces"), | ||
| ) | ||
| } | ||
|
|
||
| func (c *viamClient) tracesGetRemoteAction( | ||
| ctx *cli.Context, | ||
| flagArgs traceGetRemoteArgs, | ||
| target string, | ||
| getAll bool, | ||
| debug bool, | ||
| logger logging.Logger, | ||
| ) error { | ||
| part, err := c.robotPart(flagArgs.Organization, flagArgs.Location, flagArgs.Machine, flagArgs.Part) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // Intentional use of path instead of filepath: Windows understands both / and | ||
| // \ as path separators, and we don't want a cli running on Windows to send | ||
| // a path using \ to a *NIX machine. | ||
| src := path.Join(tracesPath, part.Id) | ||
| // if getAll is set then download the entire directory, including rotated | ||
| // files. Otherwise just get the current file. | ||
| if !getAll { | ||
| src = path.Join(src, "traces") | ||
| } | ||
| gArgs, err := getGlobalArgs(ctx) | ||
| quiet := err == nil && gArgs != nil && gArgs.Quiet | ||
| var startTime time.Time | ||
| if !quiet { | ||
| startTime = time.Now() | ||
| printf(ctx.App.Writer, "Saving to %s ...", path.Join(target)) | ||
| } | ||
| if err := c.copyFilesFromMachine( | ||
| flagArgs.Organization, | ||
| flagArgs.Location, | ||
| flagArgs.Machine, | ||
| flagArgs.Part, | ||
| debug, | ||
| true, | ||
| false, | ||
| []string{src}, | ||
| target, | ||
| logger, | ||
| ); err != nil { | ||
| if statusErr := status.Convert(err); statusErr != nil && | ||
| statusErr.Code() == codes.InvalidArgument && | ||
| statusErr.Message() == shell.ErrMsgDirectoryCopyRequestNoRecursion { | ||
| return errDirectoryCopyRequestNoRecursion | ||
| } | ||
| return err | ||
| } | ||
| if !quiet { | ||
| printf(ctx.App.Writer, "Download finished in %s.", time.Since(startTime)) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func tracePrintRemoteAction( | ||
| ctx *cli.Context, | ||
| args traceGetRemoteArgs, | ||
| ) error { | ||
| client, err := newViamClient(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| globalArgs, err := getGlobalArgs(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| logger := globalArgs.createLogger() | ||
| tmp, err := os.MkdirTemp("", "viamtraceimport") | ||
| if err != nil { | ||
| return err | ||
| } | ||
| //nolint: errcheck | ||
| defer os.RemoveAll(tmp) | ||
| if err := client.tracesGetRemoteAction( | ||
| ctx, | ||
| args, | ||
| tmp, | ||
| false, | ||
| globalArgs.Debug, | ||
| logger, | ||
| ); err != nil { | ||
| return err | ||
| } | ||
| return tracePrintLocal(ctx, filepath.Join(tmp, "traces")) | ||
| } | ||
|
|
||
| func getSingularArg(ctx *cli.Context) (string, error) { | ||
| cliArgs := ctx.Args().Slice() | ||
| var result string | ||
| switch numArgs := len(cliArgs); numArgs { | ||
| case 1: | ||
| result = cliArgs[0] | ||
| default: | ||
| return "", wrongNumArgsError{have: numArgs, min: 1} | ||
| } | ||
| return result, nil | ||
| } | ||
|
|
||
| func traceGetRemoteAction(ctx *cli.Context, args traceGetRemoteArgs) error { | ||
| cliArgs := ctx.Args().Slice() | ||
| var targetPath string | ||
| switch numArgs := len(cliArgs); numArgs { | ||
| case 0: | ||
| var err error | ||
| targetPath, err = os.Getwd() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| case 1: | ||
| targetPath = cliArgs[0] | ||
| default: | ||
| return wrongNumArgsError{numArgs, 0, 1} | ||
| } | ||
|
|
||
| client, err := newViamClient(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| globalArgs, err := getGlobalArgs(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| logger := globalArgs.createLogger() | ||
|
|
||
| return client.tracesGetRemoteAction(ctx, args, targetPath, true, globalArgs.Debug, logger) | ||
| } | ||
|
|
||
| func tracePrintLocalAction( | ||
| ctx *cli.Context, | ||
| _ struct{}, | ||
| ) error { | ||
| target, err := getSingularArg(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return tracePrintLocal(ctx, target) | ||
| } | ||
|
|
||
| func tracePrintLocal( | ||
| ctx *cli.Context, | ||
| source string, | ||
| ) error { | ||
| //nolint: gosec | ||
| traceFile, err := os.Open(source) | ||
| if err != nil { | ||
| if os.IsNotExist(err) { | ||
| printf(ctx.App.Writer, "No traces found") | ||
| return nil | ||
| } | ||
| return errors.Wrap(err, "failed to open trace file") | ||
| } | ||
| traceReader := protoutils.NewDelimitedProtoReader[tracepb.ResourceSpans](traceFile) | ||
| //nolint: errcheck | ||
| defer traceReader.Close() | ||
|
|
||
| devExporter := perf.NewOtelDevelopmentExporter() | ||
| if err := devExporter.Start(); err != nil { | ||
| return err | ||
| } | ||
| defer devExporter.Stop() | ||
| var msg tracepb.ResourceSpans | ||
| err = nil | ||
| for resource := range traceReader.AllWithMemory(&msg) { | ||
| for _, scope := range resource.ScopeSpans { | ||
| err = stderrors.Join(err, devExporter.ExportOTLPSpans(ctx.Context, scope.Spans)) | ||
| } | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| func traceImportLocalAction( | ||
| ctx *cli.Context, | ||
| args traceImportLocalArgs, | ||
| ) error { | ||
| target, err := getSingularArg(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return traceImportLocal(ctx, args, target) | ||
| } | ||
|
|
||
| func traceImportLocal( | ||
| ctx *cli.Context, | ||
| args traceImportLocalArgs, | ||
| source string, | ||
| ) error { | ||
| //nolint: gosec | ||
| traceFile, err := os.Open(source) | ||
| if err != nil { | ||
| if os.IsNotExist(err) { | ||
| printf(ctx.App.Writer, "No traces found") | ||
| return nil | ||
| } | ||
| return errors.Wrap(err, "failed to open trace file") | ||
| } | ||
| traceReader := protoutils.NewDelimitedProtoReader[tracepb.ResourceSpans](traceFile) | ||
| //nolint: errcheck | ||
| defer traceReader.Close() | ||
| endpoint := args.Endpoint | ||
| if endpoint == "" { | ||
| endpoint = "localhost:4317" | ||
| } | ||
| otlpClient := otlptracegrpc.NewClient( | ||
| otlptracegrpc.WithEndpoint(endpoint), | ||
| otlptracegrpc.WithInsecure(), | ||
| ) | ||
| if err := otlpClient.Start(ctx.Context); err != nil { | ||
| return err | ||
| } | ||
| //nolint: errcheck | ||
| defer otlpClient.Stop(ctx.Context) | ||
| var msg tracepb.ResourceSpans | ||
| msgSuccess := 0 | ||
| msgTotal := 0 | ||
| printf(ctx.App.Writer, "Importing spans to %v...", endpoint) | ||
| for span := range traceReader.AllWithMemory(&msg) { | ||
| msgTotal++ | ||
| err := otlpClient.UploadTraces(ctx.Context, []*tracepb.ResourceSpans{span}) | ||
| if err != nil { | ||
| printf(ctx.App.Writer, "Error uploading trace: %v", err) | ||
| } else { | ||
| msgSuccess++ | ||
| } | ||
| } | ||
| printf(ctx.App.Writer, "Imported %d/%d messages", msgSuccess, msgTotal) | ||
| return nil | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.