aigne observe
The aigne observe command launches the AIGNE Observability server, a local web-based interface that helps you visualize and analyze your AIGNE Agent's operational data. This tool is essential for debugging, monitoring performance, and understanding the inner workings of your Agent during development.
How It Works#
When you run an AIGNE Agent, it can be configured to log detailed trace data to a local database. The aigne observe command starts a web server that reads from this database and presents the information in a user-friendly dashboard.
Usage#
To start the server, simply run the command from your terminal:
aigne observe [options]Upon startup, the CLI will display the path to the observability database and the URL where the server is running.
# Example output
Observability database path: /path/to/your/project/.aigne/observability.sqlite
AIGNE Observability server is running on: http://localhost:7890Options#
You can customize the server's host and port using the following options.
Option | Description | Default |
|---|---|---|
| Specifies the host for the observability server. Use |
|
| Defines the port number for the server. It respects the |
|
Examples#
Start the Server on the Default Port#
Running the command without any options is the most common use case.
aigne observeThis will start the observability server on http://localhost:7890.
Start the Server on a Different Port#
If the default port 7890 is already in use, you can specify an alternative.
aigne observe --port 8080The server will now be accessible at http://localhost:8080.
Expose the Server on Your Network#
To allow other devices on your local network to access the observability UI, set the host to 0.0.0.0.
aigne observe --host 0.0.0.0The server will be available at http://<your-local-ip-address>:7890. Be mindful of the security implications when exposing services on your network.
By using the observability server, you gain valuable insights into your Agent's execution flow. To learn how to configure your project, including setting up API keys for different models, proceed to the next section.
Next, learn about Configuration to set up your development environment.