CouchDB Logs Test

The CouchDB logs are a vast source of information related to errors and warnings that a CouchDB server encounters. Administrators use these log files not only to spot problem conditions, but also to troubleshoot them. By periodically scanning the CouchDB error log for errors/warnings, the CouchDB Logs test promptly notifies administrators as soon as a new error/ warning error is logged in the file. Detailed diagnostics of the test clearly indicate what error it is and when it occurred, so as to aid troubleshooting efforts.

As messages keep getting logged in the log files, these log files grow large in size. If log file growth is left unchecked, it can consume all available space in the database. Administrators can effectively tracklog file growth and initiate measures to control it using the CouchDB Logs test. The test reports the current size of the log files and their growth rate, and proactively alerts administrators if the rate of growth is abnormal.

Target of the test : Apache CouchDB Server

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for the target Apache CouchDB Server.

Configurable parameters for the test
Parameter	Description
Test period	How often should the test be executed.
Host	The IP address of the target server that is being monitored.
Port	The port number through which the Couchdb server communicates. The default port is 5984.
Username	In order to monitor an Apache CouchDB server, a special database user account with Admin privilege has to be created in every Apache CouchDB server instance that requires monitoring. In the Username text box, specify the Username for monitoring the target Apache CouchDB server instance.To create a new user, refer Pre-requisites for Monitoring Apache CouchDB topic.
Password	Specify the password of the specified Username.
Confirm Password	Confirm the password by retyping it here.
ISUTF 16	Set this flag to Yes, if the test needs to use the UTF-16 encoding format for reading the specified log files. By default, this flag is set to No.
File Path	Specify the full path to the log file that is to be read by the test to pull out the metrics.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time the test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD Frequency.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Total messages	Indicates the total number of messages in the log file.	Number
Alert messages	Indicates the number the alert messages in the log file.	Number
Critical messages	Indicates the number of critical messages in the log file.	Number	Ideally, the value of this measure should be 0. If a non-zero value is reported, you can use the detailed diagnosis of this measure to know what error occurred and when.
Debug messages	Indicates the number of debug messages in the log file.	Number
Emergency messages	Indicates the number of emergency messages in the log file.	Number	Ideally, the value of this measure should be 0. If a non-zero value is reported, you can use the detailed diagnosis of this measure to know what error occurred and when.
Info messages	Indicates the number of info messages in the log file.	Number
Error messages	Indicates the number of error messages in the log file.	Number	Ideally, the value of this measure should be 0. If a non-zero value is reported, you can use the detailed diagnosis of this measure to know what error occurred and when.
Notice messages	Indicates the number of notice messages in the log file.	Number
Warning messages	Indicates the number of warning messages in the log file.	Number	Ideally, the value of this measure should be 0. If a non-zero value is reported, you can use the detailed diagnosis of this measure to know what error occurred and when.
File size	Indicates the current size of the log file.	MB
Growth rate	Indicates the rate at which the log file is growing.	MB/sec	A high value for this measure or a consistent increase in its value indicates that the Apache CouchDB log is rapidly growing and may end up occupying too much space on the volume.