add traceectl to tracee #4396

ShohamBit · 2024-11-25T10:54:13Z

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

Added traceectl CLI tool.
Implemented commands for the new CLI:
- version
- metrics
- stream
- event

bb46978 add policy support to stream, and documented
b8db1e4 fix lint issues
914e3cf fix format issues
b5621e3 move traceectl docs to separte section, refactor traceectl docs
b91674e add makefile for traceectl
03e5820 remove invalid test for output
4bc7c92 fix server flag test and error handeling
876bc9c Add test pkg and mock server for traceectl
5729337 update go.mod and go.sum
5d70de4 add config to traceectl
2b81488 change event command to support new format of tracectl
8a941c0 add support for metrics command
c58a785 added printer pkg
e7aae97 added flags pkg
e55c120 fix version runtime issue
d6e9416 refactor stream command
611b224 refactor traceectl code to be more mantainable
161ebc6 refactor the client pkg
4862d94 refactor metrics command
9e6076b Add traceectl to tracee

611b224 refactor traceectl code to be more mantainable

refactor traceectl flags
refactor version commnad
refactor root to align to the new code
remove formater and replace with printer
create diffrent file for geting and running commands

Testing

Please go over the docs and test it

Related Issues

Add New CLI: traceectl #4419
Resolves Add traceectl to tracee #4387 (accidentally closed)
Note: This PR was accidentally closed previously and is now being resubmitted.

yanivagman

Please see comments below.
In addition, please add documentation to traceectl.
As part of the documentation, please also refer to the way the user should start tracee "daemon" (e.g. using NONE output and setting the grpc server address)

cmd/traceectl/cmd/event.go

cmd/traceectl/pkg/client/client.go

cmd/traceectl/pkg/cmd/formatter/JSONFormatter.go

cmd/traceectl/pkg/cmd/formatter/TableFormatter.go

cmd/traceectl/pkg/cmd/formatter/formatter.go

cmd/traceectl/pkg/cmd/printer/printer.go

cmd/traceectl/cmd/event.go

ShohamBit · 2024-11-28T14:47:24Z

What do you think about adding a flag to traceectl version command called short for a short version instead of all the info we get, or the exact offset making the long flag and the short version the default?

geyslan · 2024-11-28T22:06:31Z

What do you think about adding a flag to traceectl version command called short for a short version instead of all the info we get, or the exact offset making the long flag and the short version the default?

I believe we wouldn't bother with it. When it's from a released version, it's already short.

cmd/traceectl/cmd/stream.go

geyslan · 2024-12-03T21:07:56Z

Gonna through this tomorrow. 👍🏻

cmd/traceectl/pkg/mock/server.go

ShohamBit

Looks great to me, maybe go over the documentation and review it once more

geyslan · 2024-12-04T11:35:29Z

@ShohamBit @yanivagman what do you think about splitting this? Since we already have a working stream command, we could open a PR with just the base root and stream commands to establish a foundation for the upcoming new commands (each added in separate PRs). This approach would make both implementation and review more manageable.

ShohamBit · 2024-12-04T13:13:26Z

Hey @geyslan, great thinking, let's discuss this over with @yanivagman

yanivagman

First pass...

cmd/traceectl/cmd/event.go

docs/docs/traceectl/commands/version.md

docs/docs/traceectl/flags/format.md

docs/docs/traceectl/flags/server.md

docs/docs/traceectl/index.md

refactor traceectl flags refactor version commnad refactor root to align to the new code remove formater and replace with printer create diffrent file for geting and running commands

github-actions bot added area/testing area/UX labels Nov 25, 2024

github-actions bot assigned ShohamBit Nov 25, 2024

yanivagman requested changes Nov 27, 2024

View reviewed changes

ShohamBit force-pushed the traceectl branch from 0737107 to 963f304 Compare November 28, 2024 08:48