Azure Cosmos DB Java SDK v4 的效能秘訣

發行項
04/13/2024

適用於：NoSQL

重要

本文提供的效能秘訣僅適用於 Azure Cosmos DB JAVA SDK v4。如需更多資訊，請參閱 Azure Cosmos DB Java SDK v4 版本資訊、Maven 存放庫和 Azure Cosmos DB Java SDK v4 疑難排解指南。如果您目前使用的版本比 v4 舊，請參閱遷移至 Azure Cosmos DB Java SDK v4 指南，以取得升級至 v4 的協助。

Azure Cosmos DB 是一個既快速又彈性的分散式資料庫，可在獲得延遲與輸送量保證的情況下順暢地調整。使用 Azure Cosmos DB 時，您不須進行主要的架構變更，或是撰寫複雜的程式碼來調整您的資料庫。相應增加和減少就像進行單一 API 呼叫或 SDK 方法呼叫一樣簡單。不過，由於 Azure Cosmos DB 是透過網路呼叫存取，所以您可以在使用 Azure Cosmos DB Java SDK v4 時，進行用戶端最佳化以達到最高效能。

因此，如果您是問：「如何改善資料庫效能？」，請考慮下列選項：

網路

為了效能在相同 Azure 區域中共置用戶端

可能的話，請將任何呼叫 Azure Cosmos DB 的應用程式放在與 Azure Cosmos DB 資料庫相同的區域中。以約略的比較來說，在相同區域內對 Azure Cosmos DB 進行的呼叫會在 1-2 毫秒內完成，但美國西岸和美國東岸之間的延遲則會 >50 毫秒。視要求所採用的路由而定，各項要求從用戶端傳遞至 Azure 資料中心界限時的這類延遲可能有所不同。確保呼叫端應用程式與佈建的 Azure Cosmos DB 端點位於相同的 Azure 區域中，將可能達到最低的延遲。如需可用區域的清單，請參閱 Azure 區域。

Azure Cosmos DB 連線原則的圖例

與多重區域 Azure Cosmos DB 帳戶互動的應用程式必須設定慣用位置，以確保要求會進入共置區域。

啟用加速網路以降低延遲和 CPU 抖動

強烈建議遵循指示，在 Windows 中啟用加速網路（針對指示選取）或 Linux（針對指示選取）Azure VM，藉由降低延遲和 CPU 抖動來將效能最大化。

若沒有加速網路功能，AZURE VM 與其他 Azure 資源之間傳輸的 IO 可能會透過位於 VM 與其網路卡之間的主機和虛擬交換器路由傳送。將主機和虛擬交換器內嵌在資料路徑中，不僅會增加通道的延遲和抖動，還會佔用 VM 的 CPU 週期。使用加速網路時，VM 會直接與 NIC 介面，而不需要中繼。所有網路原則詳細數據都會在 NIC 的硬體中處理，略過主機和虛擬交換器。一般來說可以預期降低延遲並提高輸送量，而且啟用加速網路時，延遲情形會更為一致，CPU 使用率也會降低。

限制：VM OS 必須支援加速網路，而且只有在 VM 停止並解除配置時，才能啟用加速網路。無法使用 Azure Resource Manager 部署 VM。 App Service 未啟用加速網路。

如需詳細資訊，請參閱 Windows 和 Linux 指示。

調整直接和閘道連線設定

若要最佳化直接和閘道模式連線設定，請參閱如何調整 JAVA SDK v4 的連線設定。

SDK 使用方式

安裝最新的 SDK

Azure Cosmos DB SDK 會持續改善以提供最佳效能。若要判斷最新的 SDK 改進功能，請流覽 Azure Cosmos DB SDK。

在應用程式的存留期內使用單一 Azure Cosmos DB 用戶端

每個 Azure Cosmos DB 用戶端執行個體都是安全執行緒，並且會有效率地執行連線管理和位址快取處理。為了允許 Azure Cosmos DB 用戶端有效率的連線管理和更好的效能，強烈建議在應用程式的存留期內使用 Azure Cosmos DB 用戶端的單一實例。

使用應用程式所需的最低一致性層級

建立 CosmosClient 時，如果未明確設定為工作階段，則會使用預設的一致性。如果您的應用程式邏輯不需要工作階段一致性，請將 [一致性] 設定為 [最終]。注意：在採用 Azure Cosmos DB 變更摘要處理器的應用程式中，建議至少 使用會話 一致性。

使用非同步 API 盡可能利用佈建的輸送量

Azure Cosmos DB JAVA SDK v4 會組合兩個 API，也就是同步和非同步。大致來說，非同步 API 會實作 SDK 功能，而同步 API 則是對非同步 API 發出封鎖呼叫的精簡包裝函式。這與舊版 Azure Cosmos DB 異步 Java SDK v2 不同，這是僅限異步，而舊版的 Azure Cosmos DB 同步 Java SDK v2 則不同，後者是僅限同步處理，而且有個別的實作。

在用戶端初始化期間要決定所選擇的 API；CosmosAsyncClient 支援非同步 API，而 CosmosClient 支援同步 API。

異步 API 會實作非封鎖 IO，如果您的目標是在向 Azure Cosmos DB 發出要求時達到最大輸送量，則為最佳選擇。

如果您想要或需要 API，則使用同步 API 是正確的選擇，這會封鎖對每個要求的回應，或同步作業是否為應用程式中的主要範例。舉例來說，如果輸送量並非重點，在微服務應用程式中將資料保存到 Azure Cosmos DB 時，建議使用同步 API。

請注意，同步 API 輸送量會隨著要求回應時間增加而降低，而異步 API 可讓硬體的完整頻寬功能飽和。

您使用同步 API 時，可透過地理共置獲得更高且更一致的輸送量 (請參閱為了效能在相同 Azure 區域中共置用戶端)，但仍不應超過非同步 API 可達成的輸送量。

某些使用者可能也不太熟悉 Project Reactor，這是用來實作 Azure Cosmos DB JAVA SDK v4 Async API 的回應式串流架構。如果對此有所顧慮，建議參閱我們的簡介反應器模式指南 (英文)，然後查看回應式程式設計簡介 (英文)，提高自己的熟悉度。如果您已使用 Azure Cosmos DB 搭配非同步介面，而且您使用的 SDK 是 Azure Cosmos DB 非同步 JAVA SDK v2，則您可能熟知 ReactiveX/RxJava，但不確定 Project Reactor 有哪些變更。在此情況下，請查看我們的 Reactor 與 RxJava 指南，以熟悉。

下列程式碼片段示範了如何分別針對非同步 API 或同步 API 作業初始化 Azure Cosmos DB 用戶端：

非同步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 非同步 API


CosmosAsyncClient client = new CosmosClientBuilder()
        .endpoint(HOSTNAME)
        .key(MASTERKEY)
        .consistencyLevel(CONSISTENCY)
        .buildAsyncClient();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API


CosmosClient client = new CosmosClientBuilder()
        .endpoint(HOSTNAME)
        .key(MASTERKEY)
        .consistencyLevel(CONSISTENCY)
        .buildClient();

擴增用戶端工作負載

如果您是以高輸送量層級進行測試，用戶端應用程式可能會成為瓶頸，因為電腦對 CPU 或網路的使用率將達到上限。如果到了這一刻，您可以將用戶端應用程式向外延展至多部伺服器，以繼續將 Azure Cosmos DB 帳戶再往前推進一步。

根據理想的經驗法則，建議不要超過任何指定伺服器上 >50% 的 CPU 使用率，以保持低延遲。

使用適當排程器 (避免竊取事件迴圈 IO Netty 執行緒)

Azure Cosmos DB JAVA SDK 的非同步功能是以 netty 非封鎖 IO 為基礎。 SDK 會使用固定數目的 IO netty 事件迴圈執行緒 (和您電腦所擁有的 CPU 核心數一樣多) 來執行 IO 作業。 API 所傳回的 Flux 會在其中一個共用的 IO 事件迴圈 netty 執行緒上發出結果。因此，請切勿封鎖共用的 IO 事件迴圈 netty 執行緒。若執行 CPU 密集工作或封鎖 IO 事件迴圈 netty 執行緒上的作業，可能會導致鎖死或大幅降低 SDK 輸送量。

例如，下列程式碼會在事件迴圈 IO netty 執行緒上執行 CPU 密集工作：


Mono<CosmosItemResponse<CustomPOJO>> createItemPub = asyncContainer.createItem(item);
createItemPub.subscribe(
        itemResponse -> {
            //this is executed on eventloop IO netty thread.
            //the eventloop thread is shared and is meant to return back quickly.
            //
            // DON'T do this on eventloop IO netty thread.
            veryCpuIntensiveWork();
        });

收到結果之後，您應該避免在事件迴圈 IO netty 線程上對結果執行任何 CPU 密集工作。您可以改為提供您自己的排程器，以提供自己的執行緒來執行工作，如下所示 (需要 import reactor.core.scheduler.Schedulers)。


Mono<CosmosItemResponse<CustomPOJO>> createItemPub = asyncContainer.createItem(item);
createItemPub
        .publishOn(Schedulers.parallel())
        .subscribe(
                itemResponse -> {
                    //this is now executed on reactor scheduler's parallel thread.
                    //reactor scheduler's parallel thread is meant for CPU intensive work.
                    veryCpuIntensiveWork();
                });

根據您的工作類型，您應該針對工作使用適當的現有 Reactor 排程器。請閱讀這裡 Schedulers。

若要進一步瞭解 Project Reactor 的執行緒和排程模型，請參閱 Project Reactor 的這篇部落格文章。

如需 Azure Cosmos DB Java SDK v4 的詳細資訊，請參閱 GitHub 上 Azure SDK for Java monorepo 的 Azure Cosmos DB 目錄。

將應用程式中的記錄設定最佳化

基於各種原因，您應該在產生高要求輸送量的線程中新增記錄。如果您的目標是使用此執行緒產生的要求，使容器的佈建輸送量完全飽和，記錄最佳化即可大幅提升效能。

設定非同步記錄器

同步記錄器的延遲一定會影響到產生要求的執行緒的整體延遲計算。建議使用非同步記錄器 (例如 log4j2)，從高效能應用程式執行緒將將記錄作業的額外負荷分離出去。

停用 netty 的記錄

Netty 程式庫記錄通訊頻繁，而且必須加以關閉 (隱藏組態中的登入可能不夠) 以避免額外的 CPU 成本。如果您不是在偵錯模式中，請停用 netty 全部的記錄。因此，如果您要使用 log4j 來移除 netty 中的 org.apache.log4j.Category.callAppenders() 所產生的額外 CPU 成本，請將下列行新增至程式碼基底：

org.apache.log4j.Logger.getLogger("io.netty").setLevel(org.apache.log4j.Level.OFF);

OS 開啟檔案資源限制

某些 Linux 系統 (例如 Red Hat) 有開啟檔案數目的上限，因此有連線總數的上限。執行下列命令來檢視目前的限制：

ulimit -a

開啟檔案 (nofile) 的數目必須夠大，才能有足夠空間供您設定的連線集區大小和 OS 的其他開啟檔案使用。您可以進行修改，以允許較大的連線集區大小。

開啟 limits.conf 檔案：

vim /etc/security/limits.conf

新增/修改下列幾行：

* - nofile 100000

在點寫入中指定分割區索引鍵

若要改善點寫入的效能，請在點寫入 API 呼叫中指定項目分割區索引鍵，如下所示：

非同步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 非同步 API

asyncContainer.createItem(item,new PartitionKey(pk),new CosmosItemRequestOptions()).block();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API

syncContainer.createItem(item,new PartitionKey(pk),new CosmosItemRequestOptions());

而不是只提供項目實例，如下所示：

非同步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 非同步 API

asyncContainer.createItem(item).block();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API

syncContainer.createItem(item);

後者受到支援，但會導致應用程式增加延遲；SDK 必須剖析項目，並將分割區索引鍵解壓縮。

查詢作業

如需查詢作業，請參閱查詢的效能秘訣。

編製索引原則

將未使用的路徑排除於索引編製外以加快寫入速度

Azure Cosmos DB 的編製索引原則可讓您使用索引路徑（setIncludedPaths 和 setExcludedPaths）指定要包含或排除索引編製的文件路徑。在事先知道查詢模式的案例中，使用檢索路徑可改善寫入效能並降低索引儲存空間，因為檢索成本與檢索的唯一路徑數目直接相互關聯。例如，下列程式碼示範如何使用 "*" 萬用字元，將文件的整個區段 (亦稱為樹狀子目錄) 從索引編製作業中併入和排除。


CosmosContainerProperties containerProperties = new CosmosContainerProperties(containerName, "/lastName");

// Custom indexing policy
IndexingPolicy indexingPolicy = new IndexingPolicy();
indexingPolicy.setIndexingMode(IndexingMode.CONSISTENT);

// Included paths
List<IncludedPath> includedPaths = new ArrayList<>();
includedPaths.add(new IncludedPath("/*"));
indexingPolicy.setIncludedPaths(includedPaths);

// Excluded paths
List<ExcludedPath> excludedPaths = new ArrayList<>();
excludedPaths.add(new ExcludedPath("/name/*"));
indexingPolicy.setExcludedPaths(excludedPaths);

containerProperties.setIndexingPolicy(indexingPolicy);

ThroughputProperties throughputProperties = ThroughputProperties.createManualThroughput(400);

database.createContainerIfNotExists(containerProperties, throughputProperties);
CosmosAsyncContainer containerIfNotExists = database.getContainer(containerName);

如需詳細資訊，請參閱 Azure Cosmos DB 索引編製原則。

輸送量

測量和調整較低的要求單位/秒使用量

Azure Cosmos DB 提供許多的資料庫作業，包括使用 UDF、預存程序和觸發程序進行關聯式和階層式查詢，而這些作業全都是對資料庫集合內的文件來進行。與上述各項作業相關聯的成本，會因為完成作業所需的 CPU、IO 和記憶體而不同。您不需要考慮和管理硬體資源，您可以將要求單位 (RU) 想成是執行各種資料庫作業以及服務應用程式要求時所需的資源數量。

輸送量是根據為每個容器所設定的要求單位數量來佈建。要求單位消耗量是以每秒的速率來計算。如果應用程式的速率超過為其容器佈建的要求單位速率，便會受到限制，直到該速率降到容器的佈建層級以下。如果您的應用程式需要較高的輸送量，您可以藉由佈建其他的要求單位來增加輸送量。

查詢的複雜性會影響針對作業所耗用的要求單位數量。述詞數目、述詞性質、UDF 數目，以及來源資料集的大小，全都會影響查詢作業的成本。

若要測量任何作業 (建立、更新或刪除) 的額外負荷，請檢查 x-ms-request-charge 標頭，來測量這些作業所耗用的要求單位數量。您也可以查看 ResourceResponse<T> 或 FeedResponse<T> 中的對等 RequestCharge 屬性。

非同步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 非同步 API

CosmosItemResponse<CustomPOJO> response = asyncContainer.createItem(item).block();

response.getRequestCharge();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API

CosmosItemResponse<CustomPOJO> response = syncContainer.createItem(item);

response.getRequestCharge();

在此標頭中傳回的要求費用是佈建輸送量的一小部分。例如，如果您已布建 2000 RU/秒，且上述查詢傳回 1,000 1KB 檔，則作業的成本為 1000。因此在一秒內，伺服器在對後續要求進行速率限制前，只會接受兩個這類要求。如需詳細資訊，請參閱要求單位和要求單位計算機。

處理速率限制/要求速率太大

當用戶端嘗試超過帳戶保留的輸送量時，伺服器的效能不會降低，而且不會使用超過保留層級的輸送量容量。伺服器將預先使用 RequestRateTooLarge (HTTP 狀態碼 429) 來結束要求，並傳回 x-ms-retry-after-ms 標頭，以指出使用者重試要求之前必須等候的時間量 (毫秒)。

HTTP Status 429,
Status Line: RequestRateTooLarge
x-ms-retry-after-ms :100

SDK 全都隱含地攔截這個回應，採用伺服器指定的 retry-after 標頭，並重試此要求。除非有多個用戶端同時存取您的帳戶，否則下次重試將會成功。

如果您有多個用戶端都以高於要求速率的方式累積運作，則用戶端在內部設定為 9 的預設重試計數可能會不敷使用；在此情況下，用戶端會擲回 CosmosClientException (狀態碼 429) 到應用程式。預設重試計數可以使用 ThrottlingRetryOptions 執行個體上的 setMaxRetryAttemptsOnThrottledRequests() 進行變更。根據預設，如果要求繼續以高於要求速率的方式運作，則會在 30 秒的累計等候時間後傳回 CosmosClientException (狀態碼 429)。即使目前的重試計數小於最大重試計數 (預設值 9 或使用者定義的值)，也會發生這種情況。

雖然自動重試行為有助於改善大部分應用程式的恢復功能和可用性，但是在進行效能基準測試時可能會有所歧異 (尤其是在測量延遲時)。如果實驗達到伺服器節流並導致用戶端 SDK 以無訊息模式重試，則用戶端觀察到的延遲將會突然增加。若要避免效能實驗期間的延遲尖峰，測量每個作業所傳回的費用，並確保要求是以低於保留要求速率的方式運作。如需詳細資訊，請參閱要求單位。

輸送量較高之少量文件的設計

指定之作業的要求費用 (要求處理成本) 與文件大小直接相互關聯。大型文件的作業成本高於小型文件的作業成本。在理想情況下，架構您的應用程式和工作流程，讓您的專案大小是 ~1 KB，或是類似的順序或大小。對於延遲敏感的應用程式，應避免大型專案 - 多 MB 檔會讓應用程式變慢。

下一步

若要深入了解如何針對規模和高效能設計您的應用程式，請參閱 Azure Cosmos DB 的資料分割與調整規模。

正在嘗試為遷移至 Azure Cosmos DB 進行容量規劃嗎？您可以使用現有資料庫叢集的相關資訊進行容量規劃。

如果您知道現有資料庫叢集中的虛擬核心和伺服器數目，請參閱使用虛擬核心或 vCPU 來估計要求單位
如果您知道目前資料庫工作負載的一般要求率，請參閱使用 Azure Cosmos DB 容量規劃工具來估計要求單位

Azure Cosmos DB Java SDK v4 的效能秘訣

網路

調整直接和閘道連線設定

SDK 使用方式

查詢作業

編製索引原則

輸送量

下一步

其他資源