Skip to content

Commit

Permalink
add json examples about metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
Alvaro Vega committed Jan 23, 2017
1 parent c98d0e4 commit 3067dc0
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -980,7 +980,15 @@ In the cases where "serviceId" is part of URL "SERVICE_NAME" field at body can b

## Metrics [/v1.0/admin/metrics]

The following metrics are collected by the component:
+ incomingTransactions: number of requests consumed by the component.
+ incomingTransactionRequestSize: total size (bytes) in requests associated to incoming transactions
+ incomingTransactionResponseSize: total size (bytes) in responses associated to incoming transactions
+ incomingTransacionError: number of incoming transactions resulting in error.
+ serviceTime: average time to serve a transaction.

### Get current metrics [GET]

+ Parameters
+ reset (optional, `string`) ... ["true", "false"]
+ Response 200 (application/json)
Expand All @@ -1002,7 +1010,17 @@ In the cases where "serviceId" is part of URL "SERVICE_NAME" field at body can b
"sum": {}
}
},
"sum": {}
"sum": {
"incomingTransactions": 25,
"incomingTransactionRequestSize": 3456,
"incomingTransactionResponseSize": 435,
"incomingTransacionError": 2,
"serviceTime": 0.48,
"outgoingTransactions": 46,
"outgoingTransactionRequestSize": 323361,
"outgoingTransactionResponseSize": 2343,
"outgoingTransacionError": 10
}
}


Expand All @@ -1027,5 +1045,15 @@ In the cases where "serviceId" is part of URL "SERVICE_NAME" field at body can b
"sum": {}
}
},
"sum": {}
"sum": {
"incomingTransactions": 25,
"incomingTransactionRequestSize": 3456,
"incomingTransactionResponseSize": 435,
"incomingTransacionError": 2,
"serviceTime": 0.48,
"outgoingTransactions": 46,
"outgoingTransactionRequestSize": 323361,
"outgoingTransactionResponseSize": 2343,
"outgoingTransacionError": 10
}
}

0 comments on commit 3067dc0

Please sign in to comment.