Skip to main content

Module usage

Module usage 

Source
Expand description

利用状況の送信(modelith の ADR-0026)。アプリ・サーバ・受け口が同じ一覧を使う(ADR-0026 の 4)。

送る本文は kind で区別する 4 種類で、1 回の要求に 1 つ送る。どれも schemaVersion に USAGE_SCHEMA_VERSION を載せる。 値は、決まった語(列挙)・区分(境目を doc に書いた列挙)・上限つきの回数(Count)のどれかで、自由な文字列は受けない (例外は、形と長さを正規表現で決めた版・四半期・ID・コードの場所)。プラグインの名前は送らない。 モデルの中身・要素やファイルの名前・エラーの文・端末に残す ID・日時は、どの本文にも入らない(ADR-0026 の 2)。 受け口は受け取った日(UTC)で足し込む。

JSON Schema の注記:

  • 各本文: いつ送るか(x-modelith-when)、どの段階で送るか(x-modelith-level: all は「すべて送る」のときだけ、 error は「エラーだけ」でも送る)、本文の大きさの上限(x-modelith-max-bytes)。
  • 項目: x-modelith-dimension: true の項目(版・系列・送り手)だけを、受け口はほかの項目と掛け合わせて数える。 それ以外の項目は互いに掛け合わせず 1 つずつ数える(組み合わせが端末を見分ける手がかりにならないように)。 掛け合わせて見たい組は、ParseTime のように 1 つの項目にまとめる。

受け手は知らない項目を捨てる(版の違う送り手が項目を足しても、本文全体は拒まない)。 この型とスキーマは送り手に向けて厳しく、必須の項目が欠けた本文や知らない列挙の値を拒む。 受け口は、軸(kind・schemaVersion・client・appVersion・channel)だけを必須とし、 それ以外の項目は欠けていても、形や値が違っていても、その項目だけを捨てて残りを受ける。

Structs§

AutoViews
自動の図の種類ごとの回数(アプリの自動の図の id ごと)。
Checks
チェックの実行の回数と、1 回で見つかった問題の数の区分ごとの回数。
Count
上限つきの回数(0 以上 COUNT_MAX 以下)。
CreatedViews
作成した図(SysML v2 の view の種類)ごとの回数。
DailyReport
日に 1 回のまとめ。
Edits
編集の回数。名前は modelith-core の Intent の op と同じ。
ErrorReport
エラーの報告。エラーの文と利用者の文字は含めず、種類と自分たちのコードの場所だけを送る。
Exports
エクスポートの形式ごとの回数。
Layout
図の見た目だけを変える操作の回数。
LoginMethods
サーバの有効なログインの方式。
ParseTime
解析の時間の区分ごとの回数(ファイルの大きさ × 時間を 1 つの項目として数える)。
Saves
保存先ごとの回数。
Sender
送り手(どの本文にも入る)。受け口はこの 3 つだけを、ほかの項目と掛け合わせて数える。
ServerDailyReport
サーバの日に 1 回のまとめ。
StackFrame
スタックトレースの 1 段。
StartupReport
起動の報告。

Enums§

AmountClass
数の区分(サーバの利用者・プロジェクト・プラグインの数)。
Browser
Channel
アプリの公開の系列(modelith の ADR-0022)。
Client
送り手のプログラム。
Deployment
サーバの動かし方。
DurationClass
かかった時間の区分。
ErrorKind
エラーの種類。
ErrorName
例外の種類。決まった一覧に無いものは other。
Language
画面の表示の言語(modelith の ADR-0027)。
OnboardingStep
使い始めの段階。
Os
ParseDurationClass
解析にかかった時間の区分(解析は速いので、起動より細かい)。
ScreenClass
画面の幅の区分(760px は modelith の狭い画面の境目)。
SendLevel
送る段階(modelith の ADR-0026 の 1)。「送らない」の人の分は届かない。
SizeClass
ファイルの大きさの区分(UTF-8 のバイト数)。
StorageClass
保存容量の区分。
UsageReport
送る本文。
WeeksClass
このブラウザで使った週の数の区分。

Constants§

COUNT_MAX
Count の上限(1 回の本文・1 項目あたり)。送り手はこれで頭打ちにし(Count::capped)、受け手は超える値を受けない。
USAGE_SCHEMA_VERSION
利用状況の本文の形の版。項目の意味・区分の境目・値の一覧を変える(消す・改名する)ときに 1 つ上げる。 項目や列挙の値を足すだけなら上げない(受け手は知らないものを捨てるので、古い受け手も壊れない)。