Temporal Beacon 🔦

A powerful discovery and visualization tool for Temporal workflows and activities in Kubernetes environments.

Features

• 🔍 Automatic Discovery: Scans Kubernetes services to find Temporal workflow registries
• 📊 Visual Interface: Beautiful Material-UI based visualization of workflows and activities
• 🔗 Dependency Tracking: Shows relationships between workflows and activities
• 🎯 Usage Analysis: Identifies where activities are used across workflows
• 🚀 Easy to Use: Single command to discover and visualize

Installation

npm install -g temporal-beacon

Usage

Run the beacon command from your terminal:

beacon

This will:

1. Start a kubectl proxy to access your Kubernetes cluster
2. Discover all Temporal workflow registries in your cluster
3. Generate workflow and activity data
4. Launch a web interface at http://localhost:7237

Requirements

• Node.js >= 18.0.0
• Access to a Kubernetes cluster with kubectl configured
• Temporal services running in your cluster with registry endpoints

Development

Building

npm run build

This builds both the library and the client interface.

Testing

# Run tests
npm test

# Run tests in watch mode
npm run test:watch

# Generate coverage report
npm run test:coverage

Development Mode

npm run dev

Architecture

Temporal Beacon consists of:

• Service Discovery: Scans Kubernetes namespaces for Temporal registry endpoints
• Registry Manager: Aggregates and processes workflow/activity data
• Web UI: React-based interface for visualization
• CLI: Command-line tool that orchestrates everything

Configuration

Temporal Beacon automatically ignores common system namespaces:

• kube-system
• kube-public
• ingress-nginx
• cert-manager
• And more...

Screenshots

Contributing

Contributions are welcome! Please read our Contributing Guide and Code of Conduct.

License

MIT - see LICENSE for details

Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions

Acknowledgments

Built with ❤️ for the Temporal community