Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions modules/ROOT/pages/_partials/_attributes-local.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,6 @@
:couchbase-tutorials--mobile-workshop--xref: {url-tutorial-mobile-workshop}[Couchbase Mobile Workshop]




:url-downloads-all: {url-cb-pfx}downloads
:downloads-all--xref: {url-downloads-all}[Get Started with Couchbase Today]
:url-downloads-mobile: {url-downloads-all}#extend-with-mobile
Expand Down
5 changes: 3 additions & 2 deletions modules/ROOT/pages/_partials/_page-index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ endif::xref--pfx-sgw[]
:configuration-properties-legacy--page: configuration-properties-legacy.adoc

:configuration-properties-legacy--pfx: {sgw--xref}{configuration-properties-legacy--page}
:configuration-properties-legacy--pfx--db: {sgw--xref}{configuration-properties-legacy--page}#databases
:configuration-properties-legacy--pfx--db: {configuration-properties-legacy--pfx}#databases
:configuration-properties-legacy--pfx--db-rep: {configuration-properties-legacy--pfx--db}-this_db-replications-this_rep-
:configuration-properties-legacy--pfx--eventhandlers: {configuration-properties-legacy--pfx--db}-this_db-event_handlers

Expand Down Expand Up @@ -763,12 +763,13 @@ endif::xref--pfx-sgw[]

:sync-inter-syncgateway-conflict-resolution--page: sync-inter-syncgateway-conflict-resolution.adoc
:sync-inter-syncgateway-conflict-resolution--xref: {sgw--xref}{sync-inter-syncgateway-conflict-resolution--page}[Inter Sync Gateway Sync - Conflict Resolution]
:sync-inter-syncgateway-conflict-resolution--custom-conflict-resolution: {sgw--xref}{sync-inter-syncgateway-conflict-resolution--page}#custom-conflict-resolution-ee[Inter Sync Gateway Sync - Custom Conflict Resolution]
:sync-inter-syncgateway-manage--page: sync-inter-syncgateway-manage.adoc
:sync-inter-syncgateway-manage--xref: {sgw--xref}{sync-inter-syncgateway-manage--page}[Inter Sync Gateway Sync - Manage]
:sync-inter-syncgateway-monitor--page: sync-inter-syncgateway-monitor.adoc
:sync-inter-syncgateway-monitor--xref: {sgw--xref}{sync-inter-syncgateway-monitor--page}[Inter Sync Gateway Sync - Monitor]
:sync-inter-syncgateway-overview--page: sync-inter-syncgateway-overview.adoc
:sync-inter-syncgateway-overview--xref: {sgw--xref}{sync-inter-syncgateway-overview--page}[Inter Sync Gateway Sync - Overview]
:sync-inter-syncgateway-overview--xref: {sgw--xref}{sync-inter-syncgateway-overview--page}[Inter Sync Gateway Sync - Overview]
:sync-inter-syncgateway-run--page: sync-inter-syncgateway-run.adoc
:sync-inter-syncgateway-run--xref: {sgw--xref}{sync-inter-syncgateway-run--page}[Inter Sync Gateway Sync - Run]

Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/_partials/incpg-icr-conflict.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ _Alternatively_: Run the replicator from the other side; flipping the direction
See also -- our blog post: {url-blog-doc-how-conflicts-work}
--

For {enterprise}, a custom conflict resolver policy is available, providing additional flexibility by allowing users to provide their own conflict resolution logic -- see: {xref-sgw-pg-icr-conflict-resolution-custom}.

For {enterprise}, a custom conflict resolver policy is available, providing additional flexibility by allowing users to provide their own conflict resolution logic -- see: {sync-inter-syncgateway-conflict-resolution--custom-conflict-resolution}{
// end::overview-full[]

[#configure-conflict-resolution]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ifdef::param-title[:this-title: {param-title}]
:title-5: Conflict

// Set the pages for the xrefs to link to (we are using attributes from _page-index.adoc here)
:topic-1: {sync-inter-syncgateway-overview--xref}
:topic-1: {sync-inter-syncgateway-overview--page}
:topic-2: {sync-inter-syncgateway-run--page}
:topic-3: {sync-inter-syncgateway-manage--page}
:topic-4: {sync-inter-syncgateway-monitor--page}
Expand Down
17 changes: 15 additions & 2 deletions modules/ROOT/pages/logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ include::partial$block-caveats.adoc[tags=logfilefolderuse]
// BEGIN Content
== Overview


Sync Gateway provides a robust <<lbl-continuous-logging>>{fn-clog} solution that delivers flexibility in terms of how logs are generated and retained, whilst also maintaining the level of logging required by Couchbase Support for investigation of issues.
Its logs are written to <<log-file-outputs, separate log files>> filtered by log level, with each log level supporting individual retention policies.
You control what is logged using the {configuration-schema-bootstrap--xref} {bootstrap-schema--xref--logging} properties
Expand All @@ -57,8 +58,10 @@ In addition to the log files, you can also independently configure and control <
With _console logging_, system administrators can easily fine-tune diagnostic output to suit specific debug scenarios.
All without interfering with the logging required by Couchbase Support for the investigation of issues.


== Configuration


You configure _continuous_ and _console_ logging requirements in the {configuration-schema-bootstrap--xref} file, using the {bootstrap-schema--xref--logging} properties {fn-legacy-pre-3-0} -- see: <<sample-log-cfg>>.

[#sample-log-cfg]
Expand Down Expand Up @@ -109,14 +112,20 @@ You configure _continuous_ and _console_ logging requirements in the {configurat
See: {configuration-schema-bootstrap--xref} for more information on these settings {fnref-legacy-pre-3-0}.
====


[#lbl-log-redaction]
== Log Redaction


All log outputs -- _console_ or _continuous_ -- can optionally be redacted, which will remove any user-data considered private.

You enable this feature by setting the {bootstrap-schema--xref--logging-redaction-level} property {fnref-legacy-pre-3-0}.


[#lbl-console-logs]
== Console Logging


*In this section*: <<lbl-log-levels>> | <<lbl-log-api>> | <<lbl-log-keys>> | <<lbl-log-color>> | <<lbl-log-redirect>>

TIP: By default only HTTP logging is enabled
Expand Down Expand Up @@ -153,7 +162,7 @@ The console log will show the following after this command:
2021-01-08T13:26:23.884Z [INF] HTTP: #110: POST /_logging?logLevel=trace (as ADMIN)
2021-01-08T13:26:23.885Z [INF] Setting log level to: trace
2021-01-08T13:26:23.885Z [INF] Setting log keys to: [DCP Replicate WS WSFrame]
---
----

====

Expand Down Expand Up @@ -222,9 +231,11 @@ a|This wildcard log key, enables all log keys

[source, console]
----

curl --location --request PUT 'http://localhost:4985/_logging?logLevel=trace' \
--header 'Content-Type: application/json' \
--data-raw '{"*": true}'

----

|none
Expand Down Expand Up @@ -334,6 +345,8 @@ logcollector my_sg_logs.txt

[#lbl-continuous-logging]
== Continuous Logging


*In this section*: <<lbl-logoutputs>> | <<lbl-logrotate>>

_Continuous logging_ produces a set of log files aimed primarily at providing appropriate diagnostic information for the Couchbase Support team should their intervention be required.
Expand Down Expand Up @@ -392,7 +405,7 @@ h|Minimum max_age
|1 Day
|===

TIP: Each log level and its parameters are defined using the (xref-sgw-bmk-config-properties-log-level) property.
TIP: Each log level and its parameters are defined using the {bootstrap-schema--xref--logging-console-log-level} property.

[#lbl-logrotate]
=== Log File Rotation
Expand Down
33 changes: 16 additions & 17 deletions modules/ROOT/pages/release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ include::partial$block-abstract.adoc[]

:xref-sgw-bmk-cfg-dbsvr: xref:{configuration-properties-legacy--page}#databases-this_db-server[Couchbase Server Connection String]
:xref-sgw-bmk-cfg-hideprodvn: xref:{configuration-properties-legacy--page}#hide_product_version[Hide Product Version in Headers]
:legacy-config--xref: {:configuration-properties-legacy--pfx}#

// END DO NOT REMOVE

Expand Down Expand Up @@ -178,7 +179,7 @@ The change _ought to be_ transparent to the user, *if*:

Old documents are automatically migrated to the `xattr` metadata format.

| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-enable_shared_bucket_access[enable_shared_bucket_access]
| {legacy-config--xref}databases-this_db-enable_shared_bucket_access[enable_shared_bucket_access]

| Enforce TLS by default
| xref:secure-sgw-access.html#lbl-cbs-comms[Couchbase Server Connection]
Expand All @@ -187,25 +188,23 @@ Old documents are automatically migrated to the `xattr` metadata format.

=== Deprecated

:legacy-config-2.8--xref: xref:2.8@sync-gateway::configuration-properties.adoc#

.Deprecated
[#tbl-deprecated, cols="1a,1a", options="header"]
|===
.>| Feature
.>| Link

| allow_conflicts confg
| {legacy-config-2.8--xref}databases-this_db-allow_conflicts[allow_conflicts]
| {legacy-config--xref}databases-this_db-allow_conflicts[allow_conflicts]

| enable_shared_bucket_access -- disabled option
|

| Facebook User Auth Config
| {legacy-config-2.8--xref}facebook[facebook]
| {legacy-config--xref}facebook[facebook]

| Google User Auth Config
| {legacy-config-2.8--xref}facebook[Google]
| {legacy-config--xref}facebook[Google]

| Logging API
|
Expand All @@ -223,43 +222,43 @@ Old documents are automatically migrated to the `xattr` metadata format.
|

| configServer property
| {legacy-config-2.8--xref}configServer[configserver]
| {legacy-config--xref}configServer[configserver]

| databases.this_db.cache.channel_cache_expiry
| {legacy-config-2.8--xref}databases-this_db-cache-channel_cache_expiry[channel_cache_expiry]
| {legacy-config--xref}databases-this_db-cache-channel_cache_expiry[channel_cache_expiry]

| databases.this_db.feed_type
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-feed_type[feed_type]
| {legacy-config--xref}databases-this_db-feed_type[feed_type]

| logging.default config section
| xref:legacy-logging-pre2-1.adoc[Legacy - Pre-2.1 Logging]

| old cache config values :databases.this_db.cache.channel_cache_max_length
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_max_length[channel_cache_max_length]
| {legacy-config--xref}databases-this_db-cache-channel_cache_max_length[channel_cache_max_length]

| old cache config values :databases.this_db.cache.channel_cache_min_length
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-channel_cache_min_length[channel_cache_min_length]
| {legacy-config--xref}databases-this_db-cache-channel_cache_min_length[channel_cache_min_length]

| old cache config values :databases.this_db.cache.enable_star_channel
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-enable_star_channel[enable_star_channel]
| {legacy-config--xref}databases-this_db-cache-enable_star_channel[enable_star_channel]

| old cache config values :databases.this_db.cache.max_num_pending
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_num_pending[max_num_pending]
| {legacy-config--xref}databases-this_db-cache-max_num_pending[max_num_pending]

| old cache config values :databases.this_db.cache.max_wait_pending
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_wait_pending[db-cache-max_wait_pending]
| {legacy-config--xref}databases-this_db-cache-max_wait_pending[db-cache-max_wait_pending]

| old cache config values :databases.this_db.cache.max_wait_skipped
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-cache-max_wait_skipped[max_num_skipped]
| {legacy-config--xref}databases-this_db-cache-max_wait_skipped[max_num_skipped]

| old cache config values: databases.this_db.rev_cache_size
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-rev_cache_size[rev_cache_size]
| {legacy-config--xref}databases-this_db-rev_cache_size[rev_cache_size]

| SG-Replicate
| xref:2.8@sync-gateway:ROOT:legacy-sg-replicate.adoc[Legacy -- SG-Replicate]

| walrus (should not be default database mode)
| xref:2.8@sync-gateway:ROOT:configuration-properties.adoc#databases-this_db-server[server]
| {legacy-config--xref}databases-this_db-server[server]
| Dropped
|===

Expand Down
Loading