SNMP Support

Access metrics via monitoring tools

• Querying the exposed metrics using a monitoring tool is typically straightforward (see this Zabbix example).

• For a simplified setup, we have provided a few templates which can be found here.
  These templates include the metrics and their associated OIDs.

Access metrics via SNMP agents

• The metrics can be accessed directly using any SNMP agent such as Net-SNMP.
  Each metric has a unique object identifier (OID) and can be accessed individually.

• The most basic SNMP commands are snmpget, snmpset and snmpwalk.
  For example, you can execute the following snmpget commands to retrieve the server's up-time metric.

  For SNMPv2c:

  // Request:
  snmpget -v 2c -c ravendb live-test.ravendb.net 1.3.6.1.4.1.45751.1.1.1.3
  
  // Result:
  iso.3.6.1.4.1.45751.1.1.1.3 = Timeticks: (29543973) 3 days, 10:03:59.73

  • ravendb is the community string (set via the Monitoring.Snmp.Community configuration key).
  • "live-test.ravendb.net" is the host.

  For SNMPv3:

  snmpget -v 3 -l authNoPriv -u ravendb -a SHA \
          -A ravendb live-test.ravendb.net 1.3.6.1.4.1.45751.1.1.1.3

  • -l authNoPriv - sets the security level to use authentication but no privacy.
  • -u ravendb - sets the user for authentication purposes to "ravendb".
  • -a SHA - sets the authentication protocol to SHA.
  • -A ravendb - sets the authentication password to "ravendb".

Access metrics via HTTP

Access single OID value:

• An individual OID value can be retrieved via HTTP GET endpoint:
  <serverUrl>/monitoring/snmp?oid=<oid>

• For example, a cURL request for the server up-time metric:

  // Request:
  curl -X GET http://live-test.ravendb.net/monitoring/snmp?oid=1.3.6.1.4.1.45751.1.1.1.3
  
  // Result:
  { "Value" : "4.21:32:56.0700000" }

Access multiple OID values:

• Multiple OID values can be retrieved by making either a GET or a POST request to the following HTTP endpoint: <serverUrl>/monitoring/snmp/bulk

• For example, cURL requests for the server managed memory and unmanaged memory metrics:

  curl -X GET "http://live-test.ravendb.net/monitoring/snmp/bulk? \
               oid=1.3.6.1.4.1.45751.1.1.1.6.7&oid=1.3.6.1.4.1.45751.1.1.1.6.8"

  curl -X POST \
       -H "Content-Type: application/json" \
       -d '{  "OIDs": ["1.3.6.1.4.1.45751.1.1.1.6.7", "1.3.6.1.4.1.45751.1.1.1.6.8"]}' \
       http://localhost:8080/monitoring/snmp/bulk

  {
      "Results": [
          { "OID": "1.3.6.1.4.1.45751.1.1.1.6.7", "Value": "410" },
          { "OID": "1.3.6.1.4.1.45751.1.1.1.6.8", "Value": "4"   }
      ]
  }

Get all OIDs:

• You can get a list of all OIDs along with their description via this HTTP GET endpoint:
  <serverUrl>/monitoring/snmp/oids

• For example: http://live-test.ravendb.net/monitoring/snmp/oids

• RavenDB's root OID is: 1.3.6.1.4.1.45751.1.1.

• Values represented by X, D, or I in the OIDs list below will be:

  • X:
    0 - any kind of collection
    1 - a generation-0 or generation-1 collection
    2 - a blocking generation-2 collection
    3 - a background collection (this is always a generation 2 collection)
  • D - Database number
  • I - Index number