Merge pull request #1732 from Danielle9897/RDoc-2578-availableMemory

RDoc-2278 Add missing metrics + option to get multiple OIDs
ravendb · Jan 4, 2024 · a351648 · a351648
2 parents a34579f + de5424f
commit a351648
Show file tree

Hide file tree

Showing 11 changed files with 1,988 additions and 322 deletions.
diff --git a/.../4.0/Raven.Documentation.Pages/server/administration/SNMP/setup-zabbix.markdown b/.../4.0/Raven.Documentation.Pages/server/administration/SNMP/setup-zabbix.markdown
@@ -1,4 +1,4 @@
-# Monitoring: How to Setup Zabbix Monitoring
+# How to Setup Zabbix Monitoring
 
 RavenDB supports [SNMP](./snmp), which means that with a few quick steps you can monitor your server using Zabbix.
 

diff --git a/...entation/4.2/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown b/...entation/4.2/Raven.Documentation.Pages/server/administration/SNMP/snmp.markdown
diff --git a/...aven.Documentation.Pages/server/configuration/monitoring-configuration.markdown b/...aven.Documentation.Pages/server/configuration/monitoring-configuration.markdown
@@ -20,12 +20,22 @@ Port at which SNMP listener will be active.
 
 {PANEL/}
 
+{PANEL:Monitoring.Snmp.SupportedVersions}
+
+List of supported SNMP versions. Values must be semicolon separated.
+
+- **Type**: `string[]`
+- **Default**: `V2C;V3`
+- **Scope**: Server-wide only
+
+{PANEL/}
+
 {PANEL:Monitoring.Snmp.Community}
 
 Community string used for SNMP v2c authentication.
 
 - **Type**: `string`
-- **Default**: `ravendb`
+- **Default**: `"ravendb"`
 - **Scope**: Server-wide only
 
 {PANEL/}
@@ -40,19 +50,50 @@ Authentication protocol used for SNMP v3 authentication.
 
 {PANEL/}
 
+{PANEL:Monitoring.Snmp.AuthenticationProtocol.Secondary}
+
+Authentication protocol used by secondary user for SNMP v3 authentication.
+
+- **Type**: `SnmpAuthenticationProtocol`
+- **Default**: `SHA1`
+- **Scope**: Server-wide only
+
+{PANEL/}
+
 {PANEL:Monitoring.Snmp.AuthenticationUser}
 
 Authentication user used for SNMP v3 authentication.
 
 - **Type**: `string`
-- **Default**: `ravendb`
+- **Default**: `"ravendb"`
+- **Scope**: Server-wide only
+
+{PANEL/}
+
+{PANEL:Monitoring.Snmp.AuthenticationUser.Secondary}
+
+Authentication secondary user used for SNMP v3 authentication.
+
+- **Type**: `string`
+- **Default**: `null (disabled)`
 - **Scope**: Server-wide only
 
 {PANEL/}
 
 {PANEL:Monitoring.Snmp.AuthenticationPassword}
 
-Authentication password used for SNMP v3 authentication. If null value from 'Monitoring.Snmp.Community' is used.
+Authentication password used for SNMP v3 authentication.  
+When set to `null` then the value from 'Monitoring.Snmp.Community' is used.
+
+- **Type**: `string`
+- **Default**: `null`
+- **Scope**: Server-wide only
+
+{PANEL/}
+
+{PANEL:Monitoring.Snmp.AuthenticationPassword.Secondary}
+
+Authentication password used by secondary user for SNMP v3 authentication.
 
 - **Type**: `string`
 - **Default**: `null`
@@ -70,29 +111,51 @@ Privacy protocol used for SNMP v3 privacy.
 
 {PANEL/}
 
+{PANEL:Monitoring.Snmp.PrivacyProtocol.Secondary}
+
+Privacy protocol used by secondary user for SNMP v3 privacy.
+
+- **Type**: `SnmpPrivacyProtocol`
+- **Default**: `SnmpPrivacyProtocol.None`
+- **Scope**: Server-wide only
+
+{PANEL/}
+
 {PANEL:Monitoring.Snmp.PrivacyPassword}
 
 Privacy password used for SNMP v3 privacy.
 
 - **Type**: `string`
-- **Default**: `ravendb`
+- **Default**: `"ravendb"`
 - **Scope**: Server-wide only
 
 {PANEL/}
 
-{PANEL:Monitoring.Snmp.SupportedVersions}
+{PANEL:Monitoring.Snmp.PrivacyPassword.Secondary}
 
-List of supported SNMP versions. Values must be semicolon separated.
+Privacy password used by secondary user for SNMP v3 privacy.
 
-- **Type**: `string[]`
-- **Default**: `V2C;V3`
+- **Type**: `string`
+- **Default**: `null`
+- **Scope**: Server-wide only
+
+{PANEL/}
+
+{PANEL:Monitoring.Snmp.DisableTimeWindowChecks}
+
+EXPERT ONLY.  
+Disables time window checks, which are problematic for some SNMP engines.
+
+- **Type**: `bool`
+- **Default**: `false`
 - **Scope**: Server-wide only
 
 {PANEL/}
 
 {PANEL:Monitoring.Cpu.Exec}
 
-A command or executable to run which will provide machine CPU usage and process CPU to standard output. If specified, RavenDB will use this information for monitoring CPU usage.  
+A command or executable to run which will provide machine CPU usage and process CPU to standard output.  
+If specified, RavenDB will use this information for monitoring CPU usage.  
 Note: the write to standard output should be unbuffered to work properly.
 
 - **Type**: `string`
@@ -103,7 +166,8 @@ Note: the write to standard output should be unbuffered to work properly.
 
 {PANEL:Monitoring.Cpu.Exec.Arguments}
 
-The command line arguments for the 'Monitoring.Cpu.Exec' command or executable. The arguments must be escaped for the command line.
+The command line arguments for the 'Monitoring.Cpu.Exec' command or executable.  
+The arguments must be escaped for the command line.
 
 - **Type**: `string`
 - **Default**: `null`

diff --git a/Documentation/5.2/Raven.Documentation.Pages/server/administration/SNMP/.docs.json b/Documentation/5.2/Raven.Documentation.Pages/server/administration/SNMP/.docs.json
@@ -1,14 +1,14 @@
 [
-  {
-    "Path": "snmp.markdown",
-    "Name": "What is SNMP",
-    "DiscussionId": "e93eeece-4ec7-49a1-a421-3e76be46447a",
-    "Mappings": []
-  },
-  {
-    "Path": "setup-zabbix.markdown",
-    "Name": "Zabbix",
-    "DiscussionId": "fd2935c8-c276-454b-b518-6449b1d37673",
-    "Mappings": []
-  }
-]
+    {
+        "Path": "snmp.markdown",
+        "Name": "SNMP Support",
+        "DiscussionId": "e93eeece-4ec7-49a1-a421-3e76be46447a",
+        "Mappings": []
+    },
+    {
+        "Path": "setup-zabbix.markdown",
+        "Name": "Zabbix Monitoring",
+        "DiscussionId": "fd2935c8-c276-454b-b518-6449b1d37673",
+        "Mappings": []
+    }
+]