除雪スキーマ
このページではGitLabイベントのSnowplowスキーマリファレンスを提供します。
gitlab_standard
構造化イベントとページビューのためにgitlab_standard スキーマ を含んでいます。
StandardContext クラスはアプリケーション内でこのスキーマを表します。いくつかのプロパティはフロントエンドイベントのために自動的に入力され、バックエンドイベントのために手動で提供することができます。
| フィールド名 | 必須 | デフォルト値 | 種類 | 説明 |
|---|---|---|---|---|
project_id | {点線円｝ | 現在のプロジェクトID *。 | 整数。 | |
namespace_id | {点線円｝ | 現在のグループ/名前空間ID *。 | 整数。 | |
user_id | {点線円｝ | 現在のユーザーID *。 | 整数。 | ユーザーデータベースのレコード ID 属性。この値はコレクターレベルで仮名化処理を受けます。 |
context_generated_at | {点線円｝ | 現在のタイムスタンプ | 文字列（日付時刻形式） | コンテキストがいつ生成されたかを示すタイムスタンプ。 |
environment | {チェックサークル｝ | 現在の環境 | 文字列（最大32文字） |
production やstaging
|
source | {チェックサークル｝ | イベントソース | 文字列（最大32文字） | ソースアプリケーションの名前。gitlab-rails やgitlab-javascript
|
plan | {点線円｝ | 現在のネームスペースの計画 | 文字列（最大32文字） |
free,premium, あるいはultimateのような名前空間のプラン名。namespace から自動的に選ばれます。 |
google_analytics_id | {点線円｝ | GA ID値 *。 | 文字列（最大32文字） | Google AnalyticsのID。当社のマーケティングサイトから設定された場合に表示されます。 |
is_gitlab_team_member | {点線円｝ | boolean | イベントが GitLab チームメンバーによってトリガーされたかどうかを示します。 | |
extra | {点線円｝ | JSON | イベントに関連する追加データ。キーと値のペアの形式。 |
* フロントエンドイベントにのみ存在するデフォルト値。
デフォルト・スキーマ
フロントエンドのイベントには、Snowplowが提供するWeb固有のスキーマが含まれます。すべての URL は仮名化されています。エンティティ識別子は、個人を特定できる情報(PII)を置き換えます。PII にはユーザ名、グループ名、プロジェクト名が含まれます。ページタイトルも同じ理由でGitLab としてハードコードされます。
| フィールド名 | 必須 | 種類 | 説明 |
|---|---|---|---|
app_id | {チェックサークル｝ | 文字列です。 | ウェブサイト/アプリケーションの一意識別子 |
base_currency | {点線円｝ | 文字列です。 | 報告通貨 |
br_colordepth | {点線円｝ | 整数。 | ブラウザの色の深さ |
br_cookies | {点線円｝ | boolean | ブラウザはクッキーを許可しますか？ |
br_family | {点線円｝ | 文字列です。 | ブラウザファミリー |
br_features_director | {点線円｝ | boolean | Directorプラグインがインストールされていますか？ |
br_features_flash | {点線円｝ | boolean | Flashプラグインがインストールされていますか？ |
br_features_gears | {点線円｝ | boolean | Google gearsをインストールしていますか？ |
br_features_java | {点線円｝ | boolean | Javaプラグインがインストールされていますか？ |
br_features_pdf | {点線円｝ | boolean | Adobe PDFプラグインがインストールされていますか？ |
br_features_quicktime | {点線円｝ | boolean | Quicktimeプラグインがインストールされていますか？ |
br_features_realplayer | {点線円｝ | boolean | RealPlayerプラグインがインストールされていますか？ |
br_features_silverlight | {点線円｝ | boolean | Silverlightプラグインがインストールされていますか？ |
br_features_windowsmedia | {点線円｝ | boolean | Windowsメディアプラグインがインストールされていますか？ |
br_lang | {点線円｝ | 文字列です。 | ブラウザが設定されている言語 |
br_name | {点線円｝ | 文字列です。 | ブラウザ名 |
br_renderengine | {点線円｝ | 文字列です。 | ブラウザのレンダリングエンジン |
br_type | {点線円｝ | 文字列です。 | ブラウザの種類 |
br_version | {点線円｝ | 文字列です。 | ブラウザバージョン |
br_viewheight | {点線円｝ | 文字列です。 | ブラウザのビューポートの高さ |
br_viewwidth | {点線円｝ | 文字列です。 | ブラウザのビューポート幅 |
collector_tstamp | {点線円｝ | タイムスタンプ | コレクタによって記録されたイベントのタイムスタンプ |
contexts | {点線円｝ | ||
derived_contexts | {点線円｝ | Enrich プロセスで派生したコンテキスト | |
derived_tstamp | {点線円｝ | タイムスタンプ | 不正確なデバイスクロックを考慮したタイムスタンプ |
doc_charset | {点線円｝ | 文字列です。 | ウェブページの文字エンコーディング |
doc_height | {点線円｝ | 文字列です。 | Webページの高さ |
doc_width | {点線円｝ | 文字列です。 | Webページの幅 |
domain_sessionid | {点線円｝ | 文字列です。 | このドメインへのこのuser_id のこの訪問の一意識別子(UUID) |
domain_sessionidx | {点線円｝ | 整数。 | このuser_id がこのドメインにアクセスした回数のインデックス (最初のアクセスは1) |
domain_userid | {点線円｝ | 文字列です。 | ファーストパーティのCookieに基づくユーザーの一意識別子（ドメイン固有） |
dvce_created_tstamp | {点線円｝ | タイムスタンプ | クライアントデバイスが記録したイベント発生時のタイムスタンプ |
dvce_ismobile | {点線円｝ | boolean | デバイスがモバイルかどうかを示します |
dvce_screenheight | {点線円｝ | 文字列です。 | 画面/モニターの解像度 |
dvce_screenwidth | {点線円｝ | 文字列です。 | 画面/モニターの解像度 |
dvce_sent_tstamp | {点線円｝ | タイムスタンプ | イベントがクライアントデバイスからコレクタに送信されたタイムスタンプ |
dvce_type | {点線円｝ | 文字列です。 | デバイスの種類 |
etl_tags | {点線円｝ | 文字列です。 | このETL実行のタグのJSON |
etl_tstamp | {点線円｝ | タイムスタンプ | イベントがETLを開始したタイムスタンプ |
event | {点線円｝ | 文字列です。 | イベントタイプ |
event_fingerprint | {点線円｝ | 文字列です。 | ハッシュクライアントセットイベントフィールド |
event_format | {点線円｝ | 文字列です。 | イベントのフォーマット |
event_id | {点線円｝ | 文字列です。 | イベントUUID |
event_name | {点線円｝ | 文字列です。 | イベント名 |
event_vendor | {点線円｝ | 文字列です。 | イベントモデルを開発した会社 |
event_version | {点線円｝ | 文字列です。 | イベントスキーマのバージョン |
geo_city | {点線円｝ | 文字列です。 | IP発信元の都市 |
geo_country | {点線円｝ | 文字列です。 | IP発信国 |
geo_latitude | {点線円｝ | 文字列です。 | おおよその緯度 |
geo_longitude | {点線円｝ | 文字列です。 | おおよその経度 |
geo_region | {点線円｝ | 文字列です。 | IP原産地 |
geo_region_name | {点線円｝ | 文字列です。 | IP原産地 |
geo_timezone | {点線円｝ | 文字列です。 | IP発信元のタイムゾーン |
geo_zipcode | {点線円｝ | 文字列です。 | IP発信元の郵便番号 |
ip_domain | {点線円｝ | 文字列です。 | 訪問者のIPアドレスに関連付けられたセカンドレベルドメイン名 |
ip_isp | {点線円｝ | 文字列です。 | 訪問者のISP |
ip_netspeed | {点線円｝ | 文字列です。 | 訪問者の接続タイプ |
ip_organization | {点線円｝ | 文字列です。 | 訪問者のIPアドレスに関連する組織 - 見つからなかった場合のデフォルトはISP名です。 |
mkt_campaign | {点線円｝ | 文字列です。 | キャンペーンID |
mkt_clickid | {点線円｝ | 文字列です。 | クリックID |
mkt_content | {点線円｝ | 文字列です。 | 広告の内容またはID。 |
mkt_medium | {点線円｝ | 文字列です。 | トラフィックソースの種類 |
mkt_network | {点線円｝ | 文字列です。 | クリックIDが属する広告ネットワーク |
mkt_source | {点線円｝ | 文字列です。 | トラフィックの元となった会社 / ウェブサイト |
mkt_term | {点線円｝ | 文字列です。 | 参照元に関連するキーワード |
name_tracker | {点線円｝ | 文字列です。 | トラッカーの名前空間 |
network_userid | {点線円｝ | 文字列です。 | コレクターからのクッキーに基づく、ユーザーの一意識別子 (ネットワークレベルで設定されるため、トラッカーによって設定されるべきではありません) |
os_family | {点線円｝ | 文字列です。 | オペレーションシステムファミリー |
os_manufacturer | {点線円｝ | 文字列です。 | オペレーションシステムのメーカー |
os_name | {点線円｝ | 文字列です。 | オペレーションシステム名 |
os_timezone | {点線円｝ | 文字列です。 | クライアントのオペレーティングシステムのタイムゾーン |
page_referrer | {点線円｝ | 文字列です。 | 参照URL |
page_title | {点線円｝ | 文字列です。 | 個人を特定する情報を公開しないために、ページタイトルは以下のようにハードコードされています。GitLab
|
page_url | {点線円｝ | 文字列です。 | ページのURL |
page_urlfragment | {点線円｝ | 文字列です。 | フラグメント、別名アンカー |
page_urlhost | {点線円｝ | 文字列です。 | ホスト別名ドメイン |
page_urlpath | {点線円｝ | 文字列です。 | ページへのPages |
page_urlport | {点線円｝ | 整数。 | 指定されていればポート、指定されていなければ 80 |
page_urlquery | {点線円｝ | 文字列です。 | クエリ文字列 |
page_urlscheme | {点線円｝ | 文字列です。 | スキーム（プロトコル名） |
platform | {点線円｝ | 文字列です。 | アプリが動作するプラットフォーム |
pp_xoffset_max | {点線円｝ | 整数。 | 最後のping期間に見られたページxオフセットの最大値 |
pp_xoffset_min | {点線円｝ | 整数。 | 最後のping期間に見られた最小ページxオフセット。 |
pp_yoffset_max | {点線円｝ | 整数。 | 直近の ping 期間で見られたページ y オフセットの最大値。 |
pp_yoffset_min | {点線円｝ | 整数。 | 最後のping期間で見た最小ページyオフセット。 |
refr_domain_userid | {点線円｝ | 文字列です。 | 参照元ウェブサイトのSnowplowdomain_userid
|
refr_dvce_tstamp | {点線円｝ | タイムスタンプ |
domain_userid を内部リンクに添付した時刻 |
refr_medium | {点線円｝ | 文字列です。 | リファラの種類 |
refr_source | {点線円｝ | 文字列です。 | 認識されている場合のリファラの名前 |
refr_term | {点線円｝ | 文字列です。 | ソースが検索エンジンの場合のキーワード |
refr_urlfragment | {点線円｝ | 文字列です。 | リファラURLフラグメント |
refr_urlhost | {点線円｝ | 文字列です。 | リファラーホスト |
refr_urlpath | {点線円｝ | 文字列です。 | 参照元ページパス |
refr_urlport | {点線円｝ | 整数。 | 参照元ポート |
refr_urlquery | {点線円｝ | 文字列です。 | リファラURLクエリ文字列 |
refr_urlscheme | {点線円｝ | 文字列です。 | リファラースキーム |
se_action | {点線円｝ | 文字列です。 | アクション/イベントそのもの |
se_category | {点線円｝ | 文字列です。 | イベントのカテゴリ |
se_label | {点線円｝ | 文字列です。 | アクションが実行される’オブジェクト’を参照するためによく使われるラベル。 |
se_property | {点線円｝ | 文字列です。 | アクションまたはオブジェクトに関連付けられたプロパティ。 |
se_value | {点線円｝ | 10進数 | ユーザーアクションに関連付けられた値 |
ti_category | {点線円｝ | 文字列です。 | 項目カテゴリ |
ti_currency | {点線円｝ | 文字列です。 | 通貨 |
ti_name | {点線円｝ | 文字列です。 | 項目名 |
ti_orderid | {点線円｝ | 文字列です。 | 注文ID |
ti_price | {点線円｝ | 10進数 | 商品価格 |
ti_price_base | {点線円｝ | 10進数 | 基準通貨での商品価格 |
ti_quantity | {点線円｝ | 整数。 | 項目数量 |
ti_sku | {点線円｝ | 文字列です。 | アイテムSKU |
tr_affiliation | {点線円｝ | 文字列です。 | トランザクションの所属（チャネルなど） |
tr_city | {点線円｝ | 文字列です。 | 配送先アドレス: 市区町村 |
tr_country | {点線円｝ | 文字列です。 | 配送先アドレス: 国 |
tr_currency | {点線円｝ | 文字列です。 | 取引通貨 |
tr_orderid | {点線円｝ | 文字列です。 | 注文ID |
tr_shipping | {点線円｝ | 10進数 | 配送料金 |
tr_shipping_base | {点線円｝ | 10進数 | 基本通貨での送料 |
tr_state | {点線円｝ | 文字列です。 | 配送先アドレス：都道府県 |
tr_tax | {点線円｝ | 10進数 | 取引税額（付加価値税込みの金額など） |
tr_tax_base | {点線円｝ | 10進数 | 基準通貨で適用される税金 |
tr_total | {点線円｝ | 10進数 | 取引合計値 |
tr_total_base | {点線円｝ | 10進数 | 基準通貨での取引総額 |
true_tstamp | {点線円｝ | タイムスタンプ | ユーザーが設定した正確なタイムスタンプ |
txn_id | {点線円｝ | 文字列です。 | 取引ID |
unstruct_event | {点線円｝ | JSON | イベントのプロパティ |
uploaded_at | {点線円｝ | ||
user_fingerprint | {点線円｝ | 整数。 | (できればユニークな)ブラウザ機能に基づくユーザー識別子 |
user_id | {点線円｝ | 文字列です。 | setUserIdを使用してビジネスによって設定される、ユーザーの一意の識別子。 |
user_ipaddress | {点線円｝ | 文字列です。 | IPアドレス |
useragent | {点線円｝ | 文字列です。 | ユーザーエージェント（ブラウザ文字列として表現されます） |
v_collector | {点線円｝ | 文字列です。 | コレクターのバージョン |
v_etl | {点線円｝ | 文字列です。 | ETLバージョン |
v_tracker | {点線円｝ | 文字列です。 | 除雪トラッカーの識別子 |
gitlab_service_ping
ServicePing (redis およびredis_hll) から変換されたバックエンドイベントは、ヘルパークラスを使用してServicePing コンテキストを含める必要があります。
コンテキスト付きで変換されたredis_hll イベントの例。
| フィールド名 | 必須 | 種類 | 説明 |
|---|---|---|---|
data_source | {チェックサークル｝ | 文字列 (最大64文字) | メトリクス YAML 定義のdata_source 属性。 |
event_name* | {点線円｝ | 文字列（最大128文字） | イベントとメトリクスの間に多対多の関係がある場合、このフィールドには、ダウンストリーム・システムで集計に使用できる Redis イベント名が含まれます。 |
key_path* | {点線円｝ | 文字列（最大256文字） | メトリクス YAML 定義のkey_path 属性。 |
*event_name またはkey_path のいずれかが必要です。