Configuring Responder
Telemetry Service Descriptions

Version: 10.2.1c and 10.2.1c SP3

Resource Center Home

In the table below, the values of the Category column refer to:

  • Database: Metric capturing time to perform an insert, update, delete, or read on the database
  • Detail: Metric capturing one specific element of a process in the code
  • Service: Metric capturing service performance on a server machine
  • User: Metric based on performance of a specific Responder function that an end user would experience
Telemetry Item Category Description
ArchiveExplorer.GenerateReport User Occurs when the user selects Archive Report and clicks Generate Report in Archive Explorer. The telemetry value represents the time to generate the specified report. Gives information about report type - report name. Next to this telemetry value is always additional information with report request details - request and data filter.
ArchiveExplorer.Refresh User Occurs when the user clicks Refresh in Archive Explorer. The telemetry value represents the length of time to perform a full refresh per grid. Gives information about the Refresh appling to Incidents Archive or Tag Archive data and information about number of refreshed rows.
ArchiveIncidents.GetIncidentData Detail Occurs as part of ArchiveIncidents. The telemetry value represents the length of time to perform reaching history data from database. Gives more details about the Incident for archiving and applied filters.
ArchiveIncidents.InternalArchive Detail Occurs as part of ArchiveIncidents. The telemetry value represents the length of time to perform archiving data. Gives more details about number of archived Incidents.
ArchiveServices.ApplyPostSubmitRules Detail Occurs as part of ArchiveServices.Submit. The telemetry value represents the length of time to perform PostSubmit rules.
ArchiveServices.ApplyPreSubmitRules Detail Occurs as part of ArchiveServices.Submit. The telemetry value represents the length of time to perform PreSubmit rules.
ArchiveServices.ArchiveIncidents Service Occurs when an Incident is closed. If Archive Service is started, Data Service sends a request to Archive Service. The telemetry value represents the length of time to perform archiving incidents.
ArchiveServices.ArchiveTags Service Occurs when a Tag is removed. If Archive Service is started, Data Service sends a request to Archive Service. The telemetry value represents the length of time to perform archiving tags.
ArchiveServices.Submit Service Occurs after changing an Incident or a Tag in Archive Explorer. The telemetry value represents the length of time to perform applying submit rules to changed data before writing to database.
BuildArchive.Incidents Detail Occurs when the user click Build Archive in Archive Explorer. The telemetry value represents the time it takes to build the Incidents archive from history tables.
BuildArchive.Tags Detail Occurs when the user click Build Archive in Archive Explorer. The telemetry value represents the time it takes to build the Tags archive from history tables.
CallManagement.EnsureReferentialIntegrity Detail Captures duration of loading missing tables (RX_INCIDENTS and RX_INCIDENT_DEVICES). It is called when call is associated to incident (in prediction and some submit rules).
CancelIncident.Complete User Occurs when cancelling an incident in Responder Explorer. The telemetry value represents the time it takes from when user clicks on the OK\Cancel button to the moment when operation is finished and UI is available.
CancelIncident.Open User Occurs when cancelling an incident Responder Explorer. The telemetry value represent the time it takes to open the cancel incident dialog.
ChangeQuery User Occurs when the user changes a query in Archive Explorer (example, switch to "Incidents by Region"). The telemetry value represents the length of time to perform refreshing grid according new query. Gives information about chosen query and query criteria.
CleanupIncidentDeviceErrors.EnsureReferentialIntegrity Detail Captures duration for this method. It loads missing tables into dataset. It is called from CleanupIncidentDeviceErrors submit rule.
CleanupIncidentDeviceErrors.QueryForExistingIncidentDevice Detail Captures duration for this method. It is called from CleanupIncidentDeviceErrors submit rule.
CloseIncident.Complete User Occurs when closing an incident in Responder Explorer. The telemetry value represents the time from the user clicking OK/Cancel to when the incident is closed and UI is available again.
CompleteIncident.Complete User Occurs when the Complete Incident operation is run. The telemetry value represents the time it takes from when user runs the Complete incident command to the moment when incident is completed in grid and UI is available again.
Database.ExecuteNonQuery Database Records the SQL (insert, update, delete) text and how long each query takes to execute.
Database.ExecuteScalar Database Records the SQL query text and how long each query takes to execute.
Database.ExecuteReader Database Records the SQL query text and how long each query takes to execute.
Database.ExecuteDataTable Database Records the SQL query text and how long each query takes to execute.
DataManager.RefreshAll Detail Captures the duration of a full (manual) refresh. This is different from ResponderExplorer.ManualRefresh as this can get called even when the user doesn't ask for it - as when an optimistic concurrency issue happens during a submit and the client needs a refresh of data.
DataManager.Submit Detail Occurs when a DataSet is "submitted" to DataServices for processing.
DataManager.PartialRefresh Detail Captures the duration of a partial refresh (sometimes referred to as "soft refresh"). Is the outer-most one and most closely matches the "soft refresh" user experience metric. It is called in 3 places, including soft refresh, full refresh, and in some conditions during a submit.
DataManager.Reinitialize Detail Captures the duration of a "reinitialize" (a heavier-weight refresh than "refresh all")
DataServices.ApplyPostSubmitRules Detail Occurs as part of DataService. The telemetry value represents the time it takes to process all post-submit rules.
DataServices.ApplyPreSubmitRules Detail Occurs as part of DataService. The telemetry value represents the time it takes to process all pre-submit rules.
DataServices.ExecuteRequest Service Records the length of time each DataRequest takes to execute. The telemetry value indicates the length of time (in seconds) and the message (description) indicates the name of the DataRequest. DataRequests that take less than 1 second may not be recorded.
DataServices.SubmitForPrediction Detail Captures how long it takes to process the submitted DataSet and send the resulting information to PredictionServices.
DataServices.Submit Service The common method called by both IDataServices.Submit and SubmitDataRequest.
DataServicesProxy.ExecuteRequest Detail Captures how long a client waits (client-side) for DataServices.ExecuteRequest to be called. The difference between this telemetry and DataServices.ExecuteRequest includes network time.
DataWriter.Write.Added Detail Captures the duration of adding rows to Data Services and how many rows were created. This does not include post-processing time.
DataWriter.Write.Deleted Detail Captures the duration of removing rows from Data Services and how many rows were removed. This does not include post-processing time.
DataWriter.Write.Modified Detail Captures the duration of editing rows in Data Services and how many rows were changed. This does not include post-processing time.
ExplorerData.ApplyPubSubChanges Detail Captures the duration of applying pub/sub changes.
GenerateReport.ExportToXML Detail Occurs on Generate Report in Archive Explorer. Represents time for serializing dataset (QueriesHelper.GenerateDataSet) to XML file.
GenerateReport.Transform Detail Occurs on Generate Report in Archive Explorer. Represents time for applying XSLT transformation to XML file (GenerateReport.ExportToXML exported file).
IDM.FindFeedPath Detail IDM find feed path.
IDM.FindModifiedElements Detail IDM find modified elements, this will get the energized and deenergized elements in IDM.
IDM.GetDownstreamConfirmedSPIs Detail Occurs as part of DataService. Occurs if current processing device is loadpoint. Includes trace for finding all devices which are not services points with confirmed incidents, and than by getting difference with all devices (deenegized\energized) gets downstream confirmed SPIs.
IDM.HandleDifferentlyEnergizedElements Detail Occurs as part of DataService. Occurs when currently processing device causes that some downstream devices are differently energized.
IDM.ProcessCanceledOrDeletedDevice Detail Occurs as part of DataService. Occurs when currently processing device is deleted or cancelled.
IDM.ProcessDevice Detail Occurs as part of DataService. Occurs when a device is added, deleted or modified. The telemetry value represents the time to do processing device in IDM.
IDM.RollUp Detail Occurs as part of DataService. Occurs when incident of currently processing device is rolled up.
IDM.SelectResponsibleStopperDeviceRow Detail Occurs as part of DataService. Occurs when currently processing device has newly energized or deenergized phases and no new loadpoints.
IDM.SharedIncidentLoadpoints Detail Captures duration of this IDM processing part. Occurs when a loadpoint already exists for other incidents.
IDM.UpdateIncidentCustcounts Detail Occurs as part of DataService. Occurs when customer count on incident of processing device should be updated.
IDMLoadpointsHelper.ProcessDeEnergizedLPs Detail Captures duration of this IDM processing part.
IDMLoadpointsHelper.ProcessLoadpointsAndTransformers Detail Captures duration of this IDM processing part.
IncidentDevice.IsDeviceUnderInfluenceOfDifferentIncident Detail Captures duration of this IDM processing part.
Prediction.AnalyzeCalls Detail "Analyze calls" command in Responder Explorer results in creation of AnalyzeCallsRequest and asynchronous call of AnalyzeCalls method on Prediction Service. Telemetry result contains elapsed time and number of calls processed during that period.
Prediction.CalculateImmediateChildOutageRatio Detail Captures duration for this method.
Prediction.CreateOrModifyExistingIncident Detail Occurs in InternalPrediction.AnalyzeCall. This measurement gives better understanding why some AnalyzeCall takes more or less time.
Prediction.Predict Detail Occurs in couple events - AnalyzeCalls and PredictOnDataset (these two events are measuring separately as well). Telemetry log contains resulted device - "predicted device" information, if predicted device exists, otherwise just time value.
Prediction.PredictOnDataSet Detail Predict on dataset is calling asynchronously and if input dataset is not "marked" as predicted than it goes in this procedure.
Prediction.SubmitAsProbableStateCandidate Detail Occurs as part of PredictOnDataset event and Probable state polling extension (periodical checking). If probableStateCandidateElevationTime (Threshold Info attribute) expires then all devices which are candidates for changing state to Probable will be processed in this method.
PredictionServices.AnalyzeCalls Detail "Analyze calls" command in Responder Explorer results in creation of AnalyzeCallsRequest and asynchronous call of AnalyzeCalls method on Prediction Service. Telemetry represents full time for precessing all submitted calls and gives number of calls processed in this period.
QueriesHelper.GenerateDataSet Detail Occurs on Generate Report in Archive Explorer. Telemetry log represents time for generating dataset for specified report and also show additional information about report query.
QueryService.ExecuteRequest Service The length of time it takes to execute a DataRequest in Query Services.
QueryServicesLocalProxy.ExecuteRequest Detail This is a QueryServices local proxy (for use inside QS) and indicates how long it takes to call ExecuteRequest. This is used for DataRequests that call other DataRequests inside QueryServices.
RegionModeAssignment.GetRegionModeAssignmentList Detail Occurs when Region Mode Assignments is initializing first time or after RegionModeAssignment multicast event handler clear cache. Telemetry value represents the length of time for initializing Region Mode Assignments.
ResponderExplorer.ManualRefresh User Occurs when the user clicks Refresh in Responder Explorer. The telemetry value represents the length of time to perform a full refresh.
ResponderExplorer.StartupTime User Occurs during the startup of Responder Explorer. The telemetry value represents the time it takes to start Responder Explorer.
SubmitDataWriter.Write Detail Records the length of time it takes to record (local) changes in the DataSet to the database. This includes some number of insert, update, and delete statements.
SubmitRule.ApplyRule Detail Records the duration of executing a particular submit rule. This event is only recorded for operations that take longer than 1 second.
Tracing.FindFeedPath Detail General Find Feed Path.
Tracing.DownStreamTrace Detail General Find DownsStream Trace.
Tracing.FindChildDevices Detail Find Child devices below a device.
UpgradeArchive.Incidents User Occurs when the user clicks Upgrade Archive in Archive Explorer. The telemetry value represents the time it takes to upgrade archive according history data.

Responder Web Telemetry

Telemetry Item
MapRegionInformation.CollectInformation
CustomerSearch.CustomerDataProvider
CustomerSearch.CustomerInputInitialize
CustomerCallSubmit.CustomerSubmit
CustomerLocationCall.LocationSubmit
Callback Submittal
SwitchOrderRequest.FindSwitchingOrderRequests
Switch Order Request Submittal
Switch Order Request Complete with No Devices
Switch Order Request Edit
Switch Order Request Cancel
Set Prediction Mode (GetPredictionThresholdInfo, GetPredictionThresholdInfo)
Set ETR
Set Role Assignment
UserCreate
UserUpdate
UserDelete
UpdateUserRoles
Role.CreateNewRole
RoleEdit.AddRoleTask
Role.DeleteRole
RoleEdit.RemoveRoleTask
Task.CreateNewTask
Tasks Edited
Task.DeleteTask
Operation.CreateOperation
Operation.DeleteOperation
UpdateUserInformation

 

 


Send Comment to ArcFMdocumentation@schneider-electric.com