Skip to content

Commit

Permalink
made changes to the docs of traceectl
Browse files Browse the repository at this point in the history
  • Loading branch information
ShohamBit committed Jan 8, 2025
1 parent 144cf90 commit 0618d49
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 26 deletions.
4 changes: 2 additions & 2 deletions docs/docs/traceectl/commands/event.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Event Command Usage

The `event` command in **TraceeCtl** is used for managing events within Tracee. It allows you to list, describe, enable, and disable various event types that Tracee can capture. Below is the usage guide for the `event` command and its subcommands.
The `event` command in **traceectl** is used for managing events within Tracee. It allows you to list, describe, enable, and disable various event types that Tracee can capture. Below is the usage guide for the `event` command and its subcommands.

## Usage

Expand Down Expand Up @@ -80,4 +80,4 @@ traceectl event [subcommand] [flags]

## Summary

The `event` command in TraceeCtl is a powerful tool for managing Tracee's event capabilities. Use the `list`, `describe`, `enable`, and `disable` subcommands to gain detailed insight and control over the events Tracee monitors.
The `event` command in traceectl is a powerful tool for managing Tracee's event capabilities. Use the `list`, `describe`, `enable`, and `disable` subcommands to gain detailed insight and control over the events Tracee monitors.
4 changes: 2 additions & 2 deletions docs/docs/traceectl/commands/metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Metrics Command Usage

The `metrics` command in **TraceeCtl** provides information about Tracee's performance and resource usage metrics. This command is helpful for monitoring how Tracee is functioning in real-time.
The `metrics` command in **traceectl** provides information about Tracee's performance and resource usage metrics. This command is helpful for monitoring how Tracee is functioning in real-time.

## Usage

Expand All @@ -20,4 +20,4 @@ traceectl metrics

## Summary

The `metrics` command in TraceeCtl allows users to obtain insights into Tracee's operational metrics, including event counts and resource usage. The command supports a table output format to suit different reporting needs.
The `metrics` command displays tracee's performance and resource usage metrics. Use this command to monitor Tracee's operational status.
4 changes: 2 additions & 2 deletions docs/docs/traceectl/commands/stream.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Stream Command Usage

The `stream` command in **TraceeCtl** allows users to stream events directly from Tracee in real time. This command provides flexible output formats for better integration and readability.
The `stream` command in **traceectl** allows users to stream events directly from Tracee in real time. This command provides flexible output formats for better integration and readability.

## Usage

Expand Down Expand Up @@ -32,4 +32,4 @@ traceectl stream [policies...] [flags]

## Summary

The `stream` command in TraceeCtl is a useful tool for monitoring Tracee events in real time, with options for JSON or table output. Use this command to keep track of activities and ensure comprehensive observability for your system.
The `stream` command provides a real-time feed of Tracee events, allowing you to monitor system activity as it happens.
2 changes: 1 addition & 1 deletion docs/docs/traceectl/commands/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ traceectl version

This command will output details such as:

- **Version Number**: The current version of TraceeCtl.
- **Version Number**: The current version of traceectl.
- **Commit Hash**: The Git commit hash associated with the current build (if applicable).

### Example Output
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/traceectl/flags/server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `server` Flag

The `--server` flag in **traceectl** is used to specify the connection type that TraceeCtl should use to communicate with the Tracee server. This connection type can be either **Unix socket** or **TCP**.
The `--server` flag in **traceectl** is used to specify the connection type that traceectl should use to communicate with the Tracee server. This connection type can be either **Unix socket** or **TCP**.

- **Unix Socket**: This type of connection is generally used for local inter-process communication. It provides a secure and efficient means to connect to Tracee when both client and server are on the same machine.

Expand All @@ -12,7 +12,7 @@ The `--server` flag in **traceectl** is used to specify the connection type that

In this example, `unix:/unix/socket/path.sock` is the Unix socket path where the Tracee server is listening. Using Unix sockets is beneficial for security and performance since it avoids the overhead associated with network communication.

- **TCP**: This type of connection allows TraceeCtl to communicate with the Tracee server over a network. It is useful when TraceeCtl and Tracee are running on different machines or when you need to connect to a remote Tracee instance.
- **TCP**: This type of connection allows traceectl to communicate with the Tracee server over a network. It is useful when traceectl and Tracee are running on different machines or when you need to connect to a remote Tracee instance.

Example:

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/traceectl/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TraceeCtl - Client Service for Tracee
# traceectl - Client Service for Tracee

**traceectl** is a command-line interface (CLI) tool designed as a client service for [Tracee](https://github.com/aquasecurity/tracee), Aqua Security's open-source runtime security solution. Tracee provides real-time, powerful observability for Linux environments by monitoring system calls, events, and more. TraceeCtl is built to simplify interactions with Tracee, making it easier for users to manage, monitor, and gather security insights.
**traceectl** is a command-line interface (CLI) tool designed as a client service for [Tracee](https://github.com/aquasecurity/tracee), Aqua Security's open-source runtime security solution. Tracee provides real-time, powerful observability for Linux environments by monitoring system calls, events, and more. traceectl is built to simplify interactions with Tracee, making it easier for users to manage, monitor, and gather security insights.

## Overview

Expand All @@ -12,4 +12,4 @@ traceectl acts as a controller for Tracee, allowing users to:

## Installation and Usage

To get started with TraceeCtl, go over the [Installation and Usage page](./usage.md)
To get started with traceectl, go over the [Installation and Usage page](./usage.md)
28 changes: 14 additions & 14 deletions docs/docs/traceectl/usage.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# TraceeCtl Installation and Usage Guide
# traceectl Installation and Usage Guide

## Installation

To use **TraceeCtl**, you first need to compile and install the tool. Follow these steps to get started:
To use **traceectl**, you first need to compile and install the tool. Follow these steps to get started:

### 1. **Clone the Repository**

Expand All @@ -15,15 +15,15 @@ To use **TraceeCtl**, you first need to compile and install the tool. Follow the

### 2. **Build and Install**

Compile and install TraceeCtl using the following commands:
Compile and install traceectl using the following commands:

``` bash
go build
```

## Configuring Tracee for TraceeCtl
## Configuring Tracee for traceectl

To use TraceeCtl effectively, you need to configure Tracee so that it can communicate with TraceeCtl over a Unix socket. This can be done by running Tracee with the correct gRPC settings:
To use traceectl effectively, you need to configure Tracee so that it can communicate with traceectl over a Unix socket. This can be done by running Tracee with the correct gRPC settings:

### 1. **Run Tracee with gRPC Unix Socket**

Expand All @@ -33,7 +33,7 @@ Use the following command to start Tracee with gRPC support over a Unix socket:
tracee --grpc-listen-addr unix:/var/run/tracee.sock
```

This command sets up Tracee to listen for incoming connections from TraceeCtl at the specified Unix socket path (`/var/run/tracee.sock`). Ensure that this socket path is accessible and not blocked by permissions or other constraints.
This command sets up Tracee to listen for incoming connections from traceectl at the specified Unix socket path (`/var/run/tracee.sock`). Ensure that this socket path is accessible and not blocked by permissions or other constraints.

### 2. **Output Flag Configuration**

Expand All @@ -46,16 +46,16 @@ tracee --output none
#### Why Use `--output none`?

- **Reduced Bandwidth Usage:** By suppressing output, you can minimize the data transferred over the Unix socket, which is especially helpful in environments with limited resources.
- **Lower Latency:** With no data formatting or transmission overhead, the interaction between TraceeCtl and Tracee becomes faster.
- **Lower Latency:** With no data formatting or transmission overhead, the interaction between traceectl and Tracee becomes faster.

Use this mode for performance testing, silent monitoring, or when integrating TraceeCtl with other systems that handle data processing separately.
Use this mode for performance testing, silent monitoring, or when integrating traceectl with other systems that handle data processing separately.

This command sets up Tracee to listen for incoming connections from TraceeCtl at the specified Unix socket path (`/var/run/tracee.sock`).
This command sets up Tracee to listen for incoming connections from traceectl at the specified Unix socket path (`/var/run/tracee.sock`).
Ensure that this socket path is accessible and not blocked by permissions or other constraints.

## Usage

Once TraceeCtl is installed and Tracee is running, you can use various commands to interact with Tracee. Below are the main commands provided by TraceeCtl:
Once traceectl is installed and Tracee is running, you can use various commands to interact with Tracee. Below are the main commands provided by traceectl:

- Stream Events: traceectl stream

Expand All @@ -65,7 +65,7 @@ Once TraceeCtl is installed and Tracee is running, you can use various commands

- Check Version: traceectl version

For more info about the TraceeCtl command please refer to the appoint command documentation
For more info about the traceectl command please refer to the appoint command documentation

## Flags

Expand All @@ -81,10 +81,10 @@ For more info about the TraceeCtl command please refer to the appoint command do
traceectl stream --output file:/path/to/output.txt
```

For more info about the TraceeCtl flags please refer to the appoint flag documentation
For more info about the traceectl flags please refer to the appoint flag documentation

## Summary

- **Install TraceeCtl** by cloning the repository, building, and installing it with `make`.
- **Install traceectl** by cloning the repository, building, and installing it with `make`.
- **Configure Tracee** by running it with the appropriate gRPC Unix socket settings.
- **Use TraceeCtl** to interact with Tracee via commands like `stream`, `event`, `metrics`, and `version`.
- **Use traceectl** to interact with Tracee via commands like `stream`, `event`, `metrics`, and `version`.

0 comments on commit 0618d49

Please sign in to comment.