Analytics Configuration Parameters

    +

    The Couchbase Analytics Service has a number of configuration parameters to customize Analytics nodes. There are two categories of configuration parameters: service-level parameters and node-specific parameters.

    Service-Level Parameters

    Service-level parameters are applied to all nodes running the Analytics Service. These parameters can be used with the Service Configuration API to configure all Analytics Service nodes in the cluster.

    For the configuration changes to take effect, you must restart the Analytics cluster using the Cluster Restart API.
    Parameter Description Default

    activeMemoryGlobalBudget

    The memory budget (in bytes) for the active runtime.

    67108864 (64 MB)

    activeStopTimeout

    The maximum time (in seconds) to wait for a graceful stop of an active runtime.

    3600

    activeSuspendTimeout

    The maximum time (in seconds) to wait for a graceful suspend of an active runtime.

    3600

    analyticsBroadcastDcpStateMutationCount

    The number of processed mutations after which the DCP state is broadcast to storage

    10000

    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

    collectDcpStateFromNodesTimeout

    The maximum time to wait to collect DCP state from all nodes in seconds.

    600

    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

    compilerSortParallel

    Enabling/Disabling full parallel sort

    false

    compilerSortmemory

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

    33554432 (32 MB)

    compilerWindowmemory

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

    33554432 (32 MB)

    coresMultiplier

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

    3

    deadlockWatchdogHaltDelaySeconds

    The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, before halting.

    120

    deadlockWatchdogPollSeconds

    The frequency (in seconds) to scan for deadlocked threads.

    300

    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

    jvmArgs

    JVM args to pass to the Analytics Driver.

    <undefined> (null)

    logLevel

    The logging level.

    DEBUG

    maxWebRequestSize

    The maximum accepted web request size in bytes.

    52428800 (50 MB)

    netBufferCount

    Number of network buffers per input/output channel.

    1

    netThreadCount

    Number of threads to use for Network I/O.

    1

    rebalancePullDatasetSizeFrequency

    The frequency at which the dataset size is pulled from nodes during rebalance in seconds

    5

    requestsArchiveSize

    The maximum number of archived requests to maintain

    50

    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)

    storageCompressionBlock

    The default compression scheme for the storage

    snappy

    storageMaxActiveWritableDatasets

    The maximum number of datasets that can be concurrently modified.

    8

    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)

    threaddumpFrequencySeconds

    The frequency (in seconds) at which to log diagnostic thread dumps.

    300

    threaddumpLogLevel

    The log level at which to emit diagnostic thread dumps.

    DEBUG

    traceCategories

    Categories for tracing.

    [ ] (empty array — no categories)

    txnDatasetCheckpointInterval

    The interval (in seconds) after which a dataset is considered idle and persisted to disk

    3600

    Node-Specific Parameters

    The following parameters can be used with the Node Configuration API to configure the Analytics Service node that receives the change request.

    For the configuration changes to take effect, you must restart the node using the Node Restart API, or restart the Analytics cluster using the Cluster Restart API.
    Parameter Description Default

    jvmArgs

    JVM args to pass to the Analytics Driver. Node-specific JVM arguments are appended to service-level JVM arguments. If the same JVM argument appears in both the service-level arguments and the node-specific arguments, the node-specific argument takes priority.

    <undefined> (null)

    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

    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