はじめに
ここでは、Couchbase Mobileを構成するSync Gatewayの機能であるメトリクスREST APIとパブリックAPIについて解説します。
なお、Couchbase Mobileについては、Couchbase Mobileアプリケーション開発へのロードマップに記事をまとめている他、(これらの記事を元に構成した)以下の電子書籍を無償で頒布しています。
また、Couchbase Mobileは、Couchbase LiteとCouchbase Serverとのデータ同期機能を提供します。Couchbase Serverの存在意義、機能詳細、利用方法等については、拙著NoSQLドキュメント指向データベースCouchbase Serverファーストステップガイド(インプレスR&D刊)や、NoSQL/JSONデータベースCouchbase Server理解・活用へのロードマップにまとめてある記事をご参考ください。
メトリクスRest API
概要
Sync GatewayのメトリクスREST APIを提供し、パフォーマンスデータの収集を簡単かつ安全にしています。
エンドポイント
以下のような、2つのエンドポイントがあり、2つの形式のいずれかでデータを受け取ることができます。
-
_metrics
エンドポイントは、PrometheusフォーマットでSync Gatwwayの統計情報を返します(例:GET :4986/_metrics)。以下に参考情報を記します。
-
_expvars
エンドポイントは、Sync Gateway統計情報をJSON形式で返します。
APIエクスプローラー
以下のような、SwaggerベースのAPIエクスプローラーが公開されています。
APIエクスプローラーは、すべてのエンドポイントを機能別にグループ化しています。
ラベルをクリックすると、展開されエンドポイントに関する詳細を確認できます。
パブリックREST API
概要
パブリックREST API の利用はオプションであり、Couchbase Lite とCouchbase Server の同期による、オフラインファーストアプリケーション、あるいはエッジコンピューティングのためのデータプラットフォームとしての利用のためには、必ずしも利用する必要はありません。
Sync Gatewayが提供する、データベースや、ドキュメントの操作などのREAT APIとしての公開されている機能を、別のアプリケーションとの連携のために利用することが考えられます。
APIエクスプローラー
以下のような、SwaggerベースのAPIエクスプローラーが公開されています。
APIエクスプローラーは、すべてのエンドポイントを機能別にグループ化しています。
ラベルをクリックすると、展開されエンドポイントに関する詳細を確認できます。
構成
各REST APIは、それぞれ異なるポート番号を使います。ユーザーは、ポート番号を変更することも可能です。
また、ユーザーがREST APIにアクセスできるようにするには、ユーザー用にCouchbase ServerベースのRBACユーザーを作成する必要があります。
構成方法等の詳細については、ドキュメントを参照してください。
関連情報