Skip to content

Commit

Permalink
README と USE を整理する
Browse files Browse the repository at this point in the history
  • Loading branch information
voluntas committed Jun 16, 2024
1 parent 8c7b9b5 commit c1b8923
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ Please read <https://github.com/shiguredo/oss/blob/master/README.en.md> before u
Kohaku はクライアントと Sora の統計情報を Sora から統計ウェブフックで受け取り、
ClickHouse に格納するゲートウェイです。

### 注意

- Kohaku 2023.1.1 は 2023.2.x でも利用できます
- 開発版は統計ウェブフック機能が追加された Sora 2024.1.0 から利用できます

## 特徴

- Sora の統計ウェブフック機能で、統計情報を受け取り [ClickHouse](https://clickhouse.com/) に格納します
Expand Down
15 changes: 7 additions & 8 deletions doc/USE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,26 @@
## ビルド

```console
$ make
make
```

### バージョン表示

```console
$ bin/kohaku -V
bin/kohaku -V
```

## 設定ファイル

config_example.ini をコピーして、接続先の DB の URL(postgres_uri) などを設定してください。

```console
$ cp config_example.ini config.ini
cp config_example.ini config.ini
```

## 開発環境での利用

HTTPS 設定無効にすることで HTTP/2 over TCP (h2c) での通信が利用できます。
この場合は証明書の設定は不要です。
HTTPS 設定無効にすることができ、この場合は証明書の設定は不要です。

### Kohaku 側の設定

Expand All @@ -36,17 +35,17 @@ https = false
HTTP にすることで HTTP/2 over TCP (h2c) を利用して接続しに行きます。

```ini
stats_collector_url = http://192.0.2.10:5890/collector
stats_webhook_url = http://192.0.2.10:5890/stats
```

## 起動

上記で用意した `config.ini` を指定して kohaku サーバを立ち上げます。

```console
$ ./bin/kohaku -C config.ini
./bin/kohaku -C config.ini
```

## TimescaleDB のスキーマ
## ClickHouse のスキーマ

db ディレクトリ以下に `schema.sql` がありますのでこちらをご利用ください。

0 comments on commit c1b8923

Please sign in to comment.