API: Windows Performance Counter

Custom Collector task object in formatted JSON:

Fields description 

Field Type Description
Task_UID

String

Unique Task ID used by API to distribute gathered monitoring results.

Example:
"Task_UID""c7c6ffb9bae54df1b662fffb72964c77"
CounterCategory

String

A performance counter publishes performance data about an application. Categories include physical components (such as processors, disks, and memory) and system objects (such as processes and threads). System counters that are related to the same performance object are grouped into a category that indicates their common focus. For more information, please visit Microsoft official page .

Example:
"CounterCategory""memory"
CounterInstance

String

In some situations, categories are subdivided into instances, which track data about multiple occurrences of the object that a category relates to. Instances apply to the category as whole, rather than to individual counters. Every counter within a category has each instance defined for the category. For example, the Process category contains instances named Idle and System. Every counter within the Process category thus contains data for each instance, showing information about either idle processes or system processes. For more information, please visit Microsoft official page.

Example:
"CounterInstance"""
CounterName

String

End Counter name

Example:
"CounterName""Available MBytes"
Machine

int32

Data Source can be located either on a local machine (where agent was installed), or at remote machine within LAN:

  • Remote
  • Local
Example:
"Machine""Remote"
MachineAddress

in32

In case “Remote” Data Source was selected, address of the remote machine have to be specified

Example:
"MachineAddress""192.168.1.56"
Agent_UID

String

 Agent UID.

Example:
"Agent_UID""5fc6e5ccf15a44df87c5bdb0cc63cb3e"
Aggregate

String

All received data will be aggregated on a regular basis, according to the adjusted device frequency.

  • Maximum – the highest value from array will be taken
  • Average – value is calculated as an average of all intermediate values
  • Minimum – the lowest value from array will be taken
Example:
"Aggregate""Average"
MaxThreshold int32 Threshold. Exceeding will result alerting

Example:
"MaxThreshold": 0
MinThreshold int32 Threshold. Exceeding will result alerting

Example:
"MinThreshold": 0
IgnoreErrors

String

Each time during “Agent” <–>”Server” interaction Agent asks if there any new counters for Agent to check. In case there are  instructions  to gather stats on new counters Agents starts to gather them. In case NO was selected each failure in Counters polling will be reflected as error in reports, in case YES was selected – failures will be ignored.

Example:
"IgnoreErrors""NO"
Device_Id READ ONLY Field.Unique device id

Example:
"Device_Id": 7647
Id READ ONLY Field.Unique task id

Example:
"Id": 16532
Task_Type_Id Type of the task field. Please check Potential values for “Task_type_id” in appropriate table

Example:
"Task_Type_Id": 63
Name Task name

Example:
"Name""anythingyouwant"