Skip to content

XDCR - Add a new parameter genericServicesLogLevel to Global Settings for 7.6 #3900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: release/7.6
Choose a base branch
from
Open

XDCR - Add a new parameter genericServicesLogLevel to Global Settings for 7.6 #3900

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 84 additions & 1 deletion modules/rest-api/pages/rest-xdcr-adv-settings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,27 @@ If successful, the call returns an object similar to the following:

----
{
"casDriftThresholdSecs": 100,
"cLogConnPoolGCIntervalMs": 60000,
"cLogConnPoolLimit": 30,
"cLogConnPoolReapIntervalMs": 120000,
"cLogErrorTimeWindowMs": 120000,
"cLogMaxErrorCount": 10,
"cLogNetworkRetryCount": 5,
"cLogNetworkRetryIntervalMs": 2000,
"cLogPoolGetTimeoutMs": 5000,
"cLogQueueCapacity": 6000,
"cLogReattemptDurationMs": 600000,
"cLogSetTimeoutMs": 5000,
"cLogWorkerCount": 20,
"casDriftThresholdSecs": 3900,
"checkpointInterval": 600,
"ckptSvcCacheEnabled": true,
"collectionsOSOMode": true,
"compressionType": "Auto",
"conflictLogging": {},
"dcpEnablePurgeRollback": false,
"desiredLatency": 50,
"disableHlvBasedShortCircuit": false,
"docBatchSizeKb": 2048,
"failureRestartInterval": 10,
"filterBinary": false,
Expand Down Expand Up @@ -128,6 +142,7 @@ If successful, the call returns an object similar to the following:
"retryOnRemoteAuthErrMaxWaitSec": 360,
"skipReplSpecAutoGc": false,
"sourceNozzlePerNode": 2,
"targetTopologyLogFrequency": 1800,
"statsInterval": 1000,
"targetNozzlePerNode": 2,
"targetTopologyLogFrequency": 1800,
Expand Down Expand Up @@ -331,6 +346,60 @@ curl -X POST -u Administrator:password http://localhost:8091/<settings_URI> -d m

For information about _XDCR with Sync Gateway mobile clusters in a bi-directional, active-active replication_, see xref:learn:clusters-and-availability/xdcr-active-active-sgw.adoc[XDCR Active-Active with Sync Gateway].

===== Change Settings for XDCR Generic Services Log Levels

The following example modifies the log levels for XDCR Generic Services, for a specific replication.
Usually, you modify the log levels only when requested by Couchbase Support.

----
curl -X POST -u Administrator:password http://localhost:8091/settings/replications -d 'genericServicesLogLevel={"RemoteClusterService":"Debug","ReplicationSpecService":"Error","BucketTopologyService":"Debug","CheckpointService":"Error"}'
----

If successful, the call returns an object containing all current Generic Services related log level settings for the replication, including what's changed:

----
{
...
"genericServicesLogLevel": {
"AdminPort": "Info",
"AuditService": "Info",
"BackfillManager": "Info",
"BackfillReplicationService": "Info",
"BucketTopologyService": "Debug",
"CapiService": "Info",
"CheckpointService": "Error",
"CollectionsManifestService": "Info",
"Default": "Info",
"GenericSupervisor": "Info",
"GlobalSettingsService": "Info",
"HttpServer": "Info",
"InternalSettingsService": "Info",
"ManifestService": "Info",
"MessageUtils": "Info",
"MetaKVMetadataService": "Info",
"MigrationService": "Info",
"P2PManagerService": "Info",
"PipelineManager": "Info",
"RemoteClusterService": "Debug",
"ReplicationSettingService": "Info",
"ReplicationSpecService": "Error",
"ResourceManager": "Info",
"SecurityService": "Info",
"ThroughputThrottlerService": "Info",
"TopologyService": "Info",
"UtilsService": "Info",
"XDCRFactory": "Info"
},
...
}
----

To view the current log levels for XDCR Generic Services anytime, use the following command:

----
curl -s -X GET -u Administrator:password http://localhost:8091/settings/replications | jq
----

[#xdcr-advanced-settings-rest]
== List of Advanced Settings

Expand Down Expand Up @@ -445,6 +514,20 @@ For supported expressions, see xref:xdcr-reference:xdcr-filtering-reference-intr

This setting can only be established for and retrieved from an individual replication: it cannot be established or retrieved as part of global settings.

| `genericServicesLogLevel`
| JSON Object
| This is the Generic Services related log level settings for the replication.

The keys represent service names and the associated values represent log levels.

In the example, the log level for `RemoteClusterService` is set to `Debug`, and for `ReplicationSpecService`, it's set to `Error`.

By default, non-pipeline specific services use the `Info` log level.
You can also set the log level to `Error`, `Debug`, or `Trace`.

The `Default` key sets the log level for shared utilities like connection pools and data pools, which are used by multiple services.
All these utilities use the same default logger, so changing the log level in `Default` affects all logger dependent utilities.

| `goGC`
| Integer (0 to 100) or String ("off")
| Default: 100.
Expand Down