Release Notes for Couchbase Server 5.5.x
Couchbase Server 5.5.x is a significant update of the Couchbase Data Platform. This release specifically highlights agility, performance, and manageability and includes enhancements to existing services as well as new server and SDK components.
Take a look at What’s New? for a list of new features and improvements that are available in this release.
Release 5.5.6
Couchbase Server 5.5.6, released in November 2019, is the sixth maintenance release in the 5.5.x series for Couchbase Server. This maintenance release includes bug fixes and improvements on multiple components.
Fixed Issues
Data Service
Issue | Description |
---|---|
Fixed handling of SSL_ERROR_WANT_WRITE. |
|
SSL write failures may not reset the connection in the write phase. This has been fixed by propagating SSL write errors from sendmsg. |
|
Extended logging for SSL read/write failures. |
|
Fixed an issue that caused a Write Bucket Failure and corrupted the vBucket file. |
Cluster Manager
Issue | Description |
---|---|
Fixed an issue where, under unknown circumstances, leader_lease_acquirer would hang trying to shutdown worker. |
|
Added the ability to filter internal users for logging audit events. |
Index Service
Issue | Description |
---|---|
Fixed an issue in the index service which caused it to crash continuously. |
|
Fixed an issue that caused the Plasma storage engine to grow indefinitely. |
|
A StreamEnd message for a vBucket can be processed before a StreamBegin message in feed’s backch. This lead to inconsistent book-keeping and caused the index service to enter an infinite loop. This has been fixed. |
|
The ForestDB reserve bitmap revision number was not set correctly and caused cbbackupmgr merge to fail. This has been fixed. |
|
Index creation failed as the index service was unable to create index replicas. This has been fixed. |
|
Running COUNT on an index FullScan returned incorrect results when it included DESC order. This has been fixed by updating the code to handle Inclusion getting flipped due to the DESC order. |
|
Fixed an issue in ForestDB where renaming a compacted file led to the file getting deleted. |
|
Fixed a memory allocation failure in Forestdb that caused a system crash under pressure. |
|
Fixed an issue where new index builds remained stuck if indexes on MAINT_STREAM were dropped before indexes on INIT_STREAM during rebalance. |
|
Fixed an issue where the index node crashed with too many open files. |
Query Service
Issue | Description |
---|---|
Fixed an issue that caused a drop in throughput for array queries. |
|
Fixed a connection pool leak observed when querying system:indexes. |
|
Some proactive fixes around covered queries delivered in release 5.5.5 were observed to cause regressions and hence have been reverted in this release. The reverted issues are MB-35392, MB-34666, and MB-34660. |
|
Avoid IntersectScan when the index is a subset. |
|
Fixed an issue where the query engine returned incorrect results when using a partition index and the ORDER BY clause. |
Security
Issue | Description |
---|---|
The Mochiweb acceptors would hang forever if TLS handshake froze. This has been fixed by setting a timeout for TLS handshake. |
Release 5.5.5
Couchbase Server 5.5.5, released in July 2019, is the fifth maintenance release in the 5.5.x series for Couchbase Server. This maintenance release includes bug fixes and improvements on multiple components.
Fixed Issues
Cross Datacenter Replication (XDCR)
Issue | Description |
---|---|
Fixed an issue so that XDCR no longer deletes replication specs incorrectly during transient rebalancing states. If the target bucket is removed, XDCR will still remove the replication spec using a non-topology-change-detector module. This removal mechanism is more fail-safe. |
Data Service
Issue | Description |
---|---|
Fixed an issue where documents with a TTL, containing system XATTRs, and which are compressed, may have their datatype metadata incorrectly set. This prevents any subsequent modification of the XATTRs on the deleted document, until the document is re-created. |
|
Reset snapshot range to be a valid range. |
|
Fixed an issue where the response to a getReplica command could be significantly delayed. |
Index Service
Issue | Description |
---|---|
The index service now uses CountTotal for count aggregate on full index scan (leading key, no group by). This improves query performance as the count is precomputed. |
|
Fixed a memory leak caused by snapshot metadata objects linked list references. |
Install and Upgrade
Issue | Description |
---|---|
Fixed an issue that caused Couchbase Server to take > 130% CPU while idle on Mac OS. |
|
Couchbase Server versions 5.5.3 and 5.5.4 failed to start on Mac OS platform due to an issue in the startup script. The startup script has been updated in version 5.5.5. Note that Mac OS packages for versions 5.5.3 and 5.5.4 have been removed from the Downloads page. We recommend that you upgrade to the latest maintenance release on a given series to avail the bug fixes and improvements. |
Query Service
Issue | Description |
---|---|
Better identifier handling to determine whether an identifier should be covered or not. |
|
Avoid IntersectScan when the index is a subset. |
|
Fixed an issue where the implicit cover of nested array did not work as expected with arbitrary variables. |
|
The query service now generates a special error for subquery build failures and sets the HTTP error code appropriately. |
Release 5.5.4
Couchbase Server 5.5.4, released in April 2019, is the fourth maintenance release in the 5.5.x series for Couchbase Server. This maintenance release includes fixes to the data, index, and query services, and XDCR, tools, and UI components.
Fixed Issues
Cross Datacenter Replication (XDCR)
Issue | Description |
---|---|
Following an issue on a remote cluster, XDCR failed to recover and threw an exception. |
|
XDCR failed to replicate files larger than the network usage limit. This has been fixed so the bandwidth throttler can handle large documents with sizes greater than the usage limit. |
|
Fixed an issue where the XDCR log level setting was not retained when upgrading Couchbase Server from version 4.x to newer version. |
|
Added timeout to replication startup sequence. |
|
Fixed the heartbeat mechanism to detect when an XDCR rest server was stuck. |
Data Service
Issue | Description |
---|---|
Fixed a race condition that was exposed when a supervisor that is shutting down normally, is for some reason brutally shutdown leaving an orphan child process. This rogue lease acquirer interfered with the operation of the orchestrator causing, for instance, rebalance to fail. |
|
Memcached returned ENGINE NOT_STORED to client after trying to perform arithmetic operations and caused a race condition. |
|
Fixed an issue that caused a race condition between DCP consumer message processing and stream shutdown. |
|
Fixed an issue where the breakpad did not catch the memcached segfault (exit status 139). |
|
Fixed an issue where the audit daemon asserted when rotating an empty audit log causing a crash. |
|
Fixed an issue so that when an on connection error is encountered, certain operations are retried before returning an error. |
|
Introduced a delay in updating the RBAC database revision number to avoid returning AUTH_STALE during a refresh of the RBAC database. |
|
Fixed an issue where a chain of events, active compression of an extended attribute value followed by eviction and then expiry, triggered an exception. |
|
If an append/prepend request contended with another request at the Server, instead of automatically retrying on the Server (as expected), it returned EEXISTs back to the application. |
|
Added audit trail for the connected bucket. |
|
Fixed an issue where CAS value 0 was returned for a successful Append response. |
|
Defragment document StoredValue in addition to blobs to help cases where a large number of documents with a given key size are deleted, and then new documents are allocated with a different key size. In this case the original size class would not be able to be reused, and hence fragmentation could be high in that class. |
Index Service
Issue | Description |
---|---|
It was possible to create an index with fewer replicas than the default num_replicas if you used nodes_list in the WITH clause with fewer nodes than the default number of replicas. |
|
Fixed an issue where frequent processing of old create tokens caused high CPU usage on index nodes. |
|
Fixed an issue to terminate all watcher goroutines upon close of MetadataProvider. |
|
The index service was getting stuck during warmup because of coredumps. This has been fixed. |
|
Fixed an issue that caused the index service to reach its quota with very few indexed items. |
|
Fixed an issue to enable creating secondary indexes on binary documents on meta.id(), meta.cas(), and meta.expiration(). |
|
The DCP noop interval has been lowered to 20sec to improve the chances of the projector receiving the noop message early and thus avoiding frequent roll backs. |
|
Improved the DCP rollback handling mechanism. Instead of ignoring the disk snapshots before rolling back, the index service will now exhaust trying DCP stream requests with all the disk snapshots before rolling back to 0. |
|
Plasma memory tuner will now increment indexer memory quota only if the indexer process' RSS is below the memory quota. |
|
In a cluster with duplicate index names across buckets, replica repair failed after a node was added back to the cluster. This has been fixed. |
Query Service
Issue | Description |
---|---|
Fixed an issue with connection pool leak that caused queries to fail. |
Security
Issue | Description |
---|---|
The builtin Administrator user can now be authenticated via a client certificate. |
Tools, Web Console (UI) and REST API
Issue | Description |
---|---|
The couchbase-cli setting-alert man page has been updated to include the alert-communication-issue flag. |
|
The cbbackupmgr backup --resume incorrectly required full administrator privileges. This has been fixed so that any user with back and restore permissions can also resume a backup. |
|
The |
|
Fixed an issue where the |
|
Fixed an issue where |
Release 5.5.3
Couchbase Server 5.5.3, released in December 2018, is the third maintenance release in the 5.5.x series for Couchbase Server. This maintenance release includes fixes to the data, index, and query services, and install, XDCR and UI components.
Fixed Issues
Cross Datacenter Replication (XDCR)
Issue | Description |
---|---|
Fixed an issue where encrypted XDCR was incorrectly using port 8091. |
|
The unit of interval for XmemSelfMonitorInterval was incorrectly set to millisecond instead of second, causing an increase in the frequency of Xmem self monitor and the spurious |
|
Improve XDCR connection management to prevent XDCR replication getting stuck while creating a checkpoint. |
Data Service
Issue | Description |
---|---|
If one or more Ephemeral buckets were present, then nonIO background tasks could be incorrectly scheduled, potentially resulting in DCP connection instability (premature disconnection). This has been fixed. |
|
In some cases, the memory allocation failures were not handled causing "Write Commit Failure" errors or corruption in vBucket files. |
|
When data corruption is detected on a data service node, relevant information that can help troubleshoot is now being logged. |
|
Fixed an issue where appending to a document reset the expiration value to 0, disabling TTL expiry. |
|
When IPv6 was enabled, Couchbase Server incorrectly used ports that were outside of the known port range. When firewall rules are in place, requiring the ports to be explicitly whitelisted, this blocked nodes from being added to a cluster. |
|
The data service engine may not send STREAM_END message to consumers if non-infinity end sequence number and cursor dropping occurs. This could cause clients such as cbbackupmgr to hang indefinitely. |
Index Service
Issue | Description |
---|---|
An error is seen during a SUM aggregate pushdown when the entry value is greater than MaxInt64. |
|
Fixed an issue so that you can now create secondary indexes on binary documents on meta.id(), meta.cas(), and meta.expiration(). |
|
The index service crashed if the data bucket was flushed while the initial index was being built. |
Install and Upgrade
Issue | Description |
---|---|
On Windows platform, the missing data file (icudtl.dat) caused errors in the Views engine and Eventing service. The data file has been restored. |
Query Service
Issue | Description |
---|---|
Fixed a race condition caused by the intersect scan incorrectly interpreting the end of a scan as having already processed all the keys from that scan. |
|
Fixed an issue where the query engine threw an error if the query referenced extended attributes and the result contained non-existent keys. |
|
Following a cluster upgrade to version 5.5, the query service failed to retrieve extended attributes from a bucket when the query was run for the first time due to stale connections. This has been fixed to check and establish new working connections before executing a query following an upgrade. |
|
Fixed an issue where the TRUE predicate was handled incorrectly in the WHERE clause causing incorrect results. |
Tools, Web Console (UI) and REST API
Issue | Description |
---|---|
Fixed an issue where the Views UI was unable to process the "undefined" value in a binary JSON document. |
|
All requests originating from the UI were authenticated using token based authentication, even when client certificate authentication is enabled on the Server and a client certificate is configured in the browser. This has been fixed to use client certificates for authentication in such scenarios. |
|
The cbbackupmgr utility would hang and not return an error when trying to backup a cluster in which at least one node was down and had not failed over. |
Release 5.5.2
Couchbase Server 5.5.2, released in October 2018, is the second maintenance release in the 5.5.x series for Couchbase Server. This maintenance release includes fixes to the index and query services, XDCR, and installer components.
Fixed Issues
Data Service
Issue | Description |
---|---|
Authenticated users with full administrative privileges were able to access the diagnostic endpoint, Note that the |
Cross Datacenter Replication (XDCR)
Issue | Description |
---|---|
Fixed an issue where replication from version 4.5.x to version 5.5.x caused corruption on deleted documents leading to inability to rebalance. |
Index Service
Issue | Description |
---|---|
In previous releases, the memory consumption of the index service could exceed the index service’s RAM quota setting. This caused problems when the quota was set to an amount that was close to the physical RAM on the Server node, for example this could lead to an out of memory error. This issue has been fixed. |
|
After a rebalance, the index service was stuck waiting for Memcached. This has been fixed by adding a timeout mechanism so the index service does not hang. |
|
Fixed an issue where the index service threw an error if an index was dropped when index mutation was ongoing. |
|
The authentication requests from projector to Memcached now have a fixed timeout to avoid infinite wait time. |
Install and Upgrade
Issue | Description |
---|---|
Fixed an issue where in-place (offline) upgrades to Couchbase Server on Windows from 5.0.x or 5.1.x to later releases failed. |
Query Service
Issue | Description |
---|---|
A race condition was observed when deleting a system bucket if the bucket was in use by a system bucket scan. This is a rare condition where the wrong unlock was used when the scan resumed after the delete operation completed. |
|
When establishing connections, the cbq-engine would hang if the data node did not respond when trying to establish a handshake packet exchange with the data node. This has been fixed and the cbq-engine now throws an error if the connection cannot be established. |
|
An empty array in the index scan caused incorrect results. This was observed when the scan_cap parameter was set to a small number (say 2) and thus, backfill was used. |
|
Fixed an issue where an empty array from index scan did not work as expected when backfill was used. |
Release 5.5.1
Couchbase Server 5.5.1, released in August 2018, is the first maintenance release in the 5.5.x series for Couchbase Server.
Fixed Issues
Data Service
Issue | Description |
---|---|
Fixed an issue where the logs collected from the UI did not use the same salt across all nodes even though they were collected at the same time. |
|
Fixed an issue where the Memcached process was unable to start if IPv6 protocol stack was disabled. |
Index Service
Issue | Description |
---|---|
During warmup, one of the indexes with low number of items triggered an issue and caused the internal garbage collector to run forever. Thus causing the entire index service to stall during warmup. This issue was observed when using Plasma storage engine. |
|
Fixed an issue where the index service crashed with a "slice bounds out of range" error. |
|
Fixed an issue where upgrading from 4.x to 5.x version of Couchbase Server caused an outage for GSI standard indexes. This was observed during rolling upgrade from ForestDB to Plasma. When the last ForestDB index service node was taken out of the cluster, the cluster compatibility mode changed to Plasma and the index service restarted. |
Installation
Issue | Description |
---|---|
Uninstalling Couchbase Server on a Debian-based systemd distribution such as Ubuntu 16 using "apt-get remove" and then running "systemctl status couchbase-server" reported that the service still exists but is "masked". This means the service was explicitly disabled in such a way that it could not be started, automatically or by hand. As a result, subsequent installations of any version of Couchbase Server failed as the service was rendered unstartable. |
Tools, Web Console (UI) and REST API
Issue | Description |
---|---|
Fixed an issue where an unexpected token error was seen when accessing the Web Console in Couchbase Server version 5.5.0. |
|
Fixed an issue where the warning message on the Web Console showed an incorrect flag for the removal of dedicated bucket port as |
Release 5.5.0
Couchbase Server 5.5.0 was released in July 2018.
Major Behavior Changes
Issue | Description |
---|---|
The default number of Data Service worker threads has been increased; from 3/4 of the number of available CPU threads, to 7/8 of the number of available CPU threads (minimum of 4 in both cases). This makes better use of the available CPU resource, particularly on larger systems, as such users may see an increase in CPU utilization on such systems. |
|
The permissions assigned to the cluster_admin role have been downgraded. As a result, The cluster_admin role no longer has FTS write permissions used to create FTS searches. Workaround: Add the fts_admin role as required. |
|
Prior to 5.5, the In 5.5, the definition of request start has been changed to be when the header and body have both been read. This has the effect of more accurately reflecting the time spent by the Data Service in servicing a request, as the time the body spends in transit over the network is no longer included. As a result command timings for affected request will have shorter durations compared to how they were measured before 5.5. |
|
The Couchbase Server 5.5 Windows installer package no longer bundles the DLL dbghelp.dll which is required by Breakpad to produce dumps on Windows platforms. Starting version 5.5, Breakpad will pick the DLL (dbghelp.dll) that is shipped with the OS. |
New Supported Platforms
This release adds support for the Debian 9 platform. See Supported Platforms for the complete list of supported platforms.
Deprecated Features and Platforms
The following functionality is deprecated, will be deprecated or is unsupported.
-
Server side Moxi or buckets with custom server side Moxi ports are deprecated and may be removed from the product in the future.
-
The ability to create a bucket with a Moxi port has been deprecated. The CLI commands have been updated to remove Moxi ports for bucket create and bucket edit operations.
Known Issues
Administration/Cluster Management
Issue | Description |
---|---|
Summary: Performance issues may be observed when running Couchbase Server on CentOS 7.3 with kernel 3.10.0-514.6. |
|
Summary: On an undersized node, the default memory quota assigned to all the selected services by the server might result in a failure. Workaround: Adjust the memory allocations appropriately to work around this issue. |
Data Service
Issue | Description |
---|---|
Summary: Memcached process unable to start if IPv6 protocol stack has been disabled. Workaround: There are two generally accepted methods to disable IPv6 on recent Linux distributions:
Only the first method to disable IPv6 will cause Memcached to not start correctly. As a workaround you can disable IPv6 using the second method instead. |
|
Summary: The data node is in a pending state after memcached crashes. |
|
Summary: The |
|
Summary: Couchbase Server can get into a livelock state due to high checkpoint memory usage. |
|
Summary: When bucket-level expiry is enabled and the bucket(max) TTL is set to more than 30 days, then it uses an expiry offset based from when the Data Service is started, instead of an offset based from the current time. This can result in documents that use the bucket TTL being expired prematurely. |
Eventing Service
Issue | Description |
---|---|
Summary: The |
|
Summary: The debugger is unable to apply the source map generated by the transpiler. A recent update in the Chrome browser version 66.0.3359.181 is causing this issue. Since Google doesn’t allow previous versions of Chrome to be downloaded, you can download previous versions of Chromium. The debugger works fine with source maps on Chromium version 63.0.3239.0. Note: Our fix for Chromium is tagged to 69.0.3466.0~157. As per the Chrome release calendar, 69.x is set to release on September 4th 2018. The fix has been merged to Chrome Canary and is available at https://www.google.com/chrome/browser/canary.html |
|
Summary: Multiple mutations are observed for a single document update when using Sync Gateway, leading to the OnUpdate handler being triggered multiple times. |
|
Summary: The eventing service may mark redacted data incorrectly. |
|
Summary: When a rebalance is in progress the Eventing service hangs when memcached is killed on data and eventing nodes. |
|
Summary: The Eventing service currently does not provide the ability to specify a port range. Instead, the OS arbitrarily allocates a port for the Chrome Debugger. |
|
Summary: The eventing service misses some mutations with non-default vBuckets (535,1001 etc). |
|
Summary: The eventing service rebalance progress jumps from 24% to Finish. |
|
Summary: The |
|
Summary: When there are multiple functions being deployed, undeployment does not happen until all functions are deployed. |
|
Summary: Benign panics can be seen in the eventing service logs during undeployment. |
Full-text Search Service
Issue | Description |
---|---|
Summary: In some circumstances, the Search engine uses more memory than its defined quota. |
|
Summary: The memory usage during index build overshoots the RAM quota. |
|
Summary: Scorch indexes were found to contain duplicate pindexes. |
|
Summary: On Windows platform, a very high memory/CPU usage may be observed when search service is indexing. |
Indexing Service
Issue | Description |
---|---|
Summary: An error is seen during a SUM aggregate pushdown when the entry value is greater than MaxInt64. |
|
Summary: The rebalance progress in percentage during GSI swap rebalance doesn’t always increase linearly. |
|
Summary: Rebalance fails when taking out failed over nodes running views, in certain circumstances. |
Install and Upgrade
Issue | Description |
---|---|
Summary: Upgrading from 4.x to 5.x version of Couchbase Server causes an outage for GSI standard indexes. This is observed during rolling upgrade from ForestDB to Plasma. When the last ForestDB index service node is taken out of the cluster, the cluster compatibility mode changes to Plasma and index service restarts. |
|
Summary: In-place (offline) upgrades Server on Windows from 5.0.x or 5.1.x to later releases will fail. Workaround: Manually uninstall 5.0.x / 5.1.x from your Windows machines prior to installing 5.5.0 or later Server releases. |
Query Service
Issue | Description |
---|---|
Summary: Large numeric values are reported incorrectly. For example, the modulo operation or a scan for min int64 value returns an incorrect result in case of int64. |
Security
Issue | Description |
---|---|
Summary: The default "administrator" user doesn’t show up in list of local users displayed on the Web Console under the Security -> Users tab. |
Tools, Web Console (UI), and REST API
Issue | Description |
---|---|
Summary: The UI displays an incorrect flag in the warning message about the removal of dedicated port for a bucket.
It displays |
Analytics Service (Developer Preview)
Issue | Description |
---|---|
Summary: It is possible for a CONNECT BUCKET statement to fail temporarily with the error message " Workaround: Retry the operation. |
|
Summary: The Analytics stats for failed record count was incorrect. |
|
Summary: The UNION ALL operation does not work for all query types. For example, a query of the form shown below is not parsed correctly. (SELECT ... FROM ... WHERE ...) UNION ALL (SELECT ... FROM ... WHERE ...) Workaround: Remove the parentheses around the first subquery block. SELECT ... FROM ... WHERE ... UNION ALL (SELECT ... FROM ... WHERE ...) |
Fixed Issues
Data Service
Issue | Description |
---|---|
Couchbase Server could get into a livelock state due to high checkpoint memory usage. |
|
There were a number of issues in Couchbase Server which caused rebalance to fail from time to time. These have been fixed. |
|
Rebalance failed with an "Invalid Format specified for DCP_DELETION" error when data or eventing nodes were swapped in and out of a cluster. |
|
The index service went through a race condition in the storage engine which led to a crash. The crash was most likely to happen if the index service was restarted with existing build indexes and they continued to process mutations after the index service restarted. |
|
The full-text search service repeatedly attempted to setup DCP streams to non-existing vBuckets. |
Eventing Service
Issue | Description |
---|---|
The Eventing service did not retry bucket operation failures that were determined by the appropriate LCB macro to be retriable. |
|
Rebalance of KV/Eventing nodes can hang if the cluster contains Eventing nodes due to stale authentication info with the GoCB SDK. |
|
Rebalance of data or eventing nodes would hang if the cluster contained Eventing nodes. |
|
If the handler code was not idempotent, the destination bucket contained more docs than expected after a rebalance. |
|
On Windows, orphan processes with .rbf extension were found to be running even after uninstalling Couchbase Server. |
|
Under some circumstances, like a function undergoing bootstrap or buckets referenced by the function (source, metadata, destination) get flushed or deleted, the function could not be undeployed. |
|
After restoring from an enterprise backup of eventing functions, eventing service would not process mutations in the destination cluster. |
|
Deployment fails if the size of the handler code is greater than 1MB. |
|
Redeploying a function resulted in the application log being truncated instead of appending to the existing log. |
|
The Eventing service can crash when processing documents in source buckets with size is greater than 1 MB. |
|
Failed rebalance, when retried, could hang. |
|
Rebalance-in of a data(KV) node after recovery from failover may hang if eventing service is processing mutations. |
Index Service
Issue | Description |
---|---|
Rebalance would hang during index service rebalance. |
|
If the index files were corrupted, the index service would continue to crash and required a failover or a manual deletion of the corrupted index files to recover. |
Query Service
Issue | Description |
---|---|
The array indexing plan incorrectly included filter covers. |
|
Fixed an issue on Windows platform where a query with more than 1000 characters could be pasted into the cbq shell only the up to 3 times. Subsequent paste operations resulted in a partial query being pasted. |
|
Fixed an issue where the ORDER BY operator proceeded to sort even after being stopped and could lead to crashes. |
Tools, Web Console (UI), and REST API
Issue | Description |
---|---|
The logic to confirm unsafe stop rebalance operation on the Web Console has been resurrected. |
|
|
|
The |
Analytics Service (Developer Preview)
Issue | Description |
---|---|
It was possible for a rebalance of the Analytics nodes to always fail if:
In that case a common DCP state (required for rebalancing) could not be achieved as no new DCP mutations were received by the Analytics nodes. |