{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/42552ab7-d679-37b0-afe0-7313ad2e8c01","info":{"title":"Service Health Heuristic Packages APIs","description":"APIs for requesting rule and metric data stored by the Crosswork Service Health application.","termsOfService":"terms-of-service","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"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/ServiceHealth/sh_heuristic_packages_overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/aa/hpmgr"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security token for authorizing requests for these APIs.","name":"Authorization","in":"header"}}},"spec":{"type":"object","properties":{"sensor_path_exact":{"description":"Exact YANG path of the subtree to get the current metric.\n Examples:\n * `openconfig-interfaces:interfaces/interface[name=GigabitEthernet0/0/0/2]/\n subinterfaces/subinterface[index=600]/state/admin-status`\n (subtree of one node) the administrative status of subinterface 600 of interface GigabitEthernet0/0/0/2\n * `openconfig-interfaces:interfaces/interface[name=tunnel-ip13]/state/counters`\n (subtree of height one) all counters of interface tunne-ip13\n * `openconfig-interfaces:interfaces/interface[name=tunnel-ip13]/state/counters/in-errors`\n (subtree of one node) the number of input errors on ineterface tunnel-ip13","type":"string"},"sensor_path_config":{"description":"Longest prefix for which the target router will actually return some value when configured.\n Example: configuring the sensor path on a IOS-XRV router\n `openconfig-interfaces:interfaces/interface[name=tunnel-ip13]/state/counters/in-errors`\n will not work (not resolved). However, configuring the sensor path\n `openconfig-interfaces:interfaces/interface[name=tunnel-ip13]/state/counters`\n will return a bag contaning the wanted value. The pipeline would then retrieve the specific leaf under this subtree (in this case, the value of `in-errors`) and assign it to the metric.\nIn Crosswork, there is a limitation on the number of collection jobs that can be supported. Currently, the limit is about 1000 jobs. Because of this, Service Health needs to subscribe at the gather path level and perform filtering on the resultant metric bag to get to the desired leaf that corresponds to the given metric.\nHence, for all deployment purposes, this field should be set to a valid gather path. In the current example, that would be `openconfig-interfaces:interfaces/interface`.","type":"string"}},"description":"Metric collected using telemetry plugin.","$$ref":"#/components/schemas/MetricImplMdtMetric","title":"MetricImplMdtMetric"}}