Confluence Data Center でアプリの利用状況を表示する
App Usage を使用すると、Confluence 管理者はサイトにインストールされている Marketplace アプリがどのように使用されているかを把握できます。App Usage では、アプリの REST API アクティビティ、Active Objects データベース テーブル、マクロの使用状況を可視化します。これにより、管理者はアプリの利用状況を評価し、コンテンツの依存関係を特定するとともに、アップグレード、移行、アプリのライフサイクル管理について、より適切な意思決定を行うことができます。
利用可能なバージョン: Confluence Data Center 10.2.11、9.2.20、およびそれ以降のパッチ リリース。
はじめる前に
App Usage にアクセスするには、Confluence 管理者である必要があります。
App Usage を開く
[管理] > [Atlassian Marketplace] の順に選択します。
[App Usage] を選択します。
インストール済みのアプリを選択して、その利用状況の詳細を表示します。
[共通の利用状況データ] タブには、次のセクションが含まれる場合があります。
REST API の使用状況
データベーステーブル
マクロの使用状況
REST API の利用状況を理解する
REST API の利用状況セクションには、アプリが提供する REST API に対して行われた呼び出しが表示されます。
アプリが REST プラグイン モジュールを実装している場合、App Usage には、そのモジュールを介して行われた呼び出しが表示されます。外部からの呼び出しなど、アプリの REST プラグイン モジュールを経由しない呼び出しは、このビューでは追跡されません。
API パスが変更された場合、App Usage には最新のパスが表示され、変更前と変更後のパスで収集された利用状況データが統合されます。利用状況データは 5 分ごとに更新されます。
追跡は App Usage を有効にした後に開始されます。有効化前の過去の REST API アクティビティは、利用状況データには含まれません。
次の表では、このセクションに表示される情報について説明します。
| 列 | 説明 |
|---|---|
| ユーザー X 人による REST API 呼び出し X 件 | 追跡開始以降に行われた REST API 呼び出しの総数と、それらの呼び出しを行ったユーザー数。 |
| ユーザー | アプリの REST API を直接または間接的に使用したユーザー。 |
| 呼び出し件数 | そのユーザーがその特定の API 呼び出しを実行した回数。 |
| 最後に使用 | そのユーザーがその特定の API 呼び出しを最後に実行した日時。 |
データベース テーブルを理解する
データベース テーブル セクションには、アプリによって作成されたテーブルと、それらの現在の行数のスナップショットが表示されます。
App Usage に表示されるのは、Active Objects フレームワークを使用して実装されたテーブルのみです。アプリが Active Objects を使用して定義していないテーブルを使用している場合や、別の永続化メカニズムを使用している場合は、それらのテーブルは表示されません。
次の表では、このセクションに表示される情報について説明します。
| 列 | 説明 |
|---|---|
| データベース テーブル X 個 | アプリによって作成されたデータベース テーブルの総数。 |
| 表 | データベース テーブルの名前。 |
| 行数 | テーブル内の現在の行数。行数の更新が反映されるまでに時間がかかる場合があります。 |
マクロの利用状況を理解する
マクロの利用状況セクションには、Confluence コンテンツに埋め込まれているアプリ提供のマクロが表示されます。
このセクションでは、Confluence の検索機能を使用して、アプリ固有のマクロを含むページを特定します。これにより、管理者がコンテンツレベルでのアプリの依存関係を把握し、アプリの削除や置き換えによる影響を見積もるとともに、サイト全体で広く使用されているマクロを特定できます。
次の表では、このセクションに表示される情報について説明します。
| 列 | 説明 |
|---|---|
| macroName | アプリによって提供されるマクロの名前。 |
| 最終変更 | このマクロを含むページが最後に更新された日時。 |
| ページ数 | サイト内でこのマクロを含む一意のページ数。 |
カスタム マクロ
バージョン 10.2.15 および 9.2.23 以降、アプリ利用状況インサイトでは、サードパーティ製マクロだけでなく、インストール済みアプリによって提供されるカスタム マクロの利用状況も追跡対象となりました。インストール済みアプリによって提供されるマクロが Confluence のカスタム マクロ フレームワークを使用して構築されたものである場合、それらのマクロは他のすべてのアプリ マクロとともに [Macro Usage (マクロの利用状況)] タブに表示されるようになりました。表示される内容は次のとおりです。
アプリによって提供されるカスタム マクロ。
それらが埋め込まれているページの数。
それらのページが最後に変更された日時。
使い方
my-rest-plugin という名前のカスタム アプリが helloWorld という名前のカスタム マクロとともに作成され、Confluence インスタンスにインストールされ、3 ページで使用されています。
App Usage または利用状況の追跡を無効にする
機能フラグを使用すると、App Usage メニューや特定の利用状況データを無効にできます。
機能フラグ | 説明 |
|---|---|
app.usage.menu.disabled | 管理画面の App Usage メニューを無効または再度有効にします。 |
plugin.app.usage.common-usage-data | 共通の利用状況データ (REST API の利用状況およびデータベース テーブルを含む) を無効または再度有効にします。 |
| plugin.app.usage.macro-usage-views | マクロの利用状況データを無効または再度有効にします。 |