Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ClickHouse/clickhub
Github analytics powered by the world's fastest real-time analytics database
https://github.com/ClickHouse/clickhub
Last synced: about 2 months ago
JSON representation
Github analytics powered by the world's fastest real-time analytics database
- Host: GitHub
- URL: https://github.com/ClickHouse/clickhub
- Owner: ClickHouse
- Created: 2023-03-31T13:25:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-10T16:59:29.000Z (8 months ago)
- Last Synced: 2024-06-12T07:14:26.956Z (3 months ago)
- Language: Python
- Size: 3.84 MB
- Stars: 13
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ClickHub
GitHub analytics with the world's fastest real-time analytics database.
## Capabilities
- Imports a github repo to ClickHouse (currently assumes tables are pre-created)
- Job queue for repositories to import consumed by workers. Scales linearly.
Note: repos are cloned locally. This can require significant disk space for a large number of repos.
## Pre-requisites
- python3.10+
- git - authenticated with ssh keys
- clickhouse-client
- ClickHouse instance with support for KeeperMap and `keeper_map_strict_mode`
## Installing
`pip install -r requirements.txt`
Pre-create tables in ClickHouse. Default database is `git`.
## Running
```bash
usage: clickhub.py [-h] [-c CONFIG] [-d] {schedule,start_worker,import,update_all_repos} ...
github importer
positional arguments:
{schedule,start_worker,import,update_all_repos}
schedule Schedule a repo for import (add queue to queue)
start_worker start a worker to consume from queue
import import a repo
update_all_repos schedule all current repos for update
options:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
config (default: config.yml)
-d, --debug debug (default: False)
```
### Import a repository
Imports a repository. Note this uses local machine.
```bash
python clickhub.py import --repo_name
```
Caution: ensure this isn't being imported by a worker on the current machine. This is useful for adding a repo only.
### Schedule a repo
Adds the repo to work queue.
```bash
python clickhub.py schedule --repo_name
```
### Start worker
Starts a worker consuming from queue
```bash
python clickhub.py start_worker
```
### Update all repos
Schedules a job for all current repositories. Determined by setting `repo_lookup_table`.
```bash
python clickhub.py update_all_repos
```
### Bulk schedule repos
Bulk schedules repos based on lines in file. Repos should be line delimited. 40,000 repos are provided in
[repos.txt](repos.txt).
```bash
python clickhub.py bulk_schedule --file repos.txt
```
## Config
See [config.yml](config.yml)
```yaml
# clickhouse details
host: ''
port: 8443
native_port: 9440
username: default
password: ''
secure: true
# location to clone repos
data_cache: '/opt/git_cache'
# queue details
max_queue_length: 10000
# period between worker polls
sleep_time: 10
# table on which we look up current repos
repo_lookup_table: 'git.commits'
```
## Table Schemas
```sql
CREATE TABLE git.commits
(
`hash` String,
`author` LowCardinality(String),
`time` DateTime,
`message` String,
`files_added` UInt32,
`files_deleted` UInt32,
`files_renamed` UInt32,
`files_modified` UInt32,
`lines_added` UInt32,
`lines_deleted` UInt32,
`hunks_added` UInt32,
`hunks_removed` UInt32,
`hunks_changed` UInt32,
`repo_name` LowCardinality(String),
`updated_at` DateTime MATERIALIZED now()
) ENGINE = ReplacingMergeTree
ORDER BY (repo_name, time, hash)
```
```sql
CREATE TABLE git.file_changes
(
`change_type` Enum8('Add' = 1, 'Delete' = 2, 'Modify' = 3, 'Rename' = 4, 'Copy' = 5, 'Type' = 6),
`path` LowCardinality(String),
`old_path` LowCardinality(String),
`file_extension` LowCardinality(String),
`lines_added` UInt32,
`lines_deleted` UInt32,
`hunks_added` UInt32,
`hunks_removed` UInt32,
`hunks_changed` UInt32,
`commit_hash` String,
`author` LowCardinality(String),
`time` DateTime,
`commit_message` String,
`commit_files_added` UInt32,
`commit_files_deleted` UInt32,
`commit_files_renamed` UInt32,
`commit_files_modified` UInt32,
`commit_lines_added` UInt32,
`commit_lines_deleted` UInt32,
`commit_hunks_added` UInt32,
`commit_hunks_removed` UInt32,
`commit_hunks_changed` UInt32,
`repo_name` LowCardinality(String),
`updated_at` DateTime MATERIALIZED now()
) ENGINE = ReplacingMergeTree
ORDER BY (repo_name, time, commit_hash, path)
SETTINGS index_granularity = 8192
```
```sql
CREATE TABLE git.line_changes
(
`sign` Int8,
`line_number_old` UInt32,
`line_number_new` UInt32,
`hunk_num` UInt32,
`hunk_start_line_number_old` UInt32,
`hunk_start_line_number_new` UInt32,
`hunk_lines_added` UInt32,
`hunk_lines_deleted` UInt32,
`hunk_context` LowCardinality(String),
`line` LowCardinality(String),
`indent` UInt8,
`line_type` Enum8('Empty' = 0, 'Comment' = 1, 'Punct' = 2, 'Code' = 3),
`prev_commit_hash` String,
`prev_author` LowCardinality(String),
`prev_time` DateTime,
`file_change_type` Enum8('Add' = 1, 'Delete' = 2, 'Modify' = 3, 'Rename' = 4, 'Copy' = 5, 'Type' = 6),
`path` LowCardinality(String),
`old_path` LowCardinality(String),
`file_extension` LowCardinality(String),
`file_lines_added` UInt32,
`file_lines_deleted` UInt32,
`file_hunks_added` UInt32,
`file_hunks_removed` UInt32,
`file_hunks_changed` UInt32,
`commit_hash` String,
`author` LowCardinality(String),
`time` DateTime,
`commit_message` String,
`commit_files_added` UInt32,
`commit_files_deleted` UInt32,
`commit_files_renamed` UInt32,
`commit_files_modified` UInt32,
`commit_lines_added` UInt32,
`commit_lines_deleted` UInt32,
`commit_hunks_added` UInt32,
`commit_hunks_removed` UInt32,
`commit_hunks_changed` UInt32,
`repo_name` LowCardinality(String),
`updated_at` DateTime MATERIALIZED now()
) ENGINE = ReplacingMergeTree
ORDER BY (repo_name, time, commit_hash, path, line_number_old, line_number_new)
```
```sql
CREATE TABLE git.work_queue
(
`repo_name` String,
`scheduled` DateTime,
`priority` Int32,
`worker_id` String,
`started_time` DateTime,
)
ENGINE = KeeperMap('git_queue')
PRIMARY KEY repo_name
```
```sql
clickhouse
-local --query "SELECT c1::String as hash, c2::String as author, c3::DateTime('utc') as time, c4::String as message, c5::UInt32 as files_added, c6::UInt32 as files_deleted, c7::UInt32 as files_renamed, c8::UInt32 as files_modified, c9::UInt32 as lines_added, c10::UInt32 as lines_deleted, c11::UInt32 as hunks_added, c12::UInt32 as hunks_removed, c13::UInt32 as hunks_changed, 'ClickHouse/ClickHouse'::String as repo_name FROM file('commits.tsv') FORMAT Native" | clickhouse-client --query "INSERT INTO git.commits FORMAT Native"
```
```sql
clickhouse
-local --query "SELECT c1::Enum8('Add' = 1, 'Delete' = 2, 'Modify' = 3, 'Rename' = 4, 'Copy' = 5, 'Type' = 6) as change_type, c2::String as path, c3::String as old_path, c4::String as file_extension, c5::UInt32 as lines_added, c6::UInt32 as lines_deleted, c7::UInt32 as hunks_added, c8::UInt32 as hunks_removed, c9::UInt32 as hunks_changed, c10::String as commit_hash, c11::String as author, c12::DateTime as time, c13::String as commit_message, c14::UInt32 as commit_files_added, c15::UInt32 as commit_files_deleted, c16::UInt32 as commit_files_renamed, c17::UInt32 as commit_files_modified, c18::UInt32 as commit_lines_added, c19::UInt32 as commit_lines_deleted, c20::UInt32 as commit_hunks_added, c21::UInt32 as commit_hunks_removed, c22::UInt32 as commit_hunks_changed, 'ClickHouse/ClickHouse'::String as repo_name FROM file('file_changes.tsv') FORMAT Native" | clickhouse-client --query "INSERT INTO git.file_changes FORMAT Native"
```
```sql
clickhouse
-local --query "SELECT c1::Int8 as sign, c2::UInt32 as line_number_old, c3::UInt32 as line_number_new, c4::UInt32 as hunk_num, c5::UInt32 as hunk_start_line_number_old, c6::UInt32 as hunk_start_line_number_new, c7::UInt32 as hunk_lines_added, c8::UInt32 as hunk_lines_deleted, c9::String as hunk_context, c10::String as line, c11::UInt8 as indent, c12::Enum8('Empty' = 0, 'Comment' = 1, 'Punct' = 2, 'Code' = 3) as line_type, c13::String as prev_commit_hash, c14::String as prev_author, c15::DateTime as prev_time, c16::Enum8('Add' = 1, 'Delete' = 2, 'Modify' = 3, 'Rename' = 4, 'Copy' = 5, 'Type' = 6) as file_change_type, c17::String as path, c18::String as old_path, c19::String as file_extension, c20::UInt32 as file_lines_added, c21::UInt32 as file_lines_deleted, c22::UInt32 as file_hunks_added, c23::UInt32 as file_hunks_removed, c24::UInt32 as file_hunks_changed, c25::String as commit_hash, c26::String as author, c27::DateTime as time, c28::String as commit_message, c29::UInt32 as commit_files_added, c30::UInt32 as commit_files_deleted, c31::UInt32 as commit_files_renamed, c32::UInt32 as commit_files_modified, c33::UInt32 as commit_lines_added, c34::UInt32 as commit_lines_deleted, c35::UInt32 as commit_hunks_added, c36::UInt32 as commit_hunks_removed, c37::UInt32 as commit_hunks_changed, 'ClickHouse/ClickHouse'::String as repo_name FROM file('line_changes.tsv') FORMAT Native" | clickhouse-client --query "INSERT INTO git.line_changes FORMAT Native"
```
```sql
CREATE TABLE default.github_stars
(
`repo_name` LowCardinality(String),
`stars` UInt64
) ENGINE = SummingMergeTree
ORDER BY repo_name
CREATE
MATERIALIZED VIEW github_stars_mv TO github_stars AS
SELECT repo_name,
count() AS stars
FROM github_events
WHERE event_type = 'WatchEvent'
GROUP BY repo_name
INSERT
INTO github_stars
SELECT repo_name, countIf(event_type = 'WatchEvent', 0) AS stars
FROM github_events
GROUP BY repo_name
```
### Useful commands