{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Use ","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"283b50b8-150d-437a-8ede-7268d7d49ad4"}}]},{"text":"the CDAP Metrics Microservices to retrieve the metrics created and saved by CDAP.","type":"text"}]},{"type":"paragraph","content":[{"text":"As applications process data, CDAP collects metrics about the application’s behavior and performance. Some of these metrics are similar for every application, such as ","type":"text"},{"text":"how many events are processed","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"how many data operations are performed,","type":"text","marks":[{"type":"em"}]},{"text":" and are called ","type":"text"},{"text":"system","type":"text","marks":[{"type":"strong"}]},{"text":" or CDAP metrics.","type":"text"}]},{"type":"paragraph","content":[{"text":"Other metrics are ","type":"text"},{"text":"user-defined","type":"text","marks":[{"type":"strong"}]},{"text":" and differ from application to application. ","type":"text"}]},{"type":"paragraph","content":[{"text":"All methods or endpoints described in this API have a base URL (typically ","type":"text"},{"text":"http://:11015","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"https://:10443","type":"text","marks":[{"type":"code"}]},{"text":") that precedes the resource identifier, as described in the Microservices Conventions. These methods return a status code, as listed in the Microservices Status Codes.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Metrics Data","type":"text"}]},{"type":"paragraph","content":[{"text":"Metrics data is identified by a combination of ","type":"text"},{"text":"context","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"name","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"metrics context","type":"text","marks":[{"type":"strong"}]},{"text":" consists of a collection of tags. Each tag is composed of a ","type":"text"},{"text":"tag name","type":"text","marks":[{"type":"em"}]},{"text":" and a ","type":"text"},{"text":"tag value","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Metrics contexts are hierarchal, rooted in the CDAP instance, and extend through namespaces, applications, and down to the individual components.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, the metrics co","type":"text"},{"text":"ntext:","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"f9a75a7a-05bc-4ec4-9f4b-a4d386f3d5b0"}}]}]},{"type":"codeBlock","content":[{"text":"namespace:default app:PurchaseHistory spark:PurchaseTracker","type":"text"}]},{"type":"paragraph","content":[{"text":"is a context that identifies a Spark program. It has a parent context, ","type":"text"},{"text":"namespace:default app:PurchaseHistory","type":"text","marks":[{"type":"code"}]},{"text":", which identifies the parent application.","type":"text"}]},{"type":"paragraph","content":[{"text":"Each level of the context is described by a pair, composed of a tag name and a value, such as:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"namespace:default","type":"text","marks":[{"type":"code"}]},{"text":" (tag name: ","type":"text"},{"text":"namespace","type":"text","marks":[{"type":"em"}]},{"text":", value: ","type":"text"},{"text":"default","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"app:PurchaseHistory","type":"text","marks":[{"type":"code"}]},{"text":" (tag name: ","type":"text"},{"text":"app","type":"text","marks":[{"type":"em"}]},{"text":", value: ","type":"text"},{"text":"PurchaseHistory","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"spark:PurchaseTracker","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"cd4a74e4-5c85-4c79-87e0-d313eef3e8b2"}},{"type":"code"}]},{"text":" (tag name: ","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"cd4a74e4-5c85-4c79-87e0-d313eef3e8b2"}}]},{"text":"spark","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"cd4a74e4-5c85-4c79-87e0-d313eef3e8b2"}},{"type":"em"}]},{"text":", value: ","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"cd4a74e4-5c85-4c79-87e0-d313eef3e8b2"}}]},{"text":"PurchaseTracker","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"cd4a74e4-5c85-4c79-87e0-d313eef3e8b2"}},{"type":"em"}]},{"text":")","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"cd4a74e4-5c85-4c79-87e0-d313eef3e8b2"}}]}]}]}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"metrics name","type":"text","marks":[{"type":"strong"}]},{"text":" is either a name generated by CDAP, and pre-pended with ","type":"text"},{"text":"system","type":"text","marks":[{"type":"code"}]},{"text":", or is a name set by a developer when writing an application, which are pre-pended with ","type":"text"},{"text":"user","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"system metrics","type":"text","marks":[{"type":"strong"}]},{"text":" vary depending on the context; a list is available of common system metrics for different contexts.","type":"text"}]},{"type":"paragraph","content":[{"text":"User metrics","type":"text","marks":[{"type":"strong"}]},{"text":" are defined by the application developer and thus are completely dependent on what the developer sets.","type":"text"}]},{"type":"paragraph","content":[{"text":"In both cases, searches using this API show, for a given context, all available metrics.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Available Contexts","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"ee994076-1821-44a1-9816-e632e89539ae"}},{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"73e333c5-8d63-4594-a0c3-d7c2335ba9f7"}}]}]},{"type":"paragraph","content":[{"text":"The context of a metric is typically enclosed into a hierarchy of contexts. For example, the Spark context is enclosed in the application context, which in turn is enclosed in the namespace context. A metric can always be queried (and aggregated) relative to any enclosing context.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"e1742539-14b3-4619-8444-093434dd5bb4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"System Metric","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Context","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All Mappers of a MapReduce","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: mapreduce: tasktype:m","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All Reducers of a MapReduce","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: mapreduce: tasktype:r","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"One Run of a MapReduce","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: mapreduce: run:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"One MapReduce","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: mapreduce:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All MapReduce of an application","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: mapreduce:*","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"One service","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: service:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All services of an application","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: service:*","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"One Spark program","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: spark:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All Spark programs of an application","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: spark:*","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"One worker","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: worker:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All workers of an application","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app: workers:*","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All components of an application","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All components of all applications","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: app:*","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Dataset metrics are available at the dataset level, but they can also be queried down to the worker, service, Mapper, or Reducer level:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"24f3fdc2-123d-4c5d-9437-233d8af36141"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Dataset Metric","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Context","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"A single dataset in the context of a specific application","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: dataset: app:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"A single dataset","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: dataset:","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"All datasets","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"namespace: dataset:*","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Available System Metrics","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Note:","type":"text","marks":[{"type":"strong"}]},{"text":" A user metric may have the same name as a system metric. They are distinguished by prepending the respective prefix when querying: ","type":"text"},{"text":"user","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"system","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Dataset Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available in a dataset context:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"0235c79c-c8d3-4842-84e9-5e29adc19cb9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Dataset Metric","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.dataset.store.bytes","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of bytes written","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.dataset.store.ops","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Operations (reads and writes) performed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.dataset.store.reads","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Read operations performed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.dataset.store.writes","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Write operations performed","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Mappers or Reducer Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available in a Mappers or Reducers context (specify whether a Mapper or Reducer context is desired, as shown above):","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"d32b23eb-8689-4295-ab01-5cad5bceec3a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Mappers or Reducers Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.process.completion","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"A number from 0 to 100 indicating the progress of the Map or Reduce phase","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.process.entries.in","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of entries read in by the Map or Reduce phase","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.process.entries.out","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of entries written out by the Map or Reduce phase","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Service Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available in a service context:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"07426e50-23c2-473a-a5a7-c2d37d6e29ad"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Service Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.requests.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of requests made to the service","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.response.successful.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of successful requests completed by the service","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.response.server.error.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of failures seen by the service","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Spark Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available in a Spark context, where ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" depends on the Spark program being queried:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"29ff8d96-3fd8-454b-a76b-10269dd111eb"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Spark Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.BlockManager.disk.diskSpaceUsed_MB","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Disk space used by the Block Manager","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.BlockManager.memory.maxMem_MB","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Maximum memory given to the Block Manager","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.BlockManager.memory.memUsed_MB","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Memory used by the Block Manager","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.BlockManager.memory.remainingMem_MB","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Memory remaining to the Block Manager","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.DAGScheduler.job.activeJobs","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of active jobs","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.DAGScheduler.job.allJobs","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Total number of jobs","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.DAGScheduler.stage.failedStages","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of failed stages","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.DAGScheduler.stage.runningStages","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of running stages","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system..driver.DAGScheduler.stage.waitingStages","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of waiting stages","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request and Response Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available for services, for the system services component context or the user services context:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"9b1fd8ff-77d6-4f9a-a562-84f0126a6a82"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Request and Response Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.request.received","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of requests received for the service","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.response.successful","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of successful responses sent","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.response.{server-error, client-error}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of ","type":"text"},{"text":"server-error","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"client-error","type":"text","marks":[{"type":"code"}]},{"text":" responses sent","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Application Logging Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available for every application context:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"131380bf-7343-49be-9076-e11ee549fdb8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Application Logging Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.app.log.{error, info, warn}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of ","type":"text"},{"text":"error","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"info","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"warn","type":"text","marks":[{"type":"code"}]},{"text":" log messages logged by an application or applications","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"System Services Logging Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These logging metrics are available for system services, in the system component context:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"a5d3f917-657b-4582-9c37-f55214d1a860"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"System Services Logging Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.services.log.{error, info, warn}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of ","type":"text"},{"text":"error","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"info","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"warn","type":"text","marks":[{"type":"code"}]},{"text":" log messages logged by a system service or system services","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"System Services Metric Processor Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These processing metrics are available for system services, in the system component context:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"9f8a98ea-df4d-49b5-bfda-8bec2157eb77"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"System Services Metric Processor Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"metrics..process.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of metrics processed by metric processor instance","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"metrics..process.delay.ms","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Metrics processing delay in milliseconds. Difference between last metric's timestamp and current time","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Transaction Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available for the CDAP transaction service:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"239afec3-a2dd-4e84-a02b-b643b1fcc754"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Transaction Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.start.{short, long}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of ","type":"text"},{"text":"short","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"long","type":"text","marks":[{"type":"code"}]},{"text":" transactions started","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.start.{short, long}.latency","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Time taken (in milliseconds) to start ","type":"text"},{"text":"short","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"long","type":"text","marks":[{"type":"code"}]},{"text":" transactions","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.wal.append.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of transaction edits added to the write-ahead log","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.{canCommit, commit, committed, inprogress, invalidate, abort}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of transactions in a specified transaction state","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.{canCommit, commit, committed, inprogress, invalidate, abort}.latency","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Time taken (in milliseconds) to perform a specified transaction state update","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.{invalid, committing, committed, inprogress}.size","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of transactions of a specified type that are active","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Transactional Messaging System Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available for the CDAP transactional messaging service:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"206483e3-bef6-4b1e-abf9-fe62140ff1a0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Transactional Messaging System Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.persist.requested","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of message persist requests","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.persist.success","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of message persist requests succeeded","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.persist.failure","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of message persist requests failed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.persist.queue.size","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of messages in the queue that are persisted in one batch","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.cache.add.requests","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of entries requested to add to the messaging cache","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.cache.entries.added","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of entries added to the messaging cache","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.cache.entries.removed","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of entries removed from the messaging cache","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.cache.add.reduce.weight","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of times that the cache reduce weight logic was executed while adding entries to the cache. This number ideally should be very small for the cache to have good performance.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.cache.scan.reduce.weight","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of times that the cache reduce weight logic was executed while scanning the cache. This number ideally should be relative small and steady over time.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.cache.scan.requests","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of scan requests on the messaging cache","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.cache.weight","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The current weight of the cache, measured in bytes","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"YARN Cluster Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available for the YARN cluster resources:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"589781cf-3bef-4fd9-8536-62d2bd66dec0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"YARN Cluster Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.resources.{total, available, used}.memory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Size (in megabytes) of total, available, or used cluster memory","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"system.resources.{total, available, used}.vcores","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of total, available, or used cluster virtual cores","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"CDAP Program Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available for CDAP programs:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"e9e05c75-0d39-4964-b851-c07ba300bc01"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"Program Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"Version Introduced","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.program.provisioning.delay.seconds","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Measures time taken by program to transition from provisioning to starting","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.program.starting.delay.seconds","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"6.6.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Measures time taken by program to transition from provisioning to running","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.program.run.seconds","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Measures time taken by program to transition from provisioning to any complete state","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.program.completed.runs","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Number of successful program runs ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.program.failed.runs","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Number of failed programs runs","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.program.killed.runs","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Number of killed program runs","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.program.rejected.runs","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Number of rejected program runs","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.flowcontrol.launching.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"6.6.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Number of top-level program launching requests in the system","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[310.0]},"content":[{"type":"paragraph","content":[{"text":"system.flowcontrol.running.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"6.6.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[343.0]},"content":[{"type":"paragraph","content":[{"text":"Number of running top-level programs in the system","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"User Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"These metrics are available for pipeline connections:","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Pipeline Connection Metrics","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b9e1544c-1549-462d-afdd-9aeb9d0e9aef"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"Pipeline Connection Metrics","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"Version Introduced","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"users.connections.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"6.7.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Number of create connection requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"users.connections.deleted.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"6.7.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Number of delete connection requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"users.connections.get.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"6.7.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Number of get connection requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"users.connections.browse.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"6.7.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Number of browse connection requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"users.connections.sample.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"6.7.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Number of sample connection requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"users.connections.spec.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"6.7.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Number of specification connection requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"users.upload.file.count","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[105.0]},"content":[{"type":"paragraph","content":[{"text":"6.7.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[354.0]},"content":[{"type":"paragraph","content":[{"text":"Number of upload file connection requests.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Query Tips","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Global Count Example","type":"text"}]},{"type":"paragraph","content":[{"text":"POST v3/metrics/query?target=metric&metric=user.connections.count ","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Group By connection Type Example","type":"text"}]},{"type":"paragraph","content":[{"text":"POST v3/metrics/query?target=metric&metric=user.connections.count&groupBy=tpe","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Searches and Queries","type":"text"}]},{"type":"paragraph","content":[{"text":"The process of retrieving a metric involves these steps:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Obtain (usually through a search) the correct context for a metric;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Obtain (usually through a search within the context) the available metrics;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Querying for a specific metric, supplying the context and any parameters.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Search for Contexts","type":"text"}]},{"type":"paragraph","content":[{"text":"To search for the available contexts, perform an HTTP request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/search?target=tag[&tag=]","type":"text"}]},{"type":"paragraph","content":[{"text":"The optional ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" defines a metrics context to search within. If it is not provided, the search is performed across all data. The available contexts that are returned can be used to query for a lower-level of contexts.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also define the query to search in a given context across all values of one or more tags provided in the context by specifying ","type":"text"},{"text":"*","type":"text","marks":[{"type":"code"}]},{"text":" as a value for a tag. See the examples below for its use.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"db2df0e6-3d88-4d1e-8f0c-019f8164ae68"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"context","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"[Optional]","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Metrics context to search within. If not provided, the search is provided across all contexts. Consists of a collection of tags.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"1659df0d-e32c-4514-843a-f5810ec8d028"}}]}]},{"type":"table","attrs":{"layout":"default","localId":"5c48c4fd-4a45-44ee-b207-c6debc2ec974"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/search?target=tag","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"[{\"name\":\"namespace\",\"value\":\"default\"},{\"name\":\"namespace\",\"value\":\"system\"}]","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"Returns all first-level tags; in this case, two namespaces.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/search?target=tag&tag=namespace:default","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"[{\"name\":\"app\",\"value\":\"PurchaseHistory\"},","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" {\"name\":\"component\",\"value\":\"gateway\"},`` {\"name\":\"dataset\",\"value\":\"frequentCustomers\"},``","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"{\"name\":\"dataset\",\"value\":\"history\"},`` {\"name\":\"dataset\",\"value\":\"purchases\"},`` {\"name\":\"dataset\",\"value\":\"userProfiles\"}] ","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"Returns all tags of the of the given parent context; in this case, all entities in the default namespace.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/search?target=tag&tag=namespace:default&tag=app:PurchaseHistory&tag=run:*","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"[","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"{“name”: “spark”, “value”:”PurchaseTracker”}","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"]","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[297.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[463.0]},"content":[{"type":"paragraph","content":[{"text":"Queries all available contexts within the ","type":"text"},{"text":"PurchaseHistory","type":"text","marks":[{"type":"em"}]},{"text":" for any run.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Search for Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"To search for the available metrics within a given context, perform an HTTP POST request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/search?target=metric&tag=","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"1154c1ed-b090-494b-abd1-c34d95f8e1c9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"context","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Metrics context to search within. Consists of a collection of tags.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Example","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"1bec1dc6-f22d-4cef-9a93-5ce246a2917d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/search?target=metric&tag=namespace:default&tag=app:PurchaseHistory","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"[\"system.process.events.in\",\"system.process.events.processed\",\"system.process.instance\", \"system.process.tuples.attempt.read\",\"system.process.tuples.read\"]","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Returns all metrics in the context of the application ","type":"text"},{"text":"PurchaseHistory","type":"text","marks":[{"type":"em"}]},{"text":" of the ","type":"text"},{"text":"default","type":"text","marks":[{"type":"em"}]},{"text":" namespace; in this case, returns a list of system and (possibly) user-defined metrics.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/search?target=metric&tag=namespace:default&tag=app:SportResults&tag=service:UploadService","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"[\"system.dataset.store.ops\",\"system.dataset.store.reads\",\"system.requests.count\", \"system.response.successful.count\", \"user.uploads.completed\"]","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Returns all metrics in the context of the service ","type":"text"},{"text":"UploadService","type":"text","marks":[{"type":"em"}]},{"text":" of the application ","type":"text"},{"text":"SportResults","type":"text","marks":[{"type":"em"}]},{"text":" of the ","type":"text"},{"text":"default","type":"text","marks":[{"type":"em"}]},{"text":" namespace; in this case, returns a list of system and user-defined metrics.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Querying a Metric","type":"text"}]},{"type":"paragraph","content":[{"text":"Once you know the context and the metric to query, you can formulate a request for the metrics data.","type":"text"}]},{"type":"paragraph","content":[{"text":"In general, a metrics query is performed by making an HTTP POST request, with parameters supplied either in the URL or in the body of the request. If you submit the parameters in the body, you can make multiple queries with a single request.","type":"text"}]},{"type":"paragraph","content":[{"text":"Metric parameters include:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"tag values for filtering by context;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"metric names (multiple metric names can be queried in each request);","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"time range or ","type":"text"},{"text":"aggregate=true","type":"text","marks":[{"type":"code"}]},{"text":" for an aggregated result; and","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"tag values for grouping results (optional)","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"To query a metric within a given context, perform an HTTP POST request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=&metric=&[&groupBy=]","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"885554bb-745a-4900-ae12-e148b59fb23b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"context","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Metrics context to search within, a collection of tags","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"metric","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Metric(s) being queried, a collection of metric names","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"time-range","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"A time range or ","type":"text"},{"text":"aggregate=true","type":"text","marks":[{"type":"code"}]},{"text":" for all since the application was deployed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"tags","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"(optional)","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Tag list by which to group results (optional)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Query Examples","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"62e07f49-1563-4b45-a5fe-4eca997efc65"}}]}]},{"type":"table","attrs":{"layout":"default","localId":"07165f3f-56b5-419a-ac06-76611a360b2e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:HelloWorld&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"&metric=system.process.events.processed&aggregate=true","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"{\"startTime\":0,\"endTime\":1429327964,\"series\":[{\"metricName\":\"system.process.events.processed\",\"grouping\":{},\"data\":[{\"time\":0,\"value\":1}]}]}","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Using a ","type":"text"},{"text":"System","type":"text","marks":[{"type":"em"}]},{"text":" metric, ","type":"text"},{"text":"system.process.events.processed","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:HelloWorld&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"&tag=run:13ac3a50-a435-49c8-a752-83b3c1e1b9a8&metric=user.names.bytes&aggregate=true","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"{\"startTime\":0,\"endTime\":1429328212,\"series\":[{\"metricName\":\"user.names.bytes\",\"grouping\":{},\"data\":[{\"time\":0,\"value\":8}]}]}","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Querying the ","type":"text"},{"text":"User-defined","type":"text","marks":[{"type":"em"}]},{"text":" metric ","type":"text"},{"text":"names.bytes","type":"text","marks":[{"type":"em"}]},{"text":" by its run-ID","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:HelloWorld&metric=user.names.bytes","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"{\"startTime\":0,\"endTime\":1429475995,\"series\":[]}","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Using a ","type":"text"},{"text":"User-defined","type":"text","marks":[{"type":"em"}]},{"text":" metric, ","type":"text"},{"text":"names.bytes","type":"text","marks":[{"type":"em"}]},{"text":" in a service's Handler, called before any data entered, returning an empty series","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"HTTP Method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:HelloWorld&&metric=user.names.bytes","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"{\"startTime\":0,\"endTime\":1429477901,\"series\":[{\"metricName\":\"user.names.bytes\",\"grouping\":{},\"data\":[{\"time\":0,\"value\":44}]}]}","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[280.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Using a ","type":"text"},{"text":"User-defined","type":"text","marks":[{"type":"em"}]},{"text":" metric, ","type":"text"},{"text":"names.bytes","type":"text","marks":[{"type":"em"}]},{"text":" in a service's Handler","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Query Results","type":"text"}]},{"type":"paragraph","content":[{"text":"Results from a query are returned as a JSON string, in the format:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\"startTime\":, \"endTime\":, \"series\":}","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"df545fbe-60b9-448e-a8fe-d710fea3e426"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"start-time","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Start time, in seconds, with 0 being from the beginning of the query records","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"metric","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"End time, in seconds","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"series-array","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"An array of metric results, which can be one series, a multiple time series, or none (an empty array)","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"If a particular metric has no value, a query will return an empty array in the ","type":"text"},{"text":"\"series\"","type":"text","marks":[{"type":"code"}]},{"text":" of the results, such as:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\"startTime\":0,\"endTime\":1429475995,\"series\":[]}","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also receive such a result from querying a metric that does not exist, either because it does not exist at the context given or if the query is incorrectly formulated:","type":"text"}]},{"type":"codeBlock","content":[{"text":"...metric=user.names.bytes?aggregate=true","type":"text"}]},{"type":"paragraph","content":[{"text":"will return the empty result, as the metric name will be interpreted as ","type":"text"},{"text":"\"user.names.bytes?aggregate=true\"","type":"text","marks":[{"type":"code"}]},{"text":" instead of ","type":"text"},{"text":"\"user.names.bytes\"","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Querying for Multiple Metrics","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieving multiple metrics at once can be accomplished by issuing an HTTP POST request with a JSON list as the request body that enumerates the name and attributes for each metric. The format of the request and the JSON body depends on whether the metrics share the same context or are being called for different contexts.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Multiple Metrics with the Same Context","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieving multiple metrics at once for the same contexts can be accomplished by issuing a request as in previous examples, but providing the additional metrics. For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=app:CountRandom&metric=system.process.events.processed\n &metric=system.dataset.store.bytes&start=now-5s&count=5","type":"text"}]},{"type":"paragraph","content":[{"text":"The result (pretty-printed to fit) would be:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"startTime\": 1429487786,\n \"endTime\": 1429487791,\n \"series\": [\n {\n \"metricName\": \"system.process.events.processed\",\n \"grouping\": {},\n \"data\": [\n {\"time\": 1429487786, \"value\": 1268},\n {\"time\": 1429487787, \"value\": 1324},\n {\"time\": 1429487788, \"value\": 1206},\n {\"time\": 1429487789, \"value\": 1125},\n {\"time\": 1429487790, \"value\": 1035}\n ]\n },\n {\n \"metricName\": \"system.dataset.store.bytes\",\n \"grouping\": {},\n \"data\": [\n {\"time\": 1429487786,\"value\": 15600},\n {\"time\": 1429487787, \"value\": 14998},\n {\"time\": 1429487788, \"value\": 13712},\n {\"time\": 1429487789, \"value\": 12246},\n {\"time\": 1429487790, \"value\": 9924}\n ]\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Multiple Metrics with Different Contexts","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieving multiple metrics at once for different contexts can be accomplished by issuing a request with a JSON list as the request body that enumerates the name, attributes and context for each metric. Use an HTTP POST request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query","type":"text"}]},{"type":"paragraph","content":[{"text":"with the arguments as a JSON string in the body. The format of the JSON follows this structure (pretty-printed):","type":"text"}]},{"type":"codeBlock","content":[{"text":"{ \"query1\": {\n \"tags\": {\"namespace\": \"default\", \"app\": \"PurchaseHistory\"},\n \"metrics\": [\"metric1\", \"metric2\"],\n \"groupBy\": [\"app\", \"dataset\"],\n \"timeRange\": {\"aggregate\": \"true\"}\n },\n \"query2\": {\n \"tags\": {\"namespace\": \"default\"},\n \"metrics\": [\"metric1\", \"metric2\"],\n \"timeRange\": {\"start\": \"now-2s\", \"end\": \"now\"}\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Queries are identified by a ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" (in the example above, ","type":"text"},{"text":"query1","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"query2","type":"text","marks":[{"type":"em"}]},{"text":"; in the example below, ","type":"text"},{"text":"eventsIn","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"eventsOut","type":"text","marks":[{"type":"em"}]},{"text":"). The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" is then used in the returned result to identify the series.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, to retrieve multiple metrics using a ","type":"text"},{"text":"curl","type":"text","marks":[{"type":"code"}]},{"text":" call (command and results reformatted ","type":"text"},{"text":"to fit):","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"9a303df9-afd6-4bc6-b92b-0efc23375a3e"}}]}]},{"type":"codeBlock","content":[{"text":"$ curl -w'\\n' -X POST 'http://localhost:11015/v3/metrics/query' -H 'Content-Type: application/json' \\\n -d '{\"eventsIn\":{\"tags\": {“app”: “CountRandom”}, \"metrics\": [\"system.process.events.in\"],\n \"timeRange\": {\"start\":\"now-5s\", \"count\":\"5\"} },\n \"eventsOut\":{\"tags\": {“app”: “CountRandom”}, \"metrics\": [\"system.process.events.out\"],\n \"timeRange\": {\"start\":\"now-5s\", \"count\":\"5\"} }\n }'\n\n{\"eventsIn\":{\"startTime\":1429593961,\"endTime\":1429593966,\n \"series\":[{\"metricName\":\"system.process.events.in\",\"grouping\":{},\n \"data\":[{\"time\":1429593961,\"value\":2828},\n {\"time\":1429593962,\"value\":3218},\n {\"time\":1429593963,\"value\":3419},\n {\"time\":1429593964,\"value\":3593},\n {\"time\":1429593965,\"value\":3990}]\n }]\n },\n \"eventsOut\":{\"startTime\":1429593961,\"endTime\":1429593966,\n \"series\":[{\"metricName\":\"system.process.events.out\",\"grouping\":{},\n \"data\":[{\"time\":1429593961,\"value\":3211},\n {\"time\":1429593962,\"value\":3865},\n {\"time\":1429593963,\"value\":3919},\n {\"time\":1429593964,\"value\":3906},\n {\"time\":1429593965,\"value\":3993}]\n }]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"If the context of the requested metric or metric itself doesn't exist, the system returns a status 200 (OK) with JSON formed following the above description, with an empty ","type":"text"},{"text":"series","type":"text","marks":[{"type":"code"}]},{"text":" for values:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\"query1\":{\"startTime\":1429486465,\"endTime\":1429486470,\"series\":[]}}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Querying for Multiple Time Series","type":"text"}]},{"type":"paragraph","content":[{"text":"In a query, the optional ","type":"text"},{"text":"groupBy","type":"text","marks":[{"type":"code"}]},{"text":" parameter defines a list of tags whose values are used to build multiple time series. All data points that have the same values in tags specified in the ","type":"text"},{"text":"groupBy","type":"text","marks":[{"type":"code"}]},{"text":" parameter will form a single time series. You can define multiple tags for grouping by providing a list, similar to a tag combination list.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"17581795-e40c-40d9-9d0b-88a07cadc557"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Tag List","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"groupBy=app","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Retrieves the time series for each application","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"groupBy=app&groupBy=spark","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Retrieves a time series for each App and Spark combination.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"An ","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"a36e2faa-791e-4830-92f3-00c9f8d025b4"}}]},{"text":"example method (re-formatted to fit):","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:PurchaseHistoryTracker&\n groupBy=spark&metric=user.customers.count&start=now-2s&end=now","type":"text"}]},{"type":"paragraph","content":[{"text":"returns the ","type":"text"},{"text":"user.customers.count","type":"text","marks":[{"type":"em"}]},{"text":" metric in the context of the application ","type":"text"},{"text":"PurchaseHistory","type":"text","marks":[{"type":"em"}]},{"text":" of the ","type":"text"},{"text":"default","type":"text","marks":[{"type":"em"}]},{"text":" namespace, for the specified time range, and grouped by spark: PurchaseHistoryTracker (results reformatted to fit):","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"startTime\": 1421188775,\n \"endTime\": 1421188777,\n \"series\": [\n {\n \"metricName\": \"user.customers.count\",\n \"grouping\": { \"spark\": \"PurchaseHistoryTracker\" },\n \"data\": [\n { \"time\": 1421188776, \"value\": 3 },\n { \"time\": 1421188777, \"value\": 2 }\n ]\n },\n {\n \"metricName\": \"user.customers.count\",\n \"grouping\": { \"spark\": \"PurchaseAnalysisTracker\" },\n \"data\": [\n { \"time\": 1421188775, \"value\": 1 },\n { \"time\": 1421188777, \"value\": 2 }\n ]\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Querying by a Time Range","type":"text"}]},{"type":"paragraph","content":[{"text":"The time range of a metric query can be specified in various ways: either ","type":"text"},{"text":"aggregate=true","type":"text","marks":[{"type":"code"}]},{"text":" to retrieve the total aggregated since the application was deployed or, in the case of dataset metrics, since a dataset was created; or as a ","type":"text"},{"text":"start","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"end","type":"text","marks":[{"type":"code"}]},{"text":" to define a specific range and return a series of data points.","type":"text"}]},{"type":"paragraph","content":[{"text":"By default, queries without a time range retrieve a value based on ","type":"text"},{"text":"aggregate=true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b424d2d6-82dc-4ca2-a832-35c7320d6521"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"aggregate=true","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Total aggregated value for the metric since the application was deployed. If the metric is a gauge type, the aggregate will return the latest value set for the metric.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"start=&end=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Time range defined by start and end times, where the times are either in seconds since the start of the Epoch, or a relative time, using ","type":"text"},{"text":"now","type":"text","marks":[{"type":"code"}]},{"text":" and times added to it.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"count=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Number of time intervals since start with length of time interval defined by ","type":"text"},{"text":"resolution","type":"text","marks":[{"type":"em"}]},{"text":". If ","type":"text"},{"text":"count=60","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"resolution=1s","type":"text","marks":[{"type":"code"}]},{"text":", the time range would be 60 seconds in length.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"resolution=[1s|1m|1h|auto]","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Time resolution in seconds, minutes or hours; or if \"auto\", one of ","type":"text"},{"text":"{1s, 1m, 1h}","type":"text","marks":[{"type":"code"}]},{"text":" is used based on the time difference.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"With a specific time range, a ","type":"text"},{"text":"resolution","type":"text","marks":[{"type":"code"}]},{"text":" can be included to retrieve a series of data points for a metric. By default, 1 second resolution is used. Acceptable values are noted above. If ","type":"text"},{"text":"resolution=auto","type":"text","marks":[{"type":"code"}]},{"text":", the resolution will be determined based on a time difference calculated between the start and end times:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(endTime - startTime) > 36000 seconds","type":"text","marks":[{"type":"code"}]},{"text":" (ten hours), resolution will be 1 hour;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(endTime - startTime) > 600 seconds","type":"text","marks":[{"type":"code"}]},{"text":" (ten minutes), resolution will be 1 minute;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"otherwise, resolution will be 1 second.","type":"text"}]}]}]},{"type":"table","attrs":{"layout":"default","localId":"6b64ebdf-68b0-4965-b886-29105b739ffe"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Time Range","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"start=now-30s&end=now","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The last 30 seconds. The start time is given in seconds relative to the current time. You can apply simple math, using ","type":"text"},{"text":"now","type":"text","marks":[{"type":"code"}]},{"text":" for the current time, ","type":"text"},{"text":"s","type":"text","marks":[{"type":"code"}]},{"text":" for seconds, ","type":"text"},{"text":"m","type":"text","marks":[{"type":"code"}]},{"text":" for minutes, ","type":"text"},{"text":"h","type":"text","marks":[{"type":"code"}]},{"text":" for hours and ","type":"text"},{"text":"d","type":"text","marks":[{"type":"code"}]},{"text":" for days. For example: ","type":"text"},{"text":"now-5d-12h","type":"text","marks":[{"type":"code"}]},{"text":" is 5 days and 12 hours ago.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"start=1385625600&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"end=1385629200","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"Thu, 28 Nov 2013 08:00:00 GMT","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"Thu, 28 Nov 2013 09:00:00 GMT","type":"text","marks":[{"type":"code"}]},{"text":", both given as since the start of the Epoch.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"start=1385625600&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"count=3600&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"resolution=1s","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The same as before, the count given as a number of time intervals, each 1 second.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"start=1385625600&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"end=1385629200&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"resolution=1m","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"Thu, 28 Nov 2013 08:00:00 GMT","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"Thu, 28 Nov 2013 09:00:00 GMT","type":"text","marks":[{"type":"code"}]},{"text":", with 1 minute resolution, will return 61 data points with metrics aggregated for each minute.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"start=1385625600&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"end=1385632800&","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"resolution=1h","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"Thu, 28 Nov 2013 08:00:00 GMT","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"Thu, 28 Nov 2013 10:00:00 GMT","type":"text","marks":[{"type":"code"}]},{"text":", with 1 hour resolution, will return 3 data points with metrics aggregated for each hour.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:CountRandom&\n metric=system.process.events.processed&start=now-1h&end=now&resolution=1m","type":"text"}]},{"type":"paragraph","content":[{"text":"This will return the value of the metric ","type":"text"},{"text":"system.process.events.processed","type":"text","marks":[{"type":"em"}]},{"text":" for the last hour at one-minute intervals.","type":"text"}]},{"type":"paragraph","content":[{"text":"For aggregates, you cannot specify a time range. As an example, to return the total number of input objects processed since the application ","type":"text"},{"text":"CountRandom","type":"text","marks":[{"type":"em"}]},{"text":" was deployed, assuming that CDAP has not been stopped or restarted:","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:CountRandom\n &metric=system.process.events.processed&aggregate=true","type":"text"}]},{"type":"paragraph","content":[{"text":"If a metric is a gauge type, the aggregate will return the latest value set for the metric. For example, this request will retrieve the completion percentage for the map-stage of the MapReduce ","type":"text"},{"text":"PurchaseHistoryBuilder","type":"text","marks":[{"type":"code"}]},{"text":" (reformatted to fit):","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:PurchaseHistory\n &tag=mapreduce:PurchaseHistoryBuilder&tage=tasktype:m&metric=system.process.completion&aggregate=true\n\n{\"startTime\":0,\"endTime\":1429497700,\"series\":[{\"metricName\":\"system.process.completion\",\n \"grouping\":{},\"data\":[{\"time\":0,\"value\":100}]}]}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Querying by Run-ID","type":"text"}]},{"type":"paragraph","content":[{"text":"Each execution of a program (MapReduce, Spark, service, worker) has an associated run-ID that uniquely identifies that program's run. We can query metrics for a program by its run-ID to retrieve the metrics for a particular run. Please see the ","type":"text"},{"text":"Run Records and Schedule","type":"text","marks":[{"type":"link","attrs":{"href":"https://cdap.atlassian.net/wiki/spaces/DOCS/pages/477560983/Lifecycle+HTTP+RESTful+API"}}]},{"text":" on retrieving active and historical program runs.","type":"text"}]},{"type":"paragraph","content":[{"text":"When querying by ","type":"text"},{"text":"run-ID","type":"text","marks":[{"type":"code"}]},{"text":", it is specified in the context—in the collection of tags—after the ","type":"text"},{"text":"program-id","type":"text","marks":[{"type":"code"}]},{"text":" with the tag ","type":"text"},{"text":"run","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"...app:&tag=:&tag=run:","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples of using a run-ID (with both commands and results re","type":"text"},{"text":"formatted to fit):","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"c05110e0-c1b4-4d37-952e-17837539a1cf"}}]}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:PurchaseHistory&tag=mapreduce:\n PurchaseHistoryBuilder&tag=run:453-454-447683&tag=tasktype:m&metric=system.process.completion\n\n{\"startTime\":0,\"endTime\":1429498425,\"series\":[{\"metricName\":\"system.process.completion\",\n \"grouping\":{},\"data\":[{\"time\":0,\"value\":100}]}]}","type":"text"}]},{"type":"paragraph","content":[{"text":"The last example will return (where ","type":"text"},{"text":"\"time\"=0","type":"text","marks":[{"type":"code"}]},{"text":" means aggregated total number, and ","type":"text"},{"text":"endTime","type":"text","marks":[{"type":"code"}]},{"text":" is the time of the query) something similar to:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\"startTime\":0,\"endTime\":1421188775,\"series\":[{\"metricName\":\"system.process.events.processed\",\n \"grouping\":{},\"data\":[{\"time\":0,\"value\":11188}]}]}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Query Tips","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"46f6b911-1124-46ae-b384-a9b744a0a27c"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"User-defined metrics are always prefixed with the word ","type":"text"},{"text":"user","type":"text","marks":[{"type":"code"}]},{"text":", and must be queried by using that prefix with the metric name.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, to request the user-defined metric ","type":"text"},{"text":"uploads.completed","type":"text","marks":[{"type":"em"}]},{"text":" for the ","type":"text"},{"text":"SportResults","type":"text","marks":[{"type":"em"}]},{"text":" application's ","type":"text"},{"text":"UploadService","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"POST /v3/metrics/query?tag=namespace:default&tag=app:SportResults\n &tag=service:UploadService&metric=user.uploads.completed&aggregate=true","type":"text"}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported