Couchbase Analytics Service Configuration Parameters

The configuration parameters for Analytics are volatile in the Developer Preview. They may change significantly in the future.

Couchbase Analytics Service has a number of configuration settings to customize the cluster for its environment.

For the configuration changes to take effect, the Analytics cluster must be restarted using the Restart API.

The following parameters can be used with the Cluster Controller Configuration API to configure the Analytics Service cluster controller.

Parameter Description Default

analyticsHttpRequestQueueSize

The maximum number of HTTP requests to queue pending ability to execute

256

analyticsHttpThreadCount

The number of threads to service HTTP requests

16

coresMultiplier

The factor to multiply by the number of cores to determine maximum query concurrent execution level

3

enforceFrameWriterProtocol

A flag indicating if runtime should enforce frame writer protocol and detect bad behaving operators

false

heartbeatMaxMisses

Sets the maximum number of missed heartbeats before a node is marked as dead

4

heartbeatPeriod

Sets the time duration between two heartbeats from each node controller in milliseconds

30000

jobHistorySize

Limits the number of historical jobs remembered by the system to the specified value

10

jobQueueCapacity

The maximum number of jobs to queue before rejecting new jobs

4096

profileDumpPeriod

Sets the time duration between two profile dumps from each node controller in milliseconds; 0 to disable

0

resultSweepThreshold

The duration within which an instance of the result cleanup should be invoked in milliseconds

60000

resultTtl

Limits the amount of time results for asynchronous jobs should be retained by the system in milliseconds

86400000

The following parameters can be used with the Node Configuration API to configure the Analytics Service nodes.

Parameter Description Default

activeMemoryGlobalBudget

The memory budget (in bytes) for the active runtime

67108864 (64 MB)

analyticsHttpRequestQueueSize

The maximum number of HTTP requests to queue pending ability to execute

256

analyticsHttpThreadCount

The number of threads to service HTTP requests

16

clusterConnectRetries

Number of attempts to contact CC before giving up

5

compilerFramesize

The page size (in bytes) for computation

32768 (32 kB)

compilerGroupmemory

The memory budget (in bytes) for a group by operator instance in a partition

33554432 (32 MB)

compilerJoinmemory

The memory budget (in bytes) for a join operator instance in a partition

33554432 (32 MB)

compilerParallelism

The degree of parallelism for query execution. Zero means to use the storage parallelism as the query execution parallelism, while other integer values dictate the number of query execution parallel partitions. The system will fall back to use the number of all available CPU cores in the cluster as the degree of parallelism if the number set by a user is too large or too small

0

compilerSortmemory

The memory budget (in bytes) for a sort operator instance in a partition

33554432 (32 MB)

iodevices (read-only)

Comma separated list of IO Device mount points

<data dir>/@analytics/iodevice

jvmArgs

JVM args to pass to the NCDriver

<undefined>

logLevel

The logging level

INFO

maxWaitActiveCluster

The max pending time (in seconds) for cluster startup. After the threshold, if the cluster still is not up and running, it is considered unavailable

60

messagingFrameCount

Number of reusable frames for NC to NC messaging

512

messagingFrameSize

The frame size to be used for NC to NC messaging

4096 (4 kB)

metadataRegistrationTimeoutSecs

how long in seconds to wait for the metadata node to register with the CC

60

netBufferCount

Number of network buffers per input/output channel

1

netThreadCount

Number of threads to use for Network I/O

1

resultManagerMemory

Memory usable for result caching at this Node Controller in bytes

-1 (-1 B)

resultSweepThreshold

The duration within which an instance of the result cleanup should be invoked in milliseconds

60000

resultTtl

Limits the amount of time results for asynchronous jobs should be retained by the system in milliseconds

86400000

storageBuffercacheMaxopenfiles

The maximum number of open files in the buffer cache

2147483647

storageBuffercachePagesize

The page size in bytes for pages in the buffer cache

131072 (128 kB)

storageBuffercacheSize

The size of memory allocated to the disk buffer cache. The value should be a multiple of the buffer cache page size.

1/4 of the allocated Analytics Service memory

storageLsmBloomfilterFalsepositiverate

The maximum acceptable false positive rate for bloom filters associated with LSM indexes

0.01

storageMaxActiveWritableDatasets

The maximum number of datasets that can be concurrently modified

8

storageMemorycomponentGlobalbudget

The size of memory allocated to the memory components. The value should be a multiple of the memory component page size

1/4 of the allocated Analytics Service memory

storageMemorycomponentNumcomponents

The number of memory components to be used per lsm index

2

storageMemorycomponentPagesize

The page size in bytes for pages allocated to memory components

131072 (128 kB)

storageMetadataMemorycomponentNumpages

The number of pages to allocate for a metadata memory component

8