CHANGES.md

変更履歴

• CHANGE
  • 後方互換性のない変更
• UPDATE
  • 後方互換性がある変更
• ADD
  • 後方互換性がある追加
• FIX
  • バグ修正

develop

• [CHANGE] ログライブラリの変更
  • prometheus/exporter-toolkit の依存ログライブラリが go-kit/log から Go 言語標準ライブラリの log/slog に変更されたため、Sora expoter 内で使用しているロガーも log/slog に切り替える
  • 同様にテストコードで使用していた NewNopLogger は代替として slog.New(slog.NewTextHandler(io.Discard, nil)) を使用する形に変更する
  • @tnamao
• [UPDATE] 依存パッケージを更新する
  • prometheus/client_golang 1.19.1 => 1.20.4
  • prometheus/common 0.54.0 => 0.59.1
  • prometheus/exporter-toolkit 0.11.0 => 0.13.0
  • prometheus/exporter-toolkit のログライブラリ切り替えにより go-kit/log への依存はなくなりました
  • @tnamao
• [UPDATE] Go を 1.23 に上げる
  • @tnamao

misc

• [UPDATE] Github Actions のイメージを更新する
  • actions/setup-go v4 => v5
  • dominikh/staticcheck-action v1.3.0 => v1.3.1
  • @tnamao
• [UPDATE] CI で実行する staticcheck のバージョンを更新する
  • 2023.1.6 => 2024.1.1
  • @tnamao
• [ADD] CI のリリースに canary リリースの対応を追加する
  • @tnamao

2024.6.0

リリース日: 2024-06-20

• [ADD] sora_cluster_node のメトリクスに node_type を追加する
  • regular または temporary のいずれかが入ります
  • @tnamao
• [UPDATE] prometheus/common の version.NewCollector が prometheus/client_golang に移動したことに伴う参照関係の修正
  • @tnamao
• [UPDATE] 依存パッケージを更新する
  • alecthomas/kingpin 2.3.2 => 2.4.0
  • prometheus/client_golang 1.16.0 => 1.19.1
  • prometheus/common 0.44.0 => 0.54.0
  • prometheus/exporter-toolkit 0.10.0 => 0.11.0
  • @tnamao

2024.5.0

リリース日: 2024-06-05

• [ADD] Sora の Stats Webhook の統計情報に対応する
  • sora_stats_webhook_total メトリクスを追加し、ラベルに successful failed を設ける
  • @tnamao
• [UPDATE] CI の actions/setup-go を v5 に上げる
  • @tnamao

2024.4.0

• [CHANGE] クラスターリレーのメトリクス名を変更する
  • Prometheus メトリクスの命名規則に沿った名前に変更する
  • 送受信バイト数
    • sora_cluster_relay_received_bytes を sora_cluster_relay_recived_bytes_total に変更する
    • sora_cluster_relay_sent_bytes を sora_cluster_relay_sent_bytes_total に変更する
  • 送受信パケット数
    • sora_cluster_relay_received_packets を sora_cluster_relay_recived_packets_total に変更する
    • sora_cluster_relay_sent_packets を sora_cluster_relay_sent_packets_total に変更する
  • @tnamao

2024.3.0

• [UPDATE] Go を 1.22 に上げる
  • @tnamao
• [ADD] sora_client の obs_studio_whep に対応する
  • @tnamao
• [ADD] Sora のクラスターリレー機能のメトリクスを追加する
  • GetStatsReport API の cluster_relay 以下の統計情報を、起動オプションの --sora.cluster-metrics を有効にした時のみ収集する
  • 次のメトリクスを送受信しているノード単位で返す
  • 送受信バイト数
    • sora_cluster_relay_received_bytes
    • sora_cluster_relay_sent_bytes
  • 送受信パケット数
    • sora_cluster_relay_received_packets
    • sora_cluster_relay_sent_packets
  • @tnamao

2024.2.0

• [ADD] sora_license_expired_at_timestamp_seconds メトリクスを追加する
  • Sora のライセンス期限を epoch 秒に変換したものを返す
  • 仮にライセンスの期限が 2024 年 1 月の場合は、2024-01-31T23:59:59Z の epoch 秒になる
  • @tnamao
• [ADD] sora_time_seconds メトリクスを追加する
  • これは Node exporter の node_time_seconds と同じもので、exporter が起動しているサーバーのシステム時間を epoch 秒で返す
  • sora_license_expired_at_timestamp_seconds と組み合わせてライセンスの期限を監視することを想定している
  • @tnamao

2024.1.0

• [FIX] Sora 2023.2.0 で ListClusterNodes API の include_all_known_nodes のデフォルト値が変更で panic が起こす問題に対応する
  • Sora 2023.2.0 以降で Sora Exporter 2023.5.0 以前のバージョンを使用し、クラスターメトリクスが有効になっている場合に発生する
  • @tnamao
• [CHANGE] Sora の ListClusterNodes API を呼び出す際に、API リクエストの include_all_known_nodes を true にし切断中のノードも含め、接続状態を gauge で返すようにする
  • 破壊的変更 になるため、バージョンアップの際に注意してください
  • gauge の値は 1 が接続、0 が切断を表し ListClusterNodes API のレスポンスに含まれる connected の値により返す値を切り替えている
  • @tnamao

2023.5.0

• [UPDATE] CI の staticcheck のバージョンを 2023.1.6 に上げる
  • @tnamao
• [ADD] sora_client の sora_c_sdk に対応する
  • @tnamao

2023.4.0

• [ADD] sora_client の sora_python_sdk に対応する
  • @tnamao
• [UPDATE] Go を 1.21 に上げる
  • @tnamao

2023.3.0

• [ADD] sora_client の obs_studio_whip に対応する
  • @voluntas
• [CHANGE] 依存パッケージを更新する
  • prometheus/client-golang 1.14.0 => 1.16.0
  • prometheus/common 0.41.0 => 0.44.0
  • prometheus/exporter-toolkit 0.9.1 => 0.10.0
  • @tnamao

2023.2.0

• [CHANGE] kingpin の更新に伴うパッケージ名の変更
  • kingpin のバージョンは v2.2.6 から v2.3.2 に更新
  • gopkg.in/alecthomas/kingpin.v2 から github.com/alecthomas/kingpin/v2 に変更
  • kingpin に依存している関連パッケージの更新
  • @tnamao
• [CHANGE] Sora exporter がスクレイピングする Sora API のオプション名を変更する
  • コマンドライン引数の --sora.get-stats-report-url を --sora.api-url に変更する
  • 破壊的変更になるため、バージョンアップの際に注意してください
  • @tnamao
• [ADD] Sora のライセンス情報を返すメトリクスを追加する
  • sora_license_info ライセンスのテキスト情報
  • sora_license_max_connections ライセンスの同時接続数
  • sora_license_max_nodes クラスターライセンスに含まれる最大ノード数
    • GetLicense API のレスポンスに max_nodes が含まれる場合のみにメトリクスを返す
  • @tnamao

2023.1.0

• [CHANGE] Go 1.20 に上げる
  • @tnamao
• [CHANGE] staticcheck を 2023.1.1 に上げる
  • @tnamao
• [CHANGE] staticcheck-action を 1.3.0 に上げる
  • @tnamao

2022.6.1

• [CHANGE] リリース用 Github Actions のワークフローを修正
  • @tnamao

2022.6.0

• [ADD] クラスタ機能で使用している Raft 関連のメトリクスを追加
  • 以下の三つのメトリクスを追加する
    • [counter] sora_cluster_raft_commit_index ${INDEX}
    • [counter] sora_cluster_raft_term ${TERM}
    • [gauge] sora_cluster_raft_state { state = "${STATE_NAME}" } 1
  • これらは、以下の条件が満たされた時だけ、結果に含まれる
    • Sora のクラスタ機能が有効になっている
    • sora_exporter が --sora.cluster-metrics オプション付きで起動されている
  • @sile

2022.5.0

• [ADD] Sora の接続クライアントメトリクスに flutter_sdk を追加する
  • @tnamao
• [CHANGE] exporter-toolkit の変更に追従する
  • @tnamao

2022.4.0

• [ADD] Sora の Webhook メトリクスに対応する
  • @tnamao
• [CHANGE] Go 1.19 に上げる
  • @tnamao

2022.3.0

• [ADD] Sora の接続クライアントメトリクスに cpp_sdk と zakuro を追加する
  • @tnamao
• [ADD] Staticcheck の静的解析に対応する
  • @tnamao

2022.2.0

• [CHANGE] Sora に関するメトリクスの接頭辞を sora_exporter から sora に変更する
  • @tnamao
• [CHANGE] 接続数のメトリクス名を sora_connections_total に変更し、状態はラベルに変更する
  • @tnamao
• [CHANGE] セッション数のメトリクス名を sora_session_total に変更し、状態はラベルに変更する
  • @tnamao
• [CHANGE] 接続エラーのメトリクス名を sora_connection_error_total に変更し、エラー理由はラベルに変更する
  • @tnamao
• [CHANGE] 接続クライアントのメトリクス名を sora_client_type_total に変更し、クライアント種別と接続結果はラベルに変更する
  • @tnamao
• [CHANGE] total_received_invalid_turn_tcp_packet を received_invalid_turn_tcp_packet_total に変更する
  • @tnamao
• [ADD] Sora への接続可否を判定するための sora_up メトリクスを追加する
  • @tnamao
• [ADD] Sora が認識しているクラスターノードをメトリクスで返す sora_cluster_node を追加する
  • @tnamao
• [CHANGE] GitHub リリースのタイトルにタグ名を設定する
  • @tnamao
• [CHANGE] リリース時のアーカイブファイルに対象の OS 名を含める
  • @tnamao

2022.1.0

• [CHANGE] total_ongoing_connections を counter => gauge に変更する
  • @tnamao
• [ADD] Sora の標準統計情報の total_received_invalid_turn_tcp_packet total_session_created total_session_destroyed に対応する
  • @tnamao
• [ADD] アンドキュメントの Sora 接続クライアントの統計情報に対応する
  • @tnamao
• [ADD] アンドキュメントの Sora 接続エラーの統計情報に対応する
  • @tnamao
• [ADD] アンドキュメントの Erlang VM の統計情報に対応する
  • @tnamao
• [ADD] スクレイプ先 URL の SSL 検証を行わないオプションを追加する
  • @tnamao
• [ADD] /metrics を同時呼び出しされた時に Sora の GetStatReport の呼び出しは一度に呼び出さないように mutex で同時実行を抑制する
  • @tnamao
• [ADD] テストコードを追加する
  • @tnamao