Dashboard Overview
Dashboard Overview
The gitlab-summary dashboard provides a comprehensive, real-time view of your GitLab CI/CD pipelines through an intuitive web interface.
Starting the Dashboard
Basic Usage
gitlab-summary serve --group my-org --open
This command:
- Starts the SSE server on
http://localhost:5100 - Opens your default browser automatically
- Begins streaming pipeline data in real-time
Without Auto-open
gitlab-summary serve --group my-org
Then manually navigate to http://localhost:5100
Dashboard Pages
The dashboard consists of four main pages accessible from the left navigation rail:
1. Overview (Home)
Purpose: High-level view of all pipeline activity
πΈ Screenshot placeholder: dashboard-overview.png
Description: Dashboard overview page showing key metrics cards (total pipelines, success rate, in progress, duration), timeline chart, top contributors, and recent failures list
Key Metrics:
- Total Pipelines: Count of all pipelines in the selected time range
- Success Rate: Percentage of successful pipelines (color-coded)
- In Progress: Currently running pipelines
- Average Duration: Mean execution time across all pipelines
Timeline Chart:
- Visual representation of pipeline status over time
- Green bars = successful pipelines
- Red bars = failed pipelines
- Blue bars = running pipelines
- Hover to see exact counts
πΈ Screenshot placeholder: dashboard-timeline-chart.png
Description: Close-up of timeline chart showing green (success), red (failed), and blue (running) bars representing pipeline status over time with hover tooltip
Top Contributors:
- Most active users ranked by pipeline count
- Shows avatar, name, and success rate
- Click any user to see detailed statistics
Recent Failures:
- Latest failed pipelines across all projects
- Shows project, branch, commit message
- Quick access to logs and AI analysis
2. Projects
Purpose: Project-level pipeline summaries
πΈ Screenshot placeholder: dashboard-projects-list.png
Description: Projects page displaying list of projects with columns for name, total pipelines, success/failed/running counts, success rate percentage, and average duration
Information Displayed:
- Project name with fork indicator (if applicable)
- Total pipeline count
- Success/failed/running breakdown
- Success rate percentage
- Average duration
- AI analysis indicators (badge showing analyzed job count)
Interactions:
- Click project name to expand recent pipelines
- Click any pipeline to view full details
- Sort by various metrics
3. Contributors
Purpose: Team member statistics and activity
πΈ Screenshot placeholder: dashboard-contributors.png
Description: Contributors page showing list of users with avatars, names, total pipeline counts, success rates, and activity timelines
Information Displayed:
- User avatar and display name
- Total pipelines triggered
- Success rate
- Average pipeline duration
- Recent activity timeline
Use Cases:
- Identify team members needing support (low success rates)
- Recognize high-performing contributors
- Track individual CI/CD impact
4. AI History
Purpose: View all cached AI analyses
πΈ Screenshot placeholder: dashboard-ai-history.png
Description: AI History page showing paginated list of expandable cards with cached AI analyses, project names, job details, and conversation histories
Features:
- Paginated list (20 per page)
- Expandable cards showing full analysis
- Project name and job details
- Conversation history (initial analysis + follow-ups)
- Quick actions: View pipeline details, View job logs
Navigation:
- Page through results
- Click any analysis to expand
- Access from any project/pipeline context
Real-time Updates
Server-Sent Events (SSE)
The dashboard uses SSE for live updates without manual refresh:
Update Frequency: Default 30 seconds (configurable with --interval)
What Updates:
- Pipeline status changes (success/failure/running)
- New pipelines
- Metric calculations
- Timeline chart
Connection Status:
- Visual indicator shows connection state
- Auto-reconnect on connection loss
- “Last updated” timestamp
Theme & Preferences
Dark/Light Mode
Toggle: Click sun/moon icon in top bar
Persistence: Saved in browser localStorage
Auto-detection: Respects system preference on first visit
Navigation Rail
States:
- Expanded: Shows icons + labels
- Collapsed: Icons only
Toggle: Click hamburger menu or arrow icon
Persistence: State saved across browser sessions
Top Bar Controls
Group Selector
Input Field: Type group ID or path, press Enter
Tree Browser: Click tree icon to navigate hierarchy
- Current group (highlighted)
- Parent group (if exists)
- Sibling groups
- Child groups (subgroups)
Dynamic Updates: Changing group refreshes data immediately
Time Period Selector
Dropdown Options:
- 1 day (24 hours)
- 3 days
- 7 days (default)
- 14 days
- 30 days
Dynamic Updates: Changing period refreshes data immediately
Settings
Click gear icon to access:
- AI system prompt customization
- Future settings options
Responsive Design
Desktop (>1200px)
- Full sidebar navigation
- Multi-column layouts
- All features visible
Tablet (768px - 1200px)
- Collapsible sidebar
- Hybrid layouts
- Touch-friendly interactions
Mobile (<768px)
- Stacked layouts
- Bottom navigation
- Simplified views
- Touch-optimized buttons
Browser Support
Recommended:
- Chrome 90+
- Firefox 88+
- Safari 14+
- Edge 90+
Required Features:
- ES2020 support
- Server-Sent Events (SSE)
- LocalStorage
- Flexbox/Grid
Performance
Optimization Features
Lazy Loading:
- Components load on demand
- Reduces initial load time
Virtual Scrolling:
- Large lists render only visible items
- Smooth performance with 1000+ pipelines
Efficient Updates:
- Only changed data re-renders
- Minimal DOM manipulation
Performance Tips
Reduce Time Range:
gitlab-summary serve --group my-org --since 1d
Increase Update Interval:
gitlab-summary serve --group my-org --interval 60
Filter to Specific Projects: Use dashboard filters to focus on relevant projects
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
g then o | Go to Overview page |
g then p | Go to Projects page |
g then c | Go to Contributors page |
g then h | Go to AI History page |
Esc | Close open dialogs |
? | Show keyboard shortcuts help |
Next Steps
- AI-Powered Analysis β Use Copilot for failure analysis
- Group Navigation β Navigate complex hierarchies
- API Reference β Integrate with other tools
- Troubleshooting β Common issues and solutions
See Also
- Getting Started β Quick start guide
- CLI Reference β Command-line options
- Dashboard AI Analysis β AI features deep dive