A Couchbase profile is used to read and write bucket data in a Couchbase database and can be accessed by workflows using Aggregation, Distributed Storage, or PCC. The profile should not be used to operate on data that has been inserted or updated by external third-party software.
...
| Note | ||
|---|---|---|
| ||
Created or updated Couchbase profiles that are used for PCC do not become effective until you restart the EC/ECSAs. |
Configuration
To create a new Couchbase profile, click on the New Configuration button in the upper left part of the Desktop window, and then select Couchbase Profile from the menu.
...
In a Couchbase profile, there are three tabs: Connectivity, Management, and Advanced.
Connectivity Tab
The Connectivity tab is displayed by default.
...
The Bucket Configuration settings are different depending on if you select Couchbase Release 5.x - 6.x or 4.x.
Couchbase Release 5.x - 6.x
The following settings are available in the Connectivity tab:
...
| Setting | Description | |||||
|---|---|---|---|---|---|---|
| Couchbase Release | Choose between Couchbase release 5.x - 6.x and 4.x. For information on the settings when you choose 4.x, see the section below, Couchbase Release 4.x. | |||||
Bucket Name | Enter the bucket that you want to access in Couchbase in this field. | |||||
| Bucket User | Enter the user who has access rights to the bucket. | |||||
User Password | Enter the password for the user who has access to the bucket.
| |||||
Operation Timeout (ms) | Enter the number of milliseconds after which you want Couchbase "CRUD" operations, i e create, read, update, and delete, to timeout. Setting a lower value than the default 1000 ms may have a positive impact on throughput performance. However, if the value is set too low, indicated by a large number of operation timeouts errors in the EC/ECSA logs, a lower throughput can be expected. | |||||
Retry Interval Time (ms) | Enter the time interval, in milliseconds, that you want to wait before trying to read the cluster configuration again after a failed attempt. | |||||
Max Number Of Retries | Enter the maximum number of retries. | |||||
Cluster Nodes | In this section, add IP addresses/hostnames of at least one of the nodes in the cluster. This address information is used by the Couchbase profile to connect to the cluster at workflow start, and to retrieve the IP addresses of the other nodes in the cluster. If the first node in the list cannot be accessed, the Couchbase profile will attempt to connect to the next one in order. This is repeated until a successful connection can be established. Hence it is not necessary to add all the nodes, but it is good practice to do so for a small cluster. For example, if there are just three nodes, you should add all of them. |
Couchbase Release 4.x
Couchbase profile - Connectivity tab for Couchbase Release 4.x
...
| Setting | Description |
|---|---|
| Couchbase Release | Choose between Couchbase release 5.x - 6.x and 4.x. For information on the settings in the configuration when you choose 5.x - 6.x, see the section above, Couchbase Release 5.x - 6.x. |
Bucket Name | Enter the bucket that you want to access in Couchbase in this field. |
| Bucket Password | Enter an optional password for the bucket in this field. |
Operation Timeout (ms) | Enter the number of milliseconds after which you want Couchbase "CRUD" operations, i e create, read, update, and delete, to timeout. Setting a lower value than the default 1000 ms may have a positive impact on throughput performance. However, if the value is set too low, indicated by a large number of operation timeouts errors in the EC/ECSA logs, a lower throughput can be expected. |
Retry Interval Time (ms) | Enter the time interval, in milliseconds, that you want to wait before trying to read the cluster configuration again after a failed attempt. |
Max Number Of Retries | Enter the maximum number of retries. |
Cluster Nodes | In this section, add IP addresses/hostnames of at least one of the nodes in the cluster. This address information is used by the Couchbase profile to connect to the cluster at workflow start, and to retrieve the IP addresses of the other nodes in the cluster. If the first node in the list cannot be accessed, the Couchbase profile will attempt to connect to the next one in order. This is repeated until a successful connection can be established. Hence it is not necessary to add all the nodes, but it is good practice to do so for a small cluster. For example, if there are just three nodes, you should add all of them. |
Management Tab
In the Management tab which contains the user name, password, size and monitoring settings.
...
| Setting | Description |
|---|---|
Admin User Name | If you want to create a new bucket that does not exist in your Couchbase cluster, enter the user name that you stated when installing Couchbase in this field. |
Admin Password | If you want to create a new bucket that does not exist in your Couchbase cluster, enter the password that you stated when installing Couchbase in this field. |
Bucket Size (MB) | Enter the the size of the bucket you want to create. |
Number of Replicas | Enter the number of replicas you want to have. |
Monitoring - Active | Obsolete |
Frequency (ms) | Obsolete |
Failure Count | Obsolete |
| Note | ||
|---|---|---|
| ||
The Couchbase monitoring has become obsolete. Refer to Important Information to find out more. |
If the bucket that you specify in the Couchbase profile does not exist, it is created in runtime, i e when accessed in a workflow. This is provided that Admin User Name and Admin Password have been stated in the Management tab. If the bucket you want to access already exists, these two fields do not have to be completed.
Advanced Tab
In the Advanced tab you can configure additional properties.
...
See the text in the Properties field for further information about the properties that you can set.
Logging Couchbase Statistics
You can use the property mz.cb.statistics.class if you want to log Couchbase statistics. The default value is com.digitalroute.mimexposer.statistics.NoDbStatistics. To enable this property, set the value to com.digitalroute.mimexposer.statistics.MemDbStatistics or com.digitalroute.mimexposer.statistics.FileDbStatistics.
If you set the property value to com.digitalroute.mimexposer.statistics.MemDbStatistics, you can use the MIM agent to send statistics to System Insight. To do this, you must configure a workflow with a MIM agent. For further information, see 9.7678.6 MIM Agent.
If you set the property value to com.digitalroute.mimexposer.statistics.FileDbStatistics, you can use the MIM agent to send statistics to System Insight or you can log to file. If you want to log to file only, you do not require the MIM agent. The log file is stored in $MZ_HOME/log per bucket, for example <bucket name>_couchbase_stats.log, and the file is flushed every 60 seconds by default. If you want to modify how often the file is flushed, set the property mz.cb.statistics.flush.period.in.seconds with the required value in the EC.
...