{"type":"api","title":"LoadMetrics of all Collectors given DataGateway Id","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6b43769d-1510-3f45-b02b-565431ba0bf6","info":{"title":"Crosswork Data Gateway Load Metrics API","description":"This document details Crosswork Data Gateway APIs you can use to get load metrics of the datagateway","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CDG/cdg_load_metrics_api_overview.md"}},"swagger":"2.0","basePath":"/crosswork/dg-manageri/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer Auth Token"}}},"spec":{"description":"Get Load Metrics of CDG","summary":"LoadMetrics of all Collectors given DataGateway Id","operationId":"GetLoadMetrics","deprecated":false,"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"Content-Type","in":"header","required":true,"type":"string","description":"application/json"},{"name":"Body","in":"body","required":true,"description":"Request payload to get load metrics of CDG","schema":{"title":"GetLoadMetricsQueryRequest","example":{"queryParams":[{"field":"DGID","value":{"valueStr":"a9191f1f-9750-43d1-8581-6cbd3727d1d0"}}]},"type":"object","properties":{"queryParams":{"type":"array","items":{"title":"QueryParam","example":{"field":"cdgId","value":{"valueStr":"a3ca0192-334d-474a-8290-2e5a24aae083"}},"type":"object","properties":{"field":{"type":"string"},"value":{"title":"Value","example":{"valueStr":"a3ca0192-334d-474a-8290-2e5a24aae083"},"type":"object","properties":{"valueStr":{"type":"string"}},"required":["valueStr"],"$$ref":"#/definitions/Value"}},"required":["field","value"],"$$ref":"#/definitions/QueryParam"}}},"required":["queryParams"],"$$ref":"#/definitions/GetLoadMetricsQueryRequest"}}],"responses":{"200":{"description":"OK","schema":{"title":"GetLoadMetricsQueryResponse","example":{"cdgLoadMetrics":[{"loadMetricsId":"f6983dbc-670d-43dd-989b-9f00e3058bf5","cdgId":"a9191f1f-9750-43d1-8581-6cbd3727d1d0","timestamp":"1649868822","collectorLoadMetrics":[{"loadMetricsId":"f6983dbc-670d-43dd-989b-9f00e3058bf5","collectorName":"mdt-collector","loadScore":26,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":40290,"totalGcHeapMemoryKb":122880,"usedContainerMemoryMb":313.9,"allocatedContainerMemoryMb":5120,"containerMemoryPercentage":6.13,"containerCpuPercentage":0.14,"collectorLoadMetricsId":"84672"}]}]},"type":"object","properties":{"cdgLoadMetrics":{"type":"array","items":{"title":"LoadMetricsData","example":{"loadMetricsId":"f6983dbc-670d-43dd-989b-9f00e3058bf5","cdgId":"a9191f1f-9750-43d1-8581-6cbd3727d1d0","timestamp":"1649868822","collectorLoadMetrics":[{"loadMetricsId":"f6983dbc-670d-43dd-989b-9f00e3058bf5","collectorName":"mdt-collector","loadScore":26,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":40290,"totalGcHeapMemoryKb":122880,"usedContainerMemoryMb":313.9,"allocatedContainerMemoryMb":5120,"containerMemoryPercentage":6.13,"containerCpuPercentage":0.14,"collectorLoadMetricsId":"84672"}]},"type":"object","properties":{"loadMetricsId":{"type":"string"},"cdgId":{"type":"string"},"timestamp":{"type":"string"},"collectorLoadMetrics":{"type":"array","items":{"title":"CollectorLoadMetricsData","example":{"loadMetricsId":"f6983dbc-670d-43dd-989b-9f00e3058bf5","collectorName":"mdt-collector","loadScore":26,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":40290,"totalGcHeapMemoryKb":122880,"usedContainerMemoryMb":313.9,"allocatedContainerMemoryMb":5120,"containerMemoryPercentage":6.13,"containerCpuPercentage":0.14,"collectorLoadMetricsId":"84672"},"type":"object","properties":{"loadMetricsId":{"type":"string"},"collectorName":{"type":"string"},"loadScore":{"type":"integer"},"noOfSkippingCadence":{"type":"integer"},"dispatchQueueSize":{"type":"integer"},"noOfDelayedCadence":{"type":"integer"},"noOfJobsReceived":{"type":"integer"},"noOfStatusSent":{"type":"integer"},"noOfFailedDestinations":{"type":"integer"},"usedGcHeapMemoryKb":{"type":"integer"},"totalGcHeapMemoryKb":{"type":"integer"},"allocatedContainerMemoryMb":{"type":"integer"},"containerMemoryPercentage":{"type":"number"},"containerCpuPercentage":{"type":"number"},"collectorLoadMetricsId":{"type":"string"}},"$$ref":"#/definitions/CollectorLoadMetricsData"}}},"$$ref":"#/definitions/LoadMetricsData"}}},"$$ref":"#/definitions/GetLoadMetricsQueryResponse"},"examples":{"application/json":{"cdgLoadMetrics":[{"loadMetricsId":"44810b95-29ca-4114-a152-0b4804798c7b","cdgId":"a3ca0192-334d-474a-8290-2e5a24aae083","timestamp":"1745383734","collectorLoadMetrics":[{"loadMetricsId":"44810b95-29ca-4114-a152-0b4804798c7b","collectorName":"mdt-collector","loadScore":10,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":85218,"totalGcHeapMemoryKb":112640,"usedContainerMemoryMb":373.4,"allocatedContainerMemoryMb":5120,"containerMemoryPercentage":7.29,"containerCpuPercentage":0.01,"collectorLoadMetricsId":"151679"},{"loadMetricsId":"44810b95-29ca-4114-a152-0b4804798c7b","collectorName":"snmp-collector","loadScore":24,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":1103151,"totalGcHeapMemoryKb":3420160,"usedContainerMemoryMb":3897.344,"allocatedContainerMemoryMb":10240,"containerMemoryPercentage":38.06,"containerCpuPercentage":1.54,"collectorLoadMetricsId":"151680"},{"loadMetricsId":"44810b95-29ca-4114-a152-0b4804798c7b","collectorName":"gnmi-collector","loadScore":10,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":87256,"totalGcHeapMemoryKb":159744,"usedContainerMemoryMb":541.3,"allocatedContainerMemoryMb":10240,"containerMemoryPercentage":5.29,"containerCpuPercentage":0.02,"collectorLoadMetricsId":"151681"},{"loadMetricsId":"44810b95-29ca-4114-a152-0b4804798c7b","collectorName":"cli-collector","loadScore":12,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":269655,"totalGcHeapMemoryKb":405504,"usedContainerMemoryMb":884.8,"allocatedContainerMemoryMb":9216,"containerMemoryPercentage":9.6,"containerCpuPercentage":0.02,"collectorLoadMetricsId":"151682"},{"loadMetricsId":"44810b95-29ca-4114-a152-0b4804798c7b","collectorName":"syslog-collector","loadScore":10,"noOfDelayedCadence":0,"noOfSkippingCadence":0,"dispatchQueueSize":0,"noOfJobsReceived":0,"noOfStatusSent":0,"noOfFailedDestinations":0,"usedGcHeapMemoryKb":92610,"totalGcHeapMemoryKb":112640,"usedContainerMemoryMb":402.4,"allocatedContainerMemoryMb":5120,"containerMemoryPercentage":7.86,"containerCpuPercentage":0.01,"collectorLoadMetricsId":"151683"}]}]},"headers":{}}},"500":{"description":"Internal Server Error"}},"security":[],"__originalOperationId":"GetLoadMetrics","method":"post","path":"/device/load-metrics/query"}}