Excel Report for ArcGIS Monitor

[AndrewSakowicz]

Get started

Excel Report for ArcGIS Monitor provides information about components, logs, metrics, and alerts. 

To run using provided executable for windows, unzip ExcelReport.zip from

https://prof-services.maps.arcgis.com/home/item.html?id=248e22510a454e9c906204d3ad45adca

go to dist folder and execute from command line:

ExcelReport.exe -f sampleConfig.json

version: 20240927.0

Note, this utility is not an ArcGIS Monitor product supported feature or a supported Esri product. 

Overview

 Excel Report for ArcGIS Monitor provides information about

1. Components
   1. Overview table (e.g., see below host _components)
   2. logs for ArcGIS Portal and Server (e.g., see below arcgis_server_log)
2. Metrics
   1. Statistics table for a selected metric name (e.g., see below host_CPU_Utilized)
   2. Top 10 components chart (there is no hyperlink.  It is assumed users will click the above statistics worksheet and navigate to the left worksheet)
   3. Alerts chart (there is no hyperlink.  It is assumed users will click the above statistics worksheet and navigate to the left worksheet)
3. Key Performance Indicators
   1. highest alerting status
4. Alerting components

Component overview

ArcGIS Server Log

Metric statistics

Top 10 components

Alerting components

Note, this utility is not an ArcGIS Monitor product supported feature or a supported Esri product. 

[Mark_Prettyman]

Hi!  The link above, to download ExcelReport.zip, requires Esri credentials or an AGOL login...but my AGOL login only returns the "not a member of this organization" error.  Should I be using different credentials other than my AGOL login, or could the file be made public (like the recent ArcSOC Optimizer is)?  Thanks!

[Tobias_Gerber]

I have the same behaviour and cannot download the ExcelReport.zip. Please make the file public accessible like the recent new version of the ArcSOC Optimizer.

[AndrewSakowicz]

@Mark_Prettyman , @Tobias_Gerber .  Thank you, my mistake.  This is fixed.

[ManojKumar4]

Hey Andrew,
Can we get this functionality added to ArcGIS Monitor site page as it was at 10.8.1 ?

Thanks,

Manoj Kumar

[JamesBratton]

Is this supposed to have the same output as the Excel Report for Monitor 10.8?  I don't see as much information listed.  For instance, on the old version, there was a AGSServiceTr tab.  I don't see this on the current report.  There is a svcReqReceived tab, but it is mostly blank.

[BHK]

Hi 

Thanks for this, and can you please let me know if there is a way that we can specify the output directory  to a Custom path and is there any way that we can automate this using Windows Task Scheduler? if Yes so how can I update the dates in "end_time" for always last 30 days instead of hard coding like 

"year":2024, "month":3, "day":3, "hour":24

[AndrewSakowicz]

1. output directory cannot be changed relative to the executable.  But you can move all folders to any directory.
2. this is a command line tool and can be run through WTS as any other command line.
3. Last 30 days example:

"end_time":  {"now": true,

            "year":2021, "month":10, "day":4, "hour":19} ,

        "past_days":30,

        "past_hours":0,

[BHK]

Thanks Andrew,

So if we have the option of "now": true, and  "past_days":30, or"past_days":15, and Do we still need to explicitly pass these options  "year":2021, "month":10, "day":4, "hour":19 ? what is the point of using them?

[AndrewSakowicz]

if  "now": true,  "year":2021, "month":10, "day":4, "hour":19 is ignored. 

The below examples might help:

Last 30 days from now:

"end_time":  {"now": true,

            "year":2021, "month":10, "day":4, "hour":19} ,

        "past_days":30,

        "past_hours":0,

last 30 days from "year":2021, "month":10, "day":4, "hour":19:

"end_time":  {"now": false,

            "year":2021, "month":10, "day":4, "hour":19} ,

        "past_days":30,

        "past_hours":0,

[MKR]

Is it possible to confirm a list of valid timezones for the excel report tool?

I am looking for BST (British Summer Time)

Thanks!

[SteveMcCarthy]

@AndrewSakowicz 

Few Install/Configure questions:

1. In the SampleConfig.json can the user be anyone with Admin access? 
2. Is this the exact Syntax to run the SampleConfig.json -- 

   ExcelReport.exe -f SampleConfig.json, e.g.?  I assume we remove the , e.g..

   I get this error when I leave it in:  C:\Users\smccarth\OneDrive - Williams\Desktop\ESRI\ArcGIS Monitor\Excel Report\ExcelReport\dist>ExcelReport.exe -f SampleConfig.json, e.g.
   usage: ExcelReport.exe [-h] -f FILE
   ExcelReport.exe: error: unrecognized arguments: e.g.

[AndrewSakowicz]

try to

1. in commend line, cd to the folder where you have ExcelReport, e.g. "C:\Users\smccarth\OneDrive - Williams\Desktop\ESRI\ArcGIS Monitor\Excel\Report\ExcelReport\dist"

 2. execute ExcelReport.exe" -f SampleConfig.json

But this should also work

"C:\Users\smccarth\OneDrive - Williams\Desktop\ESRI\ArcGIS Monitor\Excel\Report\ExcelReport\dist\ExcelReport.exe" -f SampleConfig.json

[ChrisTaylor2]

Hi @AndrewSakowicz, 

My Excel Report hasn't been running since I upgraded to Monitor 2024 last week. I'm on version 20240123.1, and get this error now when I try to run it:

09/16/2024 09:25:16 AM INFO: version:20240123.1
09/16/2024 09:25:16 AM INFO: Start
09/16/2024 09:25:16 AM INFO: Arguments: ExcelReport_config_Prod_1d.json
09/16/2024 09:25:23 AM ERROR: 'properties'
09/16/2024 09:25:23 AM ERROR: None
Traceback (most recent call last):
File "ExcelReport.py", line 14, in main
File "modules\report_builder.py", line 24, in __init__
File "modules\Wkb\wkb_builder.py", line 27, in __init__
File "modules\Wkb\wkb_builder.py", line 117, in _add_component_wks
File "modules\Wks_data\wks_host_specs.py", line 5, in __init__
File "modules\Wks_data\wks_host_specs.py", line 24, in _get_data
KeyError: 'properties'

Thanks for your help.

Chris

[AndrewSakowicz]

@ChrisTaylor2 , thanks for reporting.  The fixed is scheduled to be included in the 2024.1 patch.

[AndrewSakowicz]

@ChrisTaylor2 , FYI, I was able to address issue in Excel Report for ArcGIS Monitor 2024.0 is available on Excel Report for ArcGIS Monitor - Overview