Skip to content

Commit d406290

Browse files
authored
DOC-12456 genericServicesLogLevel settings for XDCR (#3840)
* non-pipeline-services-settings * whats-new-entry * implemented-editorial-inputs
1 parent ba805f0 commit d406290

File tree

2 files changed

+98
-6
lines changed

2 files changed

+98
-6
lines changed

modules/introduction/partials/new-features-80.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,9 @@ Additional information sent by clients at connection time can be found in the lo
120120
https://jira.issues.couchbase.com/browse/MB-61048[MB-61048]::
121121
Once faulty remote cluster credentials are fixed, XDCR will now be able to more quickly restart replications that depend on the repaired references.
122122
123-
https://jira.issues.couchbase.com/browse/MB-62639[MB-62639]::
124-
XDCR UI supports network type for connecting to the target cluster.
125-
The options are Auto, Force using alternate address, and Force using internal address.
126-
For more information, see xref:manage:manage-xdcr/create-xdcr-reference.adoc#create-an-xdcr-reference-with-the-ui[Create an XDCR Reference with the UI].
123+
https://jira.issues.couchbase.com/browse/MB-62507[MB-62507]::
124+
XDCR supports Generic Services Log Level configuration using the REST API through the `genericServicesLogLevel` settings.
125+
For more information, see xref:rest-api:rest-xdcr-adv-settings.adoc[XDCR Advanced Settings].
127126
128127
[#section-new-feature-800-query-service]
129128
=== Query Service

modules/rest-api/pages/rest-xdcr-adv-settings.adoc

Lines changed: 95 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,32 +94,57 @@ If successful, the call returns an object similar to the following:
9494

9595
----
9696
{
97+
"cLogConnPoolGCIntervalMs": 60000,
98+
"cLogConnPoolLimit": 30,
99+
"cLogConnPoolReapIntervalMs": 120000,
100+
"cLogErrorTimeWindowMs": 120000,
101+
"cLogMaxErrorCount": 10,
102+
"cLogNetworkRetryCount": 5,
103+
"cLogNetworkRetryIntervalMs": 2000,
104+
"cLogPoolGetTimeoutMs": 5000,
105+
"cLogQueueCapacity": 6000,
106+
"cLogReattemptDurationMs": 600000,
107+
"cLogSetTimeoutMs": 5000,
108+
"cLogWorkerCount": 20,
109+
"casDriftThresholdSecs": 3900,
97110
"checkpointInterval": 600,
98111
"ckptSvcCacheEnabled": true,
112+
"collectionsOSOMode": true,
99113
"compressionType": "Auto",
114+
"conflictLogging": {},
115+
"dcpEnablePurgeRollback": false,
100116
"desiredLatency": 50,
117+
"disableHlvBasedShortCircuit": false,
101118
"docBatchSizeKb": 2048,
102119
"failureRestartInterval": 10,
120+
"filterBinary": false,
103121
"filterBypassExpiry": false,
104122
"filterBypassUncommittedTxn": false,
105123
"filterDeletion": false,
106124
"filterExpiration": false,
125+
"genericServicesLogLevel": {
126+
< ... diagnostic items cut out due to length ... >
127+
},
107128
"goGC": 100,
108129
"goMaxProcs": 4,
109-
"hlvPruningWindowSec": 259200,
110130
"jsFunctionTimeoutMs": 20000,
111131
"logLevel": "Info",
112132
"mergeFunctionMapping": {},
133+
"mobile": "Off",
113134
"networkUsageLimit": 0,
114135
"optimisticReplicationThreshold": 256,
136+
"preCheckCasDriftThresholdHours": 8760,
115137
"preReplicateVBMasterCheck": true,
116138
"priority": "High",
117139
"replicateCkptIntervalMin": 20,
140+
"retryOnErrExceptAuthErrMaxWaitSec": 360,
118141
"retryOnRemoteAuthErr": true,
119-
"retryOnRemoteAuthErrMaxWaitSec": 3600,
142+
"retryOnRemoteAuthErrMaxWaitSec": 360,
143+
"skipReplSpecAutoGc": false,
120144
"sourceNozzlePerNode": 2,
121145
"statsInterval": 1000,
122146
"targetNozzlePerNode": 2,
147+
"targetTopologyLogFrequency": 1800,
123148
"workerBatchSize": 500
124149
}
125150
----
@@ -295,6 +320,60 @@ If successful, the call returns an object containing all current settings for th
295320
}
296321
----
297322

323+
===== Change Settings for XDCR Generic Services Log Levels
324+
325+
The following example modifies the log levels for XDCR Generic Services, for a specific replication.
326+
Usually, you modify the log levels only when requested by Couchbase Support.
327+
328+
----
329+
curl -X POST -u Administrator:password http://localhost:8091/settings/replications -d 'genericServicesLogLevel={"RemoteClusterService":"Debug","ReplicationSpecService":"Error","BucketTopologyService":"Debug","CheckpointService":"Error"}'
330+
----
331+
332+
If successful, the call returns an object containing all current Generic Services related log level settings for the replication, including what's changed:
333+
334+
----
335+
{
336+
...
337+
"genericServicesLogLevel": {
338+
"AdminPort": "Info",
339+
"AuditService": "Info",
340+
"BackfillManager": "Info",
341+
"BackfillReplicationService": "Info",
342+
"BucketTopologyService": "Debug",
343+
"CapiService": "Info",
344+
"CheckpointService": "Error",
345+
"CollectionsManifestService": "Info",
346+
"Default": "Info",
347+
"GenericSupervisor": "Info",
348+
"GlobalSettingsService": "Info",
349+
"HttpServer": "Info",
350+
"InternalSettingsService": "Info",
351+
"ManifestService": "Info",
352+
"MessageUtils": "Info",
353+
"MetaKVMetadataService": "Info",
354+
"MigrationService": "Info",
355+
"P2PManagerService": "Info",
356+
"PipelineManager": "Info",
357+
"RemoteClusterService": "Debug",
358+
"ReplicationSettingService": "Info",
359+
"ReplicationSpecService": "Error",
360+
"ResourceManager": "Info",
361+
"SecurityService": "Info",
362+
"ThroughputThrottlerService": "Info",
363+
"TopologyService": "Info",
364+
"UtilsService": "Info",
365+
"XDCRFactory": "Info"
366+
},
367+
...
368+
}
369+
----
370+
371+
To view the current log levels for XDCR Generic Services anytime, use the following command:
372+
373+
----
374+
curl -s -X GET -u Administrator:password http://localhost:8091/settings/replications | jq
375+
----
376+
298377
[#xdcr-advanced-settings-rest]
299378
== List of Advanced Settings
300379

@@ -409,6 +488,20 @@ For supported expressions, see xref:xdcr-reference:xdcr-filtering-reference-intr
409488

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

491+
| `genericServicesLogLevel`
492+
| JSON Object
493+
| This is the Generic Services related log level settings for the replication.
494+
495+
The keys represent service names and the associated values represent log levels.
496+
497+
In the example, the log level for `RemoteClusterService` is set to `Debug`, and for `ReplicationSpecService`, it's set to `Error`.
498+
499+
By default, non-pipeline specific services use the `Info` log level.
500+
You can also set the log level to `Error`, `Debug`, or `Trace`.
501+
502+
The `Default` key sets the log level for shared utilities like connection pools and data pools, which are used by multiple services.
503+
All these utilities use the same default logger, so changing the log level in `Default` affects all logger dependent utilities.
504+
412505
| `goGC`
413506
| Integer (0 to 100) or String ("off")
414507
| Default: 100.

0 commit comments

Comments
 (0)