---
title: "Geneos Monitoring Report"
description: ""
url: "https://docs.itrsgroup.com/docs/geneos/7.9.0/administration/geneos_monitoring_report/index.html"
---

**Important**

 Starting with Geneos version 7.7.0, the provided `monitoring_report_to_excel.py` script will not work with data from Gateways running versions prior to 7.7.0. Similarly, data from Geneos version 7.7.0 onwards cannot be used with the original monitoring report script that was supplied with Geneos versions earlier than 7.7.0. 


## Introduction

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](#generating-csv-files).

The report includes the following:

| Report information| Specific details |
|-------|-------|
| Details of all the probes that are running on the Gateway 
**Note**

 This includes any self-announcing probes that are connected to the Gateway at the time the report is run. 
 | - Probe name
- Probe hostname
- Probe port
- OS version of the server the probe resides upon |
| Details of all the managed entities that are running on the Gateway | - Managed entity name
- All attributes defined on the managed entity |
| Details of each sampler that are running on the Gateway | - Sampler name
- Sampler type
- Sampler group
- Sampler interval of the sampler
- Active times that are applied to the sampler and affect when it samples
- Dataviews created by the sampler
- Any rules that are configured to run on the sampler or any descendant of the sampler (dataview, headline cells, or table cells). These rules are identified by name (rule group, rule name, and rule default name). Any sampler variables that are referenced in the rules will also be listed along with their values. |
| Details of all the rules that are available on the Gateway | - Rule name
- Rule group
- Rule default name
- Rule logic
- Rule actions
- Rule active times |
| Details of all the active times that are available on the Gateway | - Active Time name
- Active Time description |

## Generating a Gateway report using a Geneos Command

The report can be generated by running the Gateway command `/REPORTING:monitoring`.

- The command is available on the Gateway directory component and the Gateway sampler that is provided as part of the Gateway self-monitoring.
- In the Active Console and in the Entity Viewer, the command is called `Monitoring`. This can be found under the `Reporting` menu.

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](https://docs.itrsgroup.com/docs/itrs-analytics/app/entities/current/user-guide/commands/index.html)
- Using a [Geneos Task](https://docs.itrsgroup.com/docs/geneos/7.9.0/processing/monitoring-and-alerts/geneos_commands_tr/index.html#task-commands)
- Scheduled using [scheduled commands](https://docs.itrsgroup.com/docs/geneos/7.9.0/processing/monitoring-and-alerts/geneos_commands_tr/index.html#scheduled-commands)
- Via the commands [REST API](https://docs.itrsgroup.com/docs/geneos/7.9.0/processing/monitoring-and-alerts/geneos_commands_tr/index.html#rest-service)

The results of the command are stored in a file that can be found in the directory specified in the command arguments. The file can either be in JSON (`form monitoring_report_<timestamp>.json`) or YAML (`monitoring_report_<timestamp>.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. 


![Gateway Monitoring Report Arguments](https://docscdn.itrsgroup.com/geneos/images/gw-monitoring-report-arguments-7-7.png)

### Adding Custom Details

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. 


```yaml
# Report YAML that defines the extra detailed information to obtain for the report
report:
  # Indicates whether sampler rules in the report will contain only the rules that have been evaluated.
  showEvaluatedRulesOnly: false

  # 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 if 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

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 a Gateway report using a REST request

Enabling a [REST Service](https://docs.itrsgroup.com/docs/geneos/7.9.0/processing/monitoring-and-alerts/geneos_commands_tr/index.html#Heading-rest-service) in the Gateway allows you to directly request a monitoring report. The [YAML report configuration](#adding-custom-details) can be passed as the POST body of the REST request. A report in JSON format will be returned from the request.

To run the report on an insecure Gateway running on the same machine with no authentication, run the following:

```
curl -X POST -H 'Content-Type: application/json' http://127.0.0.1:7039/rest/reporting/monitoring
```

To connect to a Gateway with authentication, refer to [user authentication](https://docs.itrsgroup.com/docs/geneos/7.9.0/processing/monitoring-and-alerts/geneos_commands_tr/index.html#user-authentication) and [authorizing an SSO user](https://docs.itrsgroup.com/docs/geneos/7.9.0/processing/monitoring-and-alerts/geneos_commands_tr/index.html#authorise-sso-user).

## Generating Excel reports

The JSON reports can be converted into an Excel workbook through a `python` script. This script will convert the JSON reports from multiple Gateways into a single workbook with multiple sheets.

The script (`monitoring_report_to_excel.py`) is included in the Gateway package (located in `<gateway package>/templates/monitoring_report_to_excel.py`.) as an example and is built to work with reports generated using the default parameters.


**Note**

 Ensure that the `xlsxwriter` python package is installed before running the script. 


A sample JSON report and Excel workbook generated by running `monitoring_report_to_excel.py` can be downloaded [here](/geneos/downloads/example_report.tar.gz "Download sample JSON report and Excel Workbook").

