Docs: Provide better visibility of features that use ClickHouse
Problem
Several features use ClickHouse, however documentation for these features is spread across the docs site, so it's not immediately clear what the list of features are.
Features Using ClickHouse
Click to expand
Analytics & Metrics:
- GitLab Duo and SDLC Trends - Tracks Code Suggestions usage, acceptance rates, and GitLab Duo Chat metrics
- Contribution Analytics with ClickHouse - Enhanced contribution analytics for groups
CI/CD Analytics: 3. Runner Fleet Dashboard - Provides:
- Wait time to pick a job metrics
- Runner usage statistics (previous month)
- Compute minutes tracking
- Job queue time analysis
- CI Analytics Features - Additional CI analytics capabilities
Configuration & Integration: 5. ClickHouse Integration Setup - Main integration documentation covering:
- Supported ClickHouse versions (23.x, 24.x, 25.x)
- ClickHouse Cloud integration
- Self-managed ClickHouse setup
- Replicated database engine support (experimental in 18.5)
- Enable ClickHouse for Analytics - Admin configuration for enabling analytics features
- ClickHouse for GitLab Dedicated - ClickHouse availability for GitLab Dedicated customers
Developer Resources: 8. ClickHouse Development Guide - For developers building features with ClickHouse (Not applicable for customer docs) 9. ClickHouse Reviewer Guidelines - Code review guidelines for ClickHouse changes (Not applicable for customer docs) 10. GraphQL API for AI Metrics - Retrieve GitLab Duo and SDLC trend metrics via API
Proposal
- Add a feature summary table to https://docs.gitlab.com/integration/clickhouse that lists all the features that use ClickHouse.
- Improve IA: Reduce circular links, reduce 'clicks-to-success'.
| Feature | Description |
|---|---|
| GitLab Duo and SDLC Trends | Dashboard that tracks Code Suggestions usage metrics including shown count, accepted count, acceptance rates, and GitLab Duo Chat usage. Provides insights into AI-assisted development adoption across your organization. |
| Contribution Analytics | Enhanced contribution analytics for groups that provides detailed insights into team member contributions and activity patterns. |
| Runner Fleet Dashboard | Comprehensive dashboard for assessing the health of instance runners, including wait time to pick a job metrics, runner usage statistics, compute minutes tracking, and job queue time analysis. |
| CI Analytics | Additional CI analytics capabilities that provide deeper insights into CI/CD pipeline performance and runner efficiency. |
| Export Compute Minutes | Export detailed compute minutes usage data by instance runners for cost analysis and resource planning. |
| GraphQL API for AI Metrics | GraphQL endpoint (AiMetrics) that provides programmatic access to retrieve GitLab Duo and SDLC trend metrics for integration with external tools and custom dashboards. |
Edited by Fiona Neill