[Reorganization: monitoring] monitoring reorganization batch 2 by reebhub · Pull Request #2571 · ravendb/docs

reebhub · 2026-07-22T05:09:44Z

Additional description

move monitoring pages to /monitoring and update them as needed (statistics, logging, logging configuration page, traffic watch, traffic watch configuration page, debug endpoints, collect info for support, debug package folder, get statistics API page)

Type of change

Changes in docs URLs

No changes in docs URLs
Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

No changes in UX/UI
Changes in UX/UI (include screenshots and description)

…istics and update the page

# Conflicts: # docs/server/administration/statistics.mdx

…aintenance/get-stats to /monitoring/statistics/client-api and updated its layout and content (v7.2 for C#, PHP, python, node.js, java)

… to /monitoring/logs/overview and update its layout and content

…logs-configuration to /monitoring/logs/configuration, update layout and content, leave a reference page

… from client-api/operations/server-wide/logs into /monitoring/logs/client-api, update layout and content, leave reference pages in the original locations

…pages to /monitoring/traffic-watch, update layout and content, add missing content (Studio view), update redirects

…ing/debug, split all routes into source-verified debug and production tables, added a redirect from the old troubleshooting path

…location

…/debug, update the redirects file, improve page layout

…package, add redirects

…ng/logs/configuration

…elocated /monitoring/debug pages

reebhub · 2026-07-22T06:33:07Z

@Lwiel note: this is batch 2 of the monitoring reorganization, including pages under:
/monitoring/debug, /monitoring/logs, /monitoring/statistics, /monitoring/traffic-watch

…r support` to the root

Lwiel

We should remove these leftover snagx files I think

docs/monitoring/debug/assets/snagit/admin-logs-view.snagx
docs/monitoring/debug/assets/snagit/microsoft-logs.snagx 
docs/monitoring/debug/assets/snagit/server-logs.snagx
docs/monitoring/debug/assets/snagit/settings-logs-on-disk.snagx 
docs/monitoring/debug/assets/snagit/traffic-watch-logs.snagx

Lwiel · 2026-07-31T13:16:03Z

@@ -0,0 +1,4 @@
+{
+  "position": 13,


/monitoring sidebar positions have gaps now

leftover snagits removed

sidebar positions gapped on purpose in preparation for expected additional pages (in next PR)

Lwiel · 2026-07-31T13:18:11Z

     make sure this directory exists on each node; otherwise, cluster setup may fail.  

-     Learn more about the RavenDB logging system in [Logging](../../../server/troubleshooting/logging).      
+     Learn more about the RavenDB logging system in the [Overview](../../../monitoring/logs/overview) page.      


Lacks .mdx extension

Lwiel · 2026-07-31T13:20:53Z

 | - | - |
 | Integrations (SNMP, OpenTelemetry) | [Integrations: Configuration](integrations/configuration.mdx) |
+| Logs | [Logs: Configuration](logs/configuration.mdx) |
 | Task errors | [Task errors: Configuration](task-errors/configuration.mdx) |


Should we add traffic watch here?

Lwiel · 2026-07-31T13:21:49Z

@@ -0,0 +1,461 @@
+---
+title: "Logging: Overview"


In other files we use Logs, let's make it consistent

right
unified to "logging", seems more accurate since we're talking mainly about the mechanism and how to configure it.

Lwiel · 2026-07-31T13:23:04Z

+| `/admin/stats` | GET | The node's uptime, start time, last request time, last non-ClusterAdmin authorized request time, and the last request time per client certificate thumbprint. |
+| `/build/version` | GET | The server's build number, product version, commit hash, and full version string. |
+| `/cluster/topology` | GET | The current [cluster topology](../../server/clustering/rachis/cluster-topology.mdx): members, watchers, and their URLs. |
+| `/databases/*/admin/configuration/settings` | GET, PUT | The database's configuration settings. `GET` reads the effective settings; `PUT` updates them from the request body.<br /><br />**Parameters (`GET` only):**<ul><li>`scope`: filter to a configuration entry scope (`ServerWideOnly`, `ServerWideOrPerDatabase`, or `ServerWideOrPerDatabaseOrPerIndex`) (optional)</li></ul> |


Maybe we should explain that * is the database name placeholder

Lwiel · 2026-07-31T13:24:17Z

 title: "Configuration: Logs Options"
-sidebar_label: Logs Configuration
-description: "Configure RavenDB server logging behavior including log levels, output file paths, retention policies, and audit log enablement settings."
+sidebar_label: "Logs Configuration"


Maybe we should get rid of this and add a redirect?

normally we relocate pages and update the redirects table, but in the specific case of /server/configuration we always leave a stub behind, pointing to the new configuration page in its new location, to keep the /server/configuration configurations list full and allow readers familiar with this entry point to always find what they are looking for. so at least for now let's leave this as is.

Lwiel · 2026-07-31T13:31:21Z

-  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)  
-  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetCollectionStatisticsOperation](../../../client-api/operations/maintenance/get-stats.mdx#get-collection-stats)   
-  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedCollectionStatisticsOperation](../../../client-api/operations/maintenance/get-stats.mdx#get-detailed-collection-stats)
+  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../../monitoring/statistics/client-api.mdx#get-database-stats)  


Should be #get-database-statistics anchor I think, same for other languages but Java. In Java we have #get-database-stats

reebhub added 14 commits July 20, 2026 14:53

RDoc-3995 - Move server/administration/statistics to /monitoring/stat…

6bb3f7f

…istics and update the page

Merge remote-tracking branch 'origin/main' into monitoringReorg2

2f7804f

# Conflicts: # docs/server/administration/statistics.mdx

RDoc-4003 - Move the statistics API page from client-api/operations/m…

f82e17a

…aintenance/get-stats to /monitoring/statistics/client-api and updated its layout and content (v7.2 for C#, PHP, python, node.js, java)

RDoc-3996 - Move the logging page from server/troubleshooting/logging…

15d64ed

… to /monitoring/logs/overview and update its layout and content

RDoc-3997 - Move the logging configuration from server/configuration/…

c3c1ed4

…logs-configuration to /monitoring/logs/configuration, update layout and content, leave a reference page

RDoc-4004 - Merge the get and set logs configuration client API pages…

6fd6afb

… from client-api/operations/server-wide/logs into /monitoring/logs/client-api, update layout and content, leave reference pages in the original locations

RDoc-3998, RDoc-3999 - Move traffic watch overview and configuration …

dd90447

…pages to /monitoring/traffic-watch, update layout and content, add missing content (Studio view), update redirects

RDoc-4000 - rebuilt the debug endpoints page and moved it to /monitor…

c8f4254

…ing/debug, split all routes into source-verified debug and production tables, added a redirect from the old troubleshooting path

RDoc-4003 - remove the reference page left at the old Get Statistics …

aab3c60

…location

RDoc-4001 - Move the Collect Info for Support page into /monitoring…

73df8ae

…/debug, update the redirects file, improve page layout

RDoc-4002 - Move the debug package folder to /monitoring/debug/debug-…

0d9b084

…package, add redirects

link fixing following moving the logs configuration page to /monitori…

180c57f

…ng/logs/configuration

Merge remote-tracking branch 'origin/main' into monitoringReorg2

03dfe44

RDoc-3983 - Repoint the debug-package guide's see_also links to the r…

35cb3ec

…elocated /monitoring/debug pages

reebhub requested a review from Lwiel July 22, 2026 06:33

RDoc-4001 - reorder /monitoring content and relocate `collect info fo…

5611672

…r support` to the root

reebhub force-pushed the monitoringReorg2 branch from 9641a3f to 5611672 Compare July 23, 2026 18:19

Lwiel reviewed Jul 31, 2026

View reviewed changes

RDoc-3983 - fixed by review comments

fd10d1d

ppekrol merged commit 956d809 into ravendb:main Jul 31, 2026
1 check passed

Uh oh!

Conversation

reebhub commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue link

Additional description

Type of change

Changes in docs URLs

Changes in UX/UI

Uh oh!

reebhub commented Jul 22, 2026

Uh oh!

Lwiel 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!

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

reebhub commented Jul 22, 2026 •

edited

Loading