Skip to content

observeco/dashboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Observe Dashboard

Web interface for visualizing observability metrics

Status: v0.1.0 (Alpha)


Overview

Observe Dashboard is a modern web application for visualizing and analyzing observability metrics from Observe Context.

Features

  • ✅ Real-time metric visualizations
  • ✅ Interactive charts and graphs
  • ✅ Custom dashboards
  • ✅ Alert management
  • ✅ Dark/Light theme
  • ✅ Responsive design
  • ✅ GraphQL integration
  • ✅ Export reports

Tech Stack

  • Framework: Next.js 14
  • UI Library: shadcn/ui + Radix UI
  • Charts: Recharts
  • State: Zustand
  • Styling: Tailwind CSS
  • TypeScript: Full type safety

Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/observeco/dashboard.git
cd dashboard

# Install dependencies
npm install

# Start development server
npm run dev

# Open http://localhost:3000

Build for Production

# Build
npm run build

# Start production server
npm start

Features Overview

Real-Time Monitoring

  • Live metric updates
  • Auto-refreshing charts
  • WebSocket connections
  • Performance indicators

Dashboard Management

  • Create custom dashboards
  • Drag-and-drop widgets
  • Save/load configurations
  • Share dashboards

Alerts

  • Configure alert rules
  • Notification channels (email, Slack, webhook)
  • Alert history
  • Acknowledge/resolve alerts

Project Structure

dashboard/
├── app/                    # Next.js app directory
│   ├── dashboard/         # Dashboard pages
│   ├── metrics/           # Metrics pages
│   ├── alerts/            # Alerts pages
│   └── layout.tsx         # Root layout
├── components/            # React components
│   ├── charts/           # Chart components
│   ├── ui/               # shadcn/ui components
│   └── dashboard/        # Dashboard widgets
├── lib/                   # Utilities
│   ├── api.ts           # API client
│   ├── graphql.ts       # GraphQL client
│   └── utils.ts         # Helper functions
└── public/               # Static assets

Environment Variables

Create .env.local:

NEXT_PUBLIC_API_URL=http://localhost:8080
NEXT_PUBLIC_GRAPHQL_URL=http://localhost:8080/graphql
NEXT_PUBLIC_WS_URL=ws://localhost:8080/ws

Development

# Run development server with hot reload
npm run dev

# Run linting
npm run lint

# Run tests
npm test

# Type check
npm run type-check

# Format code
npm run format

Deployment

Vercel (Recommended)

# Install Vercel CLI
npm i -g vercel

# Deploy
vercel

Docker

# Build image
docker build -t observe-dashboard .

# Run container
docker run -p 3000:3000 observe-dashboard

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if needed
  5. Open a Pull Request

License

MIT License - see LICENSE for details.


Support


ObservecO - See your systems clearly.

About

Web interface for visualizing observability metrics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors