Add Traceectl to Tracee #4396
Open
Add Traceectl to Tracee #4396
+1,229
−0
Conversation
This file contains 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
yanivagman
requested changes
Nov 27, 2024
| @@ -0,0 +1,150 @@ | |||
| package cmd | |||
|
|
|||
| //TODO: | |||
| Short: "Event management for tracee", | ||
| Long: `Event Management for tracee | ||
| Let you enable and disable events in tracee. | ||
| Get descriptions of events and run them. |
There was a problem hiding this comment.
Suggested change
| Get descriptions of events and run them. | |
| Get descriptions of events. |
Comment on lines
+39
to
+43
| listEventCmd.Flags().StringVarP(&eventFormatFlag, "format", "f", formatter.FormatTable, "Output format (json|table|template) ") | ||
| listEventCmd.Flags().StringVarP(&eventOutputFlag, "output", "o", "stdout", "Output destination ") | ||
|
|
||
| describeEventCmd.Flags().StringVarP(&eventFormatFlag, "format", "f", formatter.FormatTable, "Output format (json|table|template) ") | ||
| describeEventCmd.Flags().StringVarP(&eventOutputFlag, "output", "o", "stdout", "Output destination ") |
There was a problem hiding this comment.
Output can be made global instead of per command
|
|
||
| type ServerInfo struct { | ||
| ConnectionType string | ||
| ADDR string |
Comment on lines
+33
to
+49
| switch serverInfo.ConnectionType { | ||
| case PROTOCOL_UNIX: | ||
| address := fmt.Sprintf("unix://%s", serverInfo.ADDR) | ||
| conn, err = grpc.NewClient(address, opts...) | ||
|
|
||
| if err != nil { | ||
| log.Fatalf("failed to connect to server: %v", err) | ||
| return nil, err | ||
| } | ||
| case PROTOCOL_TCP: | ||
| address := fmt.Sprintf(serverInfo.ADDR) | ||
| conn, err = grpc.NewClient(address, opts...) | ||
|
|
||
| if err != nil { | ||
| log.Fatalf("failed to connect to server: %v", err) | ||
| return nil, err | ||
| } |
There was a problem hiding this comment.
switch case should only initialize address, common code can be below
| ) | ||
|
|
||
| func (f *Formatter) PrintStreamJSON(event *pb.Event) { | ||
| f.CMD.Printf("%s", event.String()) |
There was a problem hiding this comment.
Since these functions are tightly coupled to the stream and events commands, I suggest to put them in their packages, and leave the formatter out at this stage
There was a problem hiding this comment.
The methods in this file are coupled to the command - let's move them to the respective commands instead. In the future, we can think about extending traceectl with a formatter package
Comment on lines
+47
to
+68
| func initOutput(cmd *cobra.Command, output string) error { | ||
| if (output != "") && (output != "stdout") { | ||
| if output == "" || strings.TrimSpace(output) == "" { | ||
| return fmt.Errorf("output file path is empty or invalid") | ||
| } | ||
| dir := filepath.Dir(output) | ||
| if err := os.MkdirAll(dir, 0755); err != nil { | ||
| return fmt.Errorf("failed to create directories for output file: %v", err) | ||
| } | ||
| file, err := os.Create(output) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to open output file: %v", err) | ||
| } | ||
|
|
||
| cmd.SetOut(file) | ||
| cmd.SetErr(file) | ||
| cmd.PersistentPostRun = func(cmd *cobra.Command, args []string) { | ||
| file.Close() | ||
| } | ||
| } | ||
| return nil | ||
| } |
There was a problem hiding this comment.
This function doesn't seem to be part of the formatter package, considering it handles output
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR introduces
traceectl, a new CLI tool for interacting with Tracee. It implements basic commands for communication with Tracee via gRPC.Key Changes
traceectlCLI tool.versionmetricsstreameventTesting
Compile and run Tracee with gRPC:
Run
traceectl:This displays the help command.
Current Limitations
metrics: JSON output is not yet supported.stream: Only the basestreamcommand is supported. Streams events directly from Tracee.Related Issues
Note: This PR was accidentally closed previously and is now being resubmitted.