Related to:

Gateway Hub,  API, metrics

Problem:

I am using Gateway Hub, I want to use the API to query metrics however I am having difficulty in finding out what is availble to query I cannot match the available data together is there a way to find out every single metric available ?

Possible solution(s):

It is not possible / recommended to locate every single metric combination, each metric will have its own path and you will have to verify this by using the Web Console.

You will need to run up Gateway Hub Web Console

Example below.

Let us create a use Let us create a use case where we want to extract values for the totalProcesses in the Hardware plugin

Note in the above screenshot under related events you can see the Metric Path - this is important to know and this information can be used in part of your query.

Using POST method (this can be done via Postman or a Curl command for example) the following JSON query would be valid - note your entities should be the name of your Managed Entity - this is again visible in the above screenshot.

{  
   "zoneId":"UTC",
   "filter":{  
      "entities":"itrs.name = \"Generic\"",
      "range":{  
         "from":"2025-03-11T11:00:00Z",
         "to":"2025-03-12T12:00:00Z"
      }
   },
   "metrics":[  
      {  
         "identifier":"totalProcesses",
         "include":[  
            "Hardware:Generic/Hardware/Value/totalProcesses"
         ]
      }
   ],
   "aggregations":[  
      "itrs.avg",
      "itrs.max"
   ],
   "bucketing":{  
      "duration":"PT5M"
   }
}

And expected example output would look like below - this is a short sample of what would be a large amount of data returned

{
"bucket": "2025-03-11T11:10:00Z",
"group": {},
"metrics": {
"totalProcesses": {
"itrs.avg": 172.86666666666667,
"itrs.max": 177
}
}
},

Related article(s):

• https://docs.itrsgroup.com/docs/geneos-gateway-hub/api/api-version/v1alpha/retrieving-data.htm#Overview_..4.

If you need further help:

• Please contact our support team via the chat service box on any of our websites or email us at support@itrsgroup.com.
  
• Make sure you provide us with:
  • Background of the issue or request.
  • Use cases, requirements, business impact, etc.
  • Encountered error messages.
  • Log files or diagnostic files.
  • Screenshots.
  • And other important information relevant to your inquiry.