Geneos Monitoring Report
Introduction Copied
The Geneos Gateway provides a Geneos command that will generate a report of what the Gateway is monitoring. This report is presented in the form of a JSON or YAML document, with example scripts to convert into CSV files.
The report includes the following:
Report information | Specific details |
---|---|
Details of all the probes that are running on the Gateway
|
|
Details of all the managed entities that are running on the Gateway |
|
Details of each sampler that are running on the Gateway |
|
Details of all the rules that are available on the Gateway |
|
Details of all the active times that are available on the Gateway |
|
Generating a Gateway report Copied
The report can be generated by running the Gateway command /REPORTING:monitoring
. This can be run in all the ways that a Geneos command is available:
- From the Active Console
- From the Entity Viewer App in the Web Console
- Using a Geneos Task
- Scheduled using scheduled commands
- Via the commands REST API
The resulting command is stored in a file that can be found in the specified location in the command arguments. The contents can either be in JSON or YAML format.
Note
While YAML is easier for humans to read, JSON is easier to manipulate to generate other data. JSON is ideal for maintaining data types and interacting with APIs or web services, while YAML is useful for creating configuration settings or adding comments in your data because of its user-friendly and readable format.
Adding Custom Details Copied
Certain information that needs to be captured for the monitoring report can be obtained from headlines and cells in certain dataviews.
The monitoring report command allows the user to provide report configuration in YAML format. This configuration instructs the report to provide detailed information for certain samplers.
Note
- The user can provide a list of details that are required.
- Each set of details is composed of two parts: a filter that identifies which sampler these details should be provided for and a list of additional information to obtain.
# Report YAML that defines the extra detailed information to obtain for the report
report:
# Array of details - each of which is extracted for each sampler that matches the filters and plugin type defines
details:
# Name of the details which is used to wrap the data when placed in the report
# Details will be placed along side other information for each sampler that the filters apply to.
- name: fkm
# Plugin name of the samplers that these details will be collected for
plugin: fkm
# Filters to use to limit which samplers to collect this data for
filters:
# Type of the filter ( hostname, probe, managedEntity, sampler, samplerType, dataview, attributes )
- type: attribute
# Name of the attribute to match agains (not required for any other filter)
name: environment
# List of regular expressions to match against the value provided by the type. If any one of the regular
# expressions match then the details will be extracted
regex:
- prod
- uat
# Details extraction type
# row - data is extracted for every row in the dataviews that match the filters provided
# dataview - data is extracted for every row in the dataviews that match the filters provided
type: row
# List of columns. Cells in these columns will be extracted from the dataview and placed in the report
# This data is only extracted it the type of the details is `row`
columns:
- name
- fileOwner
- filename
# List of headlines. These headline cells will be extracted from the dataview and placed in the report
headlines:
- filesMonitored
Extra FKM Columns Copied
For FKM, it is important to be aware of the configuration information associated with each file being monitored. This includes the table cells and headlines extracted from the FKM dataview. The Details sections for the FKM plugin will also provide four additional types of information:
- fkmActiveTime - the active time associated with the file (if defined)
- ignoreKeys - a list of ignore keys for this file
- failKeys - a list of fail keys for this file
- warningKeys - a list of warning keys for this file
It is essential to know the keys used to monitor various files. These keys (Critical, Warning, and Ignore) are automatically extracted if the plugin type is fkm
.
Note
This additional functionality is dependent on the Netprobe being version 7.1.0 or higher.
Generating CSV files Copied
The JSON reports can be converted into a set of CSV files through a bash
script that will convert the JSON reports from multiple Gateways into a set of CSV reports. The script (monitoring_report_to_csv.sh
) is included in the Gateway package (located in <gateway package>/templates/monitoring_report_to_csv.sh
.) as an example and is built to work with reports generated using the default parameters. It requires jq
1.6 or higher.
A sample JSON report and CSV files generated by using monitoring_report_to_csv.sh
can be downloaded here.