Fortinet Document Library

Version:


Table of Contents

User Guide

21.4.0
Copy Link

CouchDB

You can use the CouchDB plugin to report on the health of your Database server. This includes information regarding the performance of your database, and the status codes being returned by the database. If you can not find this plugin in the /usr/lib/panopta-agent/plugins folder, then your version of the Agent is out of date and you should update it to gain access to this feature.

If you haven't read Add a monitoring agent resource yet, please do that first.

Agent Configuration

In order to use this plugin, you will need to add the host server address and port of your CouchDB stats page. This would be the IP address your database could be accessed from . You would need to add the address and port to the /etc/panopta-agent/panopta_agent.cfg file as shown below:

[couch]
host = 127.0.0.1
port = 1313

Control Panel Configuration

To add a CouchDB agent resource to your server, read Add FortiMonitor Agent checks. To use the CouchDB plugin, first, select CouchDB from the monitoring catalog by clicking + Add on the icon.

If you have followed the steps above and the new metric and plugin do not show properly, you may need to manually rebuild the agent’s metadata. You can do this by following the guide here.

Available CouchDB Metrics

Metric

Unit

Length of a request inside CouchDB without MochiWeb

ms

Number of bulk requests

requests

Number of file descriptors CouchDB has open

files

Number of HTTP 200 OK responses

responses

Number of HTTP 201 Created responses

responses

Number of HTTP 202 Accepted responses

responses

Number of HTTP 301 Moved Permanently responses

responses

Number of HTTP 304 Not Modified responses

responses

Number of HTTP 400 Bad Request responses

responses

Number of HTTP 401 Unauthorized responses

responses

Number of HTTP 403 Forbidden responses

responses

Number of HTTP 404 Not Found responses

responses

Number of HTTP 405 Method Not Allowed responses

responses

Number of HTTP 409 Conflict Responses

responses

Number of HTTP 412 Precondition Failed responses

responses

Number of HTTP 500 Internal Server Error responses

responses

Number of HTTP COPY requests

requests

Number of HTTP DELETE requests

requests

Number of HTTP GET requests

requests

Number of HTTP HEAD requests

requests

Number of HTTP MOVE requests

requests

Number of HTTP POST requests

requests

Number of HTTP PUT requests

requests

Number of HTTP requests

requests

Number of open databases

databases

Number of temporary view reads

reads

Number of times a database was changed

times

Number of times a document was read from a database

times

Number of view reads

reads

If you have any additional questions, please contact our support team.

CouchDB

You can use the CouchDB plugin to report on the health of your Database server. This includes information regarding the performance of your database, and the status codes being returned by the database. If you can not find this plugin in the /usr/lib/panopta-agent/plugins folder, then your version of the Agent is out of date and you should update it to gain access to this feature.

If you haven't read Add a monitoring agent resource yet, please do that first.

Agent Configuration

In order to use this plugin, you will need to add the host server address and port of your CouchDB stats page. This would be the IP address your database could be accessed from . You would need to add the address and port to the /etc/panopta-agent/panopta_agent.cfg file as shown below:

[couch]
host = 127.0.0.1
port = 1313

Control Panel Configuration

To add a CouchDB agent resource to your server, read Add FortiMonitor Agent checks. To use the CouchDB plugin, first, select CouchDB from the monitoring catalog by clicking + Add on the icon.

If you have followed the steps above and the new metric and plugin do not show properly, you may need to manually rebuild the agent’s metadata. You can do this by following the guide here.

Available CouchDB Metrics

Metric

Unit

Length of a request inside CouchDB without MochiWeb

ms

Number of bulk requests

requests

Number of file descriptors CouchDB has open

files

Number of HTTP 200 OK responses

responses

Number of HTTP 201 Created responses

responses

Number of HTTP 202 Accepted responses

responses

Number of HTTP 301 Moved Permanently responses

responses

Number of HTTP 304 Not Modified responses

responses

Number of HTTP 400 Bad Request responses

responses

Number of HTTP 401 Unauthorized responses

responses

Number of HTTP 403 Forbidden responses

responses

Number of HTTP 404 Not Found responses

responses

Number of HTTP 405 Method Not Allowed responses

responses

Number of HTTP 409 Conflict Responses

responses

Number of HTTP 412 Precondition Failed responses

responses

Number of HTTP 500 Internal Server Error responses

responses

Number of HTTP COPY requests

requests

Number of HTTP DELETE requests

requests

Number of HTTP GET requests

requests

Number of HTTP HEAD requests

requests

Number of HTTP MOVE requests

requests

Number of HTTP POST requests

requests

Number of HTTP PUT requests

requests

Number of HTTP requests

requests

Number of open databases

databases

Number of temporary view reads

reads

Number of times a database was changed

times

Number of times a document was read from a database

times

Number of view reads

reads

If you have any additional questions, please contact our support team.