使用状況の統計

GitLab Inc. は、さまざまなアクションを実行するために、お客様のインスタンスに関する情報を定期的に収集します。

FreeのGitLab Self-Managedインスタンスの場合、すべての使用状況の統計はオプトアウトです。

Service Ping

Service Pingは、週次のペイロードを収集してGitLab Inc.に送信するプロセスです。Service Pingが有効になっている場合、GitLabは他のインスタンスからデータを収集し、Service Pingに依存する特定のインスタンスレベルの分析機能を有効にします。

Service Pingを有効にする理由

Service Pingの主な目的は、より良いGitLabを構築することです。機能やステージの導入状況と使用状況を理解するために、GitLabがどのように使用されているかに関するデータを収集します。このデータは、GitLabがどのように価値を付加しているかのインサイトを提供し、人々がGitLabを使用する理由を理解するのに役立ちます。この知識があれば、より良い製品の意思決定を行うことができます。

Service Pingを有効にすることには、他にもいくつかのメリットがあります:

• GitLabインストールのユーザーのアクティビティーを経時的に分析します。
• 計画からモニタリングまで、同時DevOpsのインスタンス全体の導入状況の概要を示すDevOpsスコア。
• 収集されたデータを使用できるカスタマーサクセスマネージャー（CSM）を通じて、より積極的なサポートを提供します。
• GitLabへの投資から最大限の価値を引き出す方法に関するインサイトとアドバイス。
• 他の類似組織（匿名化）と比較して、DevOpsプロセスを改善する方法に関する具体的なアドバイスと推奨事項を示すレポート。
• 無料の有料機能を受け取るための登録機能プログラムへの参加。

Service Pingの設定

GitLabは、Service Pingに関連する3つの設定を提供します:

• Enable Service Ping（Service Pingを有効にする）: Service PingデータをGitLabに送信するかどうかを制御します。
• Service Pingの生成を有効にする: Service Pingデータをお客様のインスタンスで生成するかどうかを制御します。
• Include optional data in Service Ping（Service Pingにオプションデータを含める）: Service Pingデータにオプションのメトリクスを含めるかどうかを制御します。

これら3つの設定は、次の方法で相互に作用します:

• Service Pingが有効になっている場合、Service Ping Generation（Service Pingの生成）が自動的に有効になり、無効にすることはできません。
• Service Pingが無効になっている場合は、Service Ping Generation（Service Pingの生成）を個別に制御できます。
• Include optional data in Service Ping（Service Pingにオプションデータを含める）は、Service PingまたはService Ping Generation（Service Pingの生成）のいずれかが有効になっている場合にのみ使用できます。

登録機能プログラム

GitLabバージョン14.1以降では、GitLab Self-ManagedインスタンスでGitLab Enterprise Editionを実行しているGitLab Freeのお客様は、登録機能を有効にするにしてService Ping経由でアクティビティーデータを送信することで、有料機能を利用できます。ここで紹介する機能は、有料ティアから機能を削除するものではありません。有料ティアのインスタンスは、製品使用状況データポリシー （クラウドライセンスによって管理）の対象となります。

利用可能な機能

次の表では、以下を確認できます:

• 登録機能プログラムで利用できる機能
• 機能が利用可能なGitLabバージョン

登録機能を有効にする

1. 管理者権限を持つユーザーとしてサインインします。
2. 左側のサイドバーの下部で、管理者を選択します。
3. 設定 > メトリクスとプロファイリングを選択します。
4. 使用状況の統計セクションを展開します。
5. 有効になっていない場合は、Enable Service Ping（Service Pingを有効にする）チェックボックスを選択します。
6. 登録機能を有効にするチェックボックスを選択します。
7. 変更を保存を選択します。

バージョンチェック

有効にすると、新しいバージョンが利用可能かどうかとその重要度をステータスで通知します。ステータスは、すべての認証済みユーザーのヘルプページ（/help）と、管理者エリアページに表示されます。ステータスは次のとおりです:

• 緑: 最新バージョンのGitLabを実行しています。
• オレンジ: 更新されたバージョンのGitLabが利用可能です。
• 赤: 実行しているGitLabのバージョンには脆弱性があります。セキュリティ修正を含む最新バージョンをできるだけ早くインストールする必要があります。

バージョンチェックを有効または無効にする

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > メトリクスとプロファイリングを選択します。
3. 使用状況の統計を展開します。
4. バージョンチェックを有効にするチェックボックスを選択またはクリアします。
5. 変更を保存を選択します。

リクエストフローの例

次の例は、お客様のインスタンスとGitLabバージョンアプリケーション間の基本的なリクエスト/レスポンスフローを示しています:

%%{init: { "fontFamily": "GitLab Sans" }}%%
sequenceDiagram
    accTitle: Version check process
    accDescr: The GitLab instance queries the version application for updates and receives a status response as an image file.

    participant GitLab instance
    participant Version application
    GitLab instance->>Version application: Is there a version update?
    Version application->>GitLab instance: Response (PNG/SVG)

ネットワークを設定する

使用状況の統計をGitLab Inc.に送信するには、GitLabインスタンスからホストversion.gitlab.comへのポート443でのネットワークトラフィックを許可する必要があります。

GitLabインスタンスがプロキシの背後にある場合は、適切なプロキシ設定変数を設定します。

Service Pingを有効または無効にする

UIを使用する場合

Service Pingを有効または無効にするには、次のようにします:

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > メトリクスとプロファイリングを選択します。
3. 使用状況の統計を展開します。
4. Enable Service Ping（Service Pingを有効にする）チェックボックスを選択またはクリアします。
5. 変更を保存を選択します。

設定ファイルを使用する

管理者を無効にして、今後管理者エリアから設定されないようにするには、次の手順に従います。

Service Pingの生成を有効または無効にする

Service Pingの生成は、お客様のインスタンスでService Pingデータが自動的に生成されるかどうかを制御します。有効にすると、GitLabは使用状況の統計を含むService Pingペイロードを定期的に生成します。この設定は、データがGitLabと共有されているかどうかに関係なく機能します。

UIを使用する場合

Service Pingの生成を有効または無効にするには:

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > メトリクスとプロファイリングを選択します。
3. 使用状況の統計を展開します。
4. Service Pingの生成を有効にするチェックボックスを選択またはクリアします。
   • Enable Service Ping（Service Pingを有効にする）が選択されている場合、この設定は自動的に有効になり、インタラクションから無効になります。
   • Enable Service Ping（Service Pingを有効にする）がクリアされている場合は、この設定を個別に制御できます。
5. 変更を保存を選択します。

設定ファイルを使用する

設定を通じてService Pingの生成を制御するには:

Service Pingのオプションデータを有効または無効にする

GitLabは、運用データとオプションの収集データを区別します。

UIを使用する場合

Service Pingでオプションのデータを有効または無効にするには、次のようにします:

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > メトリクスとプロファイリングに移動します。
3. Usage Statistics（使用状況の統計）セクションを展開します。
4. Enable Service Ping（Service Pingを有効にする）またはEnable Service Ping Generation（Service Pingの生成を有効にする）のいずれかのチェックボックスが選択されていることを確認します。
5. オプションのデータを有効にするには、Include optional data in Service Ping（Service Pingにオプションデータを含める）チェックボックスを選択します。無効にするには、ボックスをオフにします。
6. 変更を保存を選択します。

設定ファイルを使用する

Service Pingペイロードへのアクセス

GitLab Inc.に送信された正確なJSONペイロードには、管理者エリアまたはAPIを介してアクセスできます。

UIの場合

1. 管理者権限を持つユーザーとしてサインインします。
2. 左側のサイドバーの下部で、管理者を選択します。
3. 設定 > メトリクスとプロファイリング > 使用状況の統計を選択します。
4. ペイロードのプレビューを選択します。

API経由:

Service Ping APIドキュメントを参照してください。

Service Pingペイロードを手動でアップロードする

インスタンスがインターネットにアクセスできない場合、またはService Ping cronジョブが有効になっていない場合でも、Service PingペイロードをGitLabにアップロードできます。

ペイロードを手動でアップロードするには、次のようにします:

1. 管理者権限を持つユーザーとしてサインインします。
2. 左側のサイドバーの下部で、管理者を選択します。
3. 設定 > メトリクスとプロファイリング > 使用状況の統計を選択します。
4. ペイロードのダウンロードを選択します。
5. JSONファイルを保存します。
6. Service Usage Data Centerにアクセスします。
7. ファイルを選択し、ダウンロードしたペイロードを含むJSONファイルを選択します。
8. アップロードを選択します。

アップロードされたファイルは、セキュアHTTPSプロトコルを使用して暗号化され、送信されます。HTTPSは、Webブラウザーとサーバー間に安全な通信チャンネルを作成し、中間者攻撃から送信されたデータを保護します。

手動アップロードで問題が発生した場合:

1. バージョンアプリプロジェクトのセキュリティフォークで機密イシューを開きます。
2. 可能であれば、JSONペイロードを添付してください。
3. @gitlab-org/analytics-section/analytics-instrumentationをタグ付けして、イシューのトリアージを行います。