ログとストレージ

セットアップ

ログを読む

Settings > Logs(設定 > ログ)を開きます。オーナーと管理者に表示されます。
Level(レベル)を選びます: Every line(すべての行)、Warnings and errors(警告とエラー)、Errors only(エラーのみ)。
Text(テキスト)に入力すると、その語を含む行だけが残ります。大文字と小文字は区別されません。
From(開始日)と To(終了日)で日付を絞り込みます。To の日も含まれます。Apply(適用)を選択します。
Newer(新しい)と Older(古い)でページを送ります。1 ページ 100 行で、新しい順です。条件に合う行だけが表示されます。

Settings > Logs で Download(ダウンロード)を選択します。最新の行が、最大 2 MB のテキストファイルで手に入ります。
サポートを求める場所に添付します。サポートを受けるを参照してください。

キー、トークン、パスワードは、あらかじめ [hidden] に置き換えられています。それでも、投稿する前にファイルに一度目を通してください。タイトル名、フォルダー名、サーバーのアドレスは見えるままです。

Settings > This app > Storage(設定 > このアプリ > ストレージ)に、HolyArrs から見た各パスと、そのディスクの空き容量が一覧表示されます。Docker では、これらはコンテナ内のパスです。

パス	内容
設定フォルダー	HolyArrs のすべてのデータ
`holyarrs.db`	メインのデータベース
`holyarrs-events.db`	履歴のデータベース
バックアップ、アートワーク、ログの各フォルダー	設定フォルダーの中
ライブラリフォルダー、ダウンローダーの保存フォルダー	メディアとダウンロード

「free space unknown」(空き容量不明)は、システムから値が返されなかったという意味です。

ログファイルは、設定フォルダー内の logs/holyarrs.log です。5 MB になると logs/holyarrs.log.1 に移されるので、ログは 10 MB 前後に収まります。docker logs holyarrs でも同じ出力が表示されます。

症状: Logs ページが見当たらない。 原因: オーナーと管理者にしか表示されません。 対処: どちらかに頼んでください。

症状: パスがおかしく見える。 原因: Docker では、Storage にはコンテナ内のパスが表示されます。 対処: ボリュームの割り当てと見比べます。フォルダーを参照してください。

レベルの判定方法

レベルは、行に含まれる語から判定されます。“failed”、“crashed”、“error” はエラーになります。“could not”、“refused”、“timed out” は警告になります。

隠される内容

すべての行は書き込み時に隠され、読み取り時とダウンロード時にもう一度隠されます。

保存されているすべてのキー、トークン、パスワード、Webhook のリンク。リンク用にエスケープされた形式と base64 形式も含みます。
古い値。シークレットが変更または削除されると、古い値を破棄する前に、両方のログファイルがその値を隠した状態で書き直されます。
リンク内の名前とパスワード: http://user:pass@host は http://[hidden]@host になります。
apikey=、token=、passkey=、password= などのリンクのパラメーター。
シークレットを示す名前との組: API キー、トークン、パスワード、シークレット、Cookie、authorization、セットアップコード。引用符で囲まれた値は、閉じ引用符まで隠されます。
Bearer トークンと Basic トークン、HolyArrs の API キー(hak_...)、初回セットアップのセットアップコード、トークンらしい長い文字列。

値の中の改行と端末のカラーコードはエスケープして表示されるので、値が新しい行を装うことはできません。保存されている値が 4 ～ 5 文字の場合は、単語全体として現れたときだけ隠されます。admin や test のような一般的な語である場合は隠されません。

API

ルート	対象	内容
`GET /api/v1/app/storage`	Change settings(設定の変更)	パスと空き容量
`GET /api/v1/logs?level=&q=&from=&to=&offset=&limit=`	オーナー、管理者	行と合計数
`GET /api/v1/logs/download`	オーナー、管理者	最新の 2 MB をプレーンテキストで

API キーの場合、3 つとも admin スコープが必要です。