Fix logging page issues #4021

ggray-cb · 2025-12-03T15:30:25Z

This PR addresses multiple issues in the Manage Logging page:

In general, brought the writing up to our documentation standards. Also reorganized the information to be a bit more coherent.
DOC-13610 - Fix documentation regarding default logging level in Couchbase Server and DOC-10178 - XDCR logging does not default to debug, as docs suggest: Fixed these by basically removing description of default logging levels. In general, we've decided not to have users mess with the configuration themselves. Added list of supported REST APIs we make available for changing the logging level of some services. Kept the procedure on editing static_config to change logging levels, but state that they should only adjust the internal logging levels under support supervision.
DOC-13287 - Feedback on Manage Logging | Couchbase Docs fixed a typo in the term "memcached".
DOC-13281 - Feedback on Manage Logging | Couchbase Docs asked why we tell people how to change the logging location when we say it's unsupported. Added suggestions on moving the log files to another filesystem without changing Couchbase's config. Also detailed some drawbacks of editing static_config. Hopefully, these will convince most people not to change the logging location unless they have no other option.
DOC-12234 - Improve log redaction example requested we do a better job of illustrating how redaction works. Added a better example showing the before and after of log redaction. Also explained that some logs are redacted even if they do not contain the <ud>...</ud> tags.
DOC-11964 - Feedback on Manage Logging | Couchbase Docs asked about the example in changing log rotations being confusing. Clarified the steps to change log rotation.

Also fixed some errors that weren't flagged by bugs:

The description of how the proxy field works is wrong. Clarified what the user needs to enter in this field.
Added a few more log files to the list of log files. Also added a note that some additional files may appear in the log directory that are generated by internal debug options.
Updated screenshots and removed a bunch that were superfluous and only added to maintenance overhead.

Preview URL:
https://preview.docs-test.couchbase.com/docs-server-DOC-13610-Fix-documentation-regarding-default-logging-level-in-Couchbase-Server/server/current/manage/manage-logging/manage-logging.html

You will need the Docs Team credentials on Confluence.

NOTE: given the amount of editing in this page, your best bet is to review the preview page instead of trying to make sense of the git diff.

* Heavy edits to bring writing up to standards. * Lots of re-architecting of content to make it flow more reasonably. * Corrected numerous errors. * Implemented some feedback from questions about what we should actually say about changing logging levels/log file location.

hyunjuV

lgtm.
Comprehensive and detailed.
(Noted a typo -- same one in 2 places.)

hyunjuV · 2025-12-08T21:56:56Z

modules/manage/pages/manage-logging/manage-logging.adoc

+
+If neither of these options meet your needs, you can change the log location by following these steps:
+
+. Log into a node as the as `root` or the user who owns the Couchbase Server files. 


Typo - remove "as the":
. Log into a node as the as root or the user who owns the Couchbase Server files.
Instead:
. Log into a node as root or the user who owns the Couchbase Server files.

hyunjuV · 2025-12-08T21:59:21Z

modules/manage/pages/manage-logging/manage-logging.adoc


-[#redacting-log-files-outside-the-cluster]
-== Redacting Log Files Outside the Cluster
+. Log into a node as the as `root` or the user who owns the Couchbase Server files. 


Same Typo - remove "as the":
. Log into a node as the as root or the user who owns the Couchbase Server files.
Instead:
. Log into a node as root or the user who owns the Couchbase Server files.

anuthan

LGTM from me too.

anuthan · 2025-12-05T17:23:12Z

modules/manage/pages/manage-logging/manage-logging.adoc

-Also, the Couchbase Server upgrade process can overwrite the `static_config` file, losing any of your modifications.
+
+The Couchbase Server upgrade process can overwrite the `static_config` file, losing any of your modifications.
+If you change the log location, you may need to reapply your changes after an upgrade.


Thanks for adding this text.

anuthan · 2025-12-10T16:58:36Z

modules/manage/pages/manage-logging/manage-logging.adoc

+
+
+[#changing-log-file-locations]
+=== Changing Log File Locations


Thanks Gary, this looks good.

…roved by stakeholders. * Also fixed a typo. * Changed "most" to "some" when discussing which logs files use the sensitive data tags. Not sure how many do and how many do not. * Few other minor grammar fixups

* DOC-12634 Fixed prunage units from minutes to seconds * further updates on units and min/max/defaults * updated manage page

* DOC-12197 Added non-encoded example * Apply suggestions from code review Co-authored-by: rao-shwe <shwetha.rao@couchbase.com> --------- Co-authored-by: rao-shwe <shwetha.rao@couchbase.com>

…-Statistics (#3978) * Updated rest-statistics-multiple.adoc https://jira.issues.couchbase.com/browse/DOC-13126 Updated "=" | "!=" | "=~" | "~=" / “=, !=, =~, or ~=" to =, !=, =~, !~, any, or not_any. * Updated rest-statistics-multiple.adoc added a period at the end of line 65

#3977)

Add unit to query timeout setting

Add alias for deleted N1QL Application Continuity page

* [DOC-12324]: Configure Client Certificates page | Java Client Access:… * [DOC-12324]: Configure Client Certificates page | Java Client Access:…

* [DOC-12554]: Document how to check if a cluster has buckets with flus… * [DOC-12554]: Document how to check if a cluster has buckets with flus…

…3997) * [DOC-13654]: Update Release Notes Documentation page with MB-62678 Updated release notes for Couchbase Server 8.0.0: documented fix for invalid tombstones caused by TTL during deletions ([MB-62678]).

* [DOC-12426] Remove fts-search-facets.adoc to move to docs-devex repo * [DOC-12426] Delete additional facets file

Added port 9124 to encrypted ports under "node-to-node" at https://docs.couchbase.com/server/current/install/install-ports.html#ports-listed-by-communication-path

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

rao-shwe

Minor edits for double spaces and double hyphens.
The rest LGTM! 👍

rao-shwe · 2025-12-11T01:41:39Z

modules/manage/pages/manage-logging/manage-logging.adoc


-This brings up the *Collect Information* screen:
+| `analytics_dcpdebug`
+| DCP-specific debugging Information about the Analytics Service.


Suggested change

| DCP-specific debugging Information about the Analytics Service.

| DCP-specific debugging information about the Analytics Service.

rao-shwe · 2025-12-11T01:42:04Z

modules/manage/pages/manage-logging/manage-logging.adoc

-[#collect_info]
-image::manage-logging/collectInfo.png[,248,align=left]
+| `analytics_cbas_debug`
+| Debugging Information about the Analytics Service.


Suggested change

| Debugging Information about the Analytics Service.

| Debugging information about the Analytics Service.

rao-shwe · 2025-12-11T01:47:48Z

modules/manage/pages/manage-logging/manage-logging.adoc

-image::manage-logging/getClusterSummaryLink.png[,260,align=left]
+| `prometheus`
+| Log for the instance of https://prometheus.io[Prometheus^] that runs on the current node, supporting the gathering and management of Couchbase Server metrics.
+See the xref:metrics-reference:metrics-reference.adoc[Metrics Reference] for more Information about metrics.


Suggested change

See the xref:metrics-reference:metrics-reference.adoc[Metrics Reference] for more Information about metrics.

See the xref:metrics-reference:metrics-reference.adoc[Metrics Reference] for more information about metrics.

rao-shwe · 2025-12-11T01:58:31Z

modules/manage/pages/manage-logging/manage-logging.adoc


-[#partial_redaction_selection]
-image::manage-logging/partialRedactionSelection.png[,682,align=left]
+NOTE: Couchbase Server upgrades can overwrite  `static_config`, losing any of your modifications.


Suggested change

NOTE: Couchbase Server upgrades can overwrite `static_config`, losing any of your modifications.

NOTE: Couchbase Server upgrades can overwrite `static_config`, losing any of your modifications.

rao-shwe · 2025-12-11T02:03:40Z

modules/manage/pages/manage-logging/manage-logging.adoc


-| `debug`
-| Debug-level troubleshooting for the Cluster Manager.
+NOTE: Couchbase Server upgrades can overwrite  `static_config`, losing any modifications you have made.


Suggested change

NOTE: Couchbase Server upgrades can overwrite `static_config`, losing any modifications you have made.

NOTE: Couchbase Server upgrades can overwrite `static_config`, losing any modifications you have made.

rao-shwe · 2025-12-11T02:07:26Z

modules/manage/pages/manage-logging/manage-logging.adoc

-| `analytics_access`
-| Information on access attempts made to the REST/HTTP port of the Analytics Service.
+. Choose whether you want to upload the collected logs to Couchbase Support.
+See  <<uploading_log_files>> for more information about uploading log files to Couchbase Support.


Suggested change

See <<uploading_log_files>> for more information about uploading log files to Couchbase Support.

See <<uploading_log_files>> for more information about uploading log files to Couchbase Support.

rao-shwe · 2025-12-11T02:09:13Z

modules/manage/pages/manage-logging/manage-logging.adoc

+
+During the collection process, Couchbase Server scans the log files for private data.
+In some log files, it marks sensitive data with the tags `<ud>` and `</ud>`.
+When you select the *Partial Redaction* option on the *Collect Information* tab or use the `--log-redaction-level=partial` argument with the `cbcollect_info` command,  Couchbase Server redacts the marked data in the collected log files.


Suggested change

When you select the *Partial Redaction* option on the *Collect Information* tab or use the `--log-redaction-level=partial` argument with the `cbcollect_info` command, Couchbase Server redacts the marked data in the collected log files.

When you select the *Partial Redaction* option on the *Collect Information* tab or use the `--log-redaction-level=partial` argument with the `cbcollect_info` command, Couchbase Server redacts the marked data in the collected log files.

rao-shwe · 2025-12-11T02:11:59Z

modules/manage/pages/manage-logging/manage-logging.adoc

+
+When redacting, Couchbase Server replaces the content of the `<ud>` and `</ud>` tags with a SHA-1 hashed version of the data.

+For example, the following fragment from the `debug.log` displays two pieces of private data--a Couchbase username and a document ID:


Suggested change

For example, the following fragment from the `debug.log` displays two pieces of private data--a Couchbase username and a document ID:

For example, the following fragment from the `debug.log` displays two pieces of private data, a Couchbase username and a document ID:

rao-shwe · 2025-12-11T02:13:13Z

modules/manage/pages/manage-logging/manage-logging.adoc


-To change the location, proceed as follows:
+For example, the `http_access.log` (stored in the zip with the filename `ns_server.http_access.log`) contains HTTP requests that include the username making a request as well as sensitive data in URL parameters.
+The following log file fragment displays private data--the Administrator's username and the username of a user account that the Administrator is creating:


Suggested change

The following log file fragment displays private data--the Administrator's username and the username of a user account that the Administrator is creating:

The following log file fragment displays private data, the Administrator's username and the username of a user account that the Administrator is creating:

rao-shwe · 2025-12-11T02:24:42Z

modules/manage/pages/manage-logging/manage-logging.adoc

+(Assuming you installed Couchbase Server in the default location.)
+|===
+
+You can also view a summary of log events in Couchbase Server Web Console by clicking *Logs*.  


Suggested change

You can also view a summary of log events in Couchbase Server Web Console by clicking *Logs*.

You can also view a summary of log events in Couchbase Server Web Console by clicking *Logs*.

ggray-cb added 4 commits November 26, 2025 16:42

Done with draft

326a32a

Adjusted the in-page TOC level

8c675dc

Added anchors for some links

5a474b3

ggray-cb assigned Peter-Searby, anuthan, stevewatanabe and hyunjuV Dec 3, 2025

Fixing numbered list

347cc9f

hyunjuV approved these changes Dec 8, 2025

View reviewed changes

anuthan approved these changes Dec 10, 2025

View reviewed changes

Peter-Searby approved these changes Dec 10, 2025

View reviewed changes

ggray-cb and others added 18 commits December 10, 2025 13:50

Fixing typos spotted by Hyun-Ju

68f1bc1

* Deleting commented-out content because the new version has been app…

70267a2

…roved by stakeholders. * Also fixed a typo. * Changed "most" to "some" when discussing which logs files use the sensitive data tags. Not sure how many do and how many do not. * Few other minor grammar fixups

Add warning for modifying services (#3966)

9e00e2a

lowered thresholds (#3968)

a349e24

Doc 12634 (#3959)

e56a136

* DOC-12634 Fixed prunage units from minutes to seconds * further updates on units and min/max/defaults * updated manage page

Update cbstats warmup content with bucket data (#3981)

1c566aa

DOC-12197 Added non-encoded example (#3974)

665dcc3

* DOC-12197 Added non-encoded example * Apply suggestions from code review Co-authored-by: rao-shwe <shwetha.rao@couchbase.com> --------- Co-authored-by: rao-shwe <shwetha.rao@couchbase.com>

DOC-12563 fixed mcstat info (#3986)

4fa5316

DOC-13754 non-version the SDK link

c0b04a9

DOC-13744: Remove 8092, 18092 ports association with XDCR (#3991)

79bceda

DOC-13744: Update install-ports.adoc -- remove XDCR, capi association. (

c212355

#3977)

DOC-13329: Clearer commands and descriptions for timeout (#4000)

57259ac

Add unit to query timeout setting

[DOC-12349] Update Query Execution Diagram (#3962)

5dd11b6

DOC-13756: Minor doc fixes (#4002)

72f28e6

Add alias for deleted N1QL Application Continuity page

Merge pull request #4006

8c810c7

* [DOC-12324]: Configure Client Certificates page | Java Client Access:… * [DOC-12324]: Configure Client Certificates page | Java Client Access:…

Merge pull request #4003

b5453f6

* [DOC-12554]: Document how to check if a cluster has buckets with flus… * [DOC-12554]: Document how to check if a cluster has buckets with flus…

[DOC-13654]: Update Release Notes Documentation page with MB-62678 (#…

4771216

…3997) * [DOC-13654]: Update Release Notes Documentation page with MB-62678 Updated release notes for Couchbase Server 8.0.0: documented fix for invalid tombstones caused by TTL during deletions ([MB-62678]).

sarahlwelton and others added 5 commits December 10, 2025 14:34

[DOC-12426] Search Facets (#4008)

676a2ec

* [DOC-12426] Remove fts-search-facets.adoc to move to docs-devex repo * [DOC-12426] Delete additional facets file

DOC-12198-Feedback on Initializing a Node (#3994)

d75de64

Update rest-set-password-policy.adoc (#4009)

d281c7d

DOC-13735-Feedback on Couchbase Server Ports (#4013)

f8d5f96

Added port 9124 to encrypted ports under "node-to-node" at https://docs.couchbase.com/server/current/install/install-ports.html#ports-listed-by-communication-path

Updated checkpoint parameters (#4031)

35ff35c

ggray-cb requested review from a team and Copilot December 10, 2025 19:48

Copilot AI reviewed Dec 10, 2025

View reviewed changes

rao-shwe approved these changes Dec 11, 2025

View reviewed changes


		If neither of these options meet your needs, you can change the log location by following these steps:

		. Log into a node as the as `root` or the user who owns the Couchbase Server files.



		[#changing-log-file-locations]
		=== Changing Log File Locations

	\| DCP-specific debugging Information about the Analytics Service.
	\| DCP-specific debugging information about the Analytics Service.

	\| Debugging Information about the Analytics Service.
	\| Debugging information about the Analytics Service.

	See the xref:metrics-reference:metrics-reference.adoc[Metrics Reference] for more Information about metrics.
	See the xref:metrics-reference:metrics-reference.adoc[Metrics Reference] for more information about metrics.

	NOTE: Couchbase Server upgrades can overwrite `static_config`, losing any of your modifications.
	NOTE: Couchbase Server upgrades can overwrite `static_config`, losing any of your modifications.

	See <<uploading_log_files>> for more information about uploading log files to Couchbase Support.
	See <<uploading_log_files>> for more information about uploading log files to Couchbase Support.

	When you select the Partial Redaction option on the Collect Information tab or use the `--log-redaction-level=partial` argument with the `cbcollect_info` command, Couchbase Server redacts the marked data in the collected log files.
	When you select the Partial Redaction option on the Collect Information tab or use the `--log-redaction-level=partial` argument with the `cbcollect_info` command, Couchbase Server redacts the marked data in the collected log files.


		When redacting, Couchbase Server replaces the content of the `<ud>` and `</ud>` tags with a SHA-1 hashed version of the data.

		For example, the following fragment from the `debug.log` displays two pieces of private data--a Couchbase username and a document ID:

	The following log file fragment displays private data--the Administrator's username and the username of a user account that the Administrator is creating:
	The following log file fragment displays private data, the Administrator's username and the username of a user account that the Administrator is creating:

	You can also view a summary of log events in Couchbase Server Web Console by clicking Logs.
	You can also view a summary of log events in Couchbase Server Web Console by clicking Logs.

Fix logging page issues #4021

Are you sure you want to change the base?

Fix logging page issues #4021

Uh oh!

Conversation

ggray-cb commented Dec 3, 2025

Uh oh!

hyunjuV left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anuthan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

rao-shwe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

anuthan left a comment •

edited

Loading