README
¶
Project Argus
Project Argus is an integrated observability and AI analysis platform.
Getting Started
Installation
go install github.com/RandomCodeSpace/argus@latest
Running
Simply run the binary:
argus
By default, Argus will use an embedded SQLite database (argus.db) in the current directory. No configuration is required.
Configuration (Optional)
You can configure the database using environment variables or a .env file:
- MySQL:
DB_DRIVER=mysql DB_DSN=root:password@tcp(localhost:3306)/argus?charset=utf8mb4&parseTime=True&loc=Local - SQLite (Default):
DB_DRIVER=sqlite DB_DSN=argus.db
Features
- Traces: OTLP Trace ingestion and visualization.
- Logs: Structured logging with AI-powered insights.
- Dashboard: Real-time metrics and traffic analysis.
OTLP Integration
Argus acts as an OTLP Receiver (gRPC) on port 4317 by default.
As an OTel Collector Target
You can configure any OpenTelemetry Collector to export data to Argus.
exporters:
otlp/argus:
endpoint: "localhost:4317"
tls:
insecure: true
service:
pipelines:
traces:
exporters: [otlp/argus]
logs:
exporters: [otlp/argus]
See docs/otel-collector-example.yaml for a full configuration example.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
archive
Package archive implements hot/cold storage tiering for Argus.
|
Package archive implements hot/cold storage tiering for Argus. |
|
graph
Package graph provides an in-memory service dependency graph rebuilt periodically from recent span data.
|
Package graph provides an in-memory service dependency graph rebuilt periodically from recent span data. |
|
mcp
Package mcp implements the HTTP Streamable MCP (Model Context Protocol) server over JSON-RPC 2.0 with SSE streaming, allowing any AI agent (Claude, GPT, Cursor, etc.) to discover and call Argus tools natively.
|
Package mcp implements the HTTP Streamable MCP (Model Context Protocol) server over JSON-RPC 2.0 with SSE streaming, allowing any AI agent (Claude, GPT, Cursor, etc.) to discover and call Argus tools natively. |
|
tsdb
Package tsdb provides an in-memory ring buffer for per-metric sliding windows with pre-computed aggregates.
|
Package tsdb provides an in-memory ring buffer for per-metric sliding windows with pre-computed aggregates. |
|
vectordb
Package vectordb provides an embedded TF-IDF / cosine-similarity vector index for semantic log search.
|
Package vectordb provides an embedded TF-IDF / cosine-similarity vector index for semantic log search. |
|
test
|
|
|
authservice
command
|
|
|
inventoryservice
command
|
|
|
notificationservice
command
|
|
|
orderservice
command
|
|
|
paymentservice
command
|
|
|
shippingservice
command
|
|
|
userservice
command
|
|
Click to show internal directories.
Click to hide internal directories.