Skip to content

xid / specs

Go to a project
Toggle navigation
Toggle navigation pinning
e0a9673f by Skip Hines
Options

ILP-501 : enhancement to logging AppMetrics added "failure" counts

1 parent ec20d203
Inline Side-by-side
Showing 3 changed files with 36 additions and 78 deletions
ILP/V1.2/IlpSubmissionApi.xid.xml deleted 100644 → 0
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="IlpSubmissionApi.xid">
8 <title>ILP Submission API</title>
9 <comment>
10 This document defines a lightweight Observation Submission API for submitting ILP compatible observation
11 data without invoking the full get position operation.
12 </comment>
13
14 <import ref="https://xid.location.studio/Tensor/V1.1/ApiBase.xid.xml" local="ApiBase.xid.xml" />
15 <import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
16
17 <namespace name="ILP">
18 <using namespace="HPE"/>
19 <using namespace="Tensor"/>
20
21
22 <!-- SubmitInput structure definition.
23 Note: all the tags are defined. These have to
24 match CalculateInput tags of the same name.
25 -->
26 <struct name="PositionInfo" type="InputBase" >
27 <comment>Used as ILP.Submission.PositionInfo input.</comment>
28
29 <elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
30 <comment>
31 Optional position information.\n
32 At least one of observations or state is required,
33 otherwise there is insufficient data to process.
34 </comment>
35 </elem>
36
37 <elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88">
38 <comment>
39 Observation set encoding format. Observations may be passed to the service in
40 an encoding format different than that outer wire format.
41 </comment>
42 </elem>
43
44 <elem name="observations" multiplicity="0..1" type="ObservationSet" encoding ="encObs" ord="89">
45 <comment>
46 Optional Set of observation data encoded in the format specified by encObs.\n
47 At least one of observations or state is required,
48 otherwise there is insufficient data to process.
49 </comment>
50 </elem>
51 </struct>
52
53 <!--
54 *******************************************************
55 Observation Submission API
56 *******************************************************
57 -->
58 <interface name="Submission">
59 <comment>Interface for submitting data to ILP. </comment>
60
61 <operation name="PositionInfo">
62 <comment>
63 Interaction submits position and observation data.\n
64 There is no response besides bearer response codes.
65 </comment>
66 <input name="Input" type="PositionInfo" sid="0x101E"/>
67 </operation>
68 </interface>
69 </namespace>
70 </specification>
Tensor/V1.1/Logging.xid.xml
...@@ -173,6 +173,9 @@ ...@@ -173,6 +173,9 @@
173 <literal name="AppMetrics" value="2"> 173 <literal name="AppMetrics" value="2">
174 <comment>Defines a complex metric measuring duration and concurrency.</comment> 174 <comment>Defines a complex metric measuring duration and concurrency.</comment>
175 </literal> 175 </literal>
176 <literal name="BatchPegCount" value="3">
177 <comment>Defines a batch of values for simple monotonically incremented counter.</comment>
178 </literal>
176 </enum> 179 </enum>
177 180
178 <struct name="Metric"> 181 <struct name="Metric">
...@@ -190,6 +193,17 @@ ...@@ -190,6 +193,17 @@
190 </elem> 193 </elem>
191 </struct> 194 </struct>
192 195
196 <struct name="BatchPegCount" type="Metric" rttkey="Logging.MetricType.BatchPegCount">
197 <comment>Defines a batch of PegCount values at the time granularity.</comment>
198 <elem name="value" type="uint32" multiplicity="1..*" ord="80">
199 <comment>Value of peg count since last granularity.</comment>
200 </elem>
201 <elem name="granularity" type="uint16" multiplicity="1" ord="81">
202 <tag name="unit" value="sec"/>
203 <comment>The time granularity of each value.</comment>
204 </elem>
205 </struct>
206
193 <struct name="AppMetrics" type="Metric" rttkey="Logging.MetricType.AppMetrics"> 207 <struct name="AppMetrics" type="Metric" rttkey="Logging.MetricType.AppMetrics">
194 <elem name="totalCount" type="uint32" multiplicity="1" ord="80"> 208 <elem name="totalCount" type="uint32" multiplicity="1" ord="80">
195 <comment>Total count of invocations since last reporting.</comment> 209 <comment>Total count of invocations since last reporting.</comment>
...@@ -200,22 +214,31 @@ ...@@ -200,22 +214,31 @@
200 <elem name="peakCount" type="uint32" multiplicity="1" ord="82"> 214 <elem name="peakCount" type="uint32" multiplicity="1" ord="82">
201 <comment>Peak concurrent invocations since last reporting.</comment> 215 <comment>Peak concurrent invocations since last reporting.</comment>
202 </elem> 216 </elem>
203 <elem name="totalTime" type="uint64" multiplicity="1" ord="83"> 217 <elem name="successTotalTime" type="uint64" multiplicity="1" ord="83">
204 <comment>Total time spent on invocations in nanoseconds since last reporting.</comment> 218 <tag name="unit" value="nanoseconds"/>
219 <comment>Total time spent on successful invocations since last reporting.</comment>
205 </elem> 220 </elem>
206 <elem name="peakTime" type="uint64" multiplicity="1" ord="84"> 221 <elem name="successPeakTime" type="uint64" multiplicity="1" ord="84">
207 <comment>Peak time for an invocation in nanoseconds since last reporting.</comment> 222 <tag name="unit" value="nanoseconds"/>
223 <comment>Peak time for a successful invocation since last reporting.</comment>
208 </elem> 224 </elem>
209 <elem name="successCount" type="uint32" multiplicity="1" ord="85"> 225 <elem name="successCount" type="uint32" multiplicity="1" ord="85">
210 <comment>Count of successful invocations since last reporting.</comment> 226 <comment>Count of successful invocations since last reporting.</comment>
211 </elem> 227 </elem>
228 <elem name="failureTotalTime" type="uint64" multiplicity="1" ord="87">
229 <tag name="unit" value="nanoseconds"/>
230 <comment>Total time spent on failed invocations since last reporting.</comment>
231 </elem>
232 <elem name="failurePeakTime" type="uint64" multiplicity="1" ord="88">
233 <tag name="unit" value="nanoseconds"/>
234 <comment>Peak time for a failed invocation since last reporting.</comment>
235 </elem>
212 <elem name="failureCount" type="uint32" multiplicity="1" ord="86"> 236 <elem name="failureCount" type="uint32" multiplicity="1" ord="86">
213 <comment>Count of failed invocations since last reporting.</comment> 237 <comment>Count of failed invocations since last reporting.</comment>
214 </elem> 238 </elem>
215 </struct> 239 </struct>
216 240
217 241
218
219 <!-- 242 <!--
220 ******************************************************* 243 *******************************************************
221 Message Structure Definitions 244 Message Structure Definitions
......
Tensor/V1.1/XIDData.prop
...@@ -4,11 +4,15 @@ Ord.Logging.ActionMsg.iid=99 ...@@ -4,11 +4,15 @@ Ord.Logging.ActionMsg.iid=99
4 Ord.Logging.ActionMsg.severity=97 4 Ord.Logging.ActionMsg.severity=97
5 Ord.Logging.AppMetrics.currentCount=81 5 Ord.Logging.AppMetrics.currentCount=81
6 Ord.Logging.AppMetrics.failureCount=86 6 Ord.Logging.AppMetrics.failureCount=86
7 Ord.Logging.AppMetrics.failurePeakTime=88
8 Ord.Logging.AppMetrics.failureTotalTime=87
7 Ord.Logging.AppMetrics.peakCount=82 9 Ord.Logging.AppMetrics.peakCount=82
8 Ord.Logging.AppMetrics.peakTime=84
9 Ord.Logging.AppMetrics.successCount=85 10 Ord.Logging.AppMetrics.successCount=85
11 Ord.Logging.AppMetrics.successPeakTime=84
12 Ord.Logging.AppMetrics.successTotalTime=83
10 Ord.Logging.AppMetrics.totalCount=80 13 Ord.Logging.AppMetrics.totalCount=80
11 Ord.Logging.AppMetrics.totalTime=83 14 Ord.Logging.BatchPegCount.granularity=81
15 Ord.Logging.BatchPegCount.value=80
12 Ord.Logging.DebugInfo.file=64 16 Ord.Logging.DebugInfo.file=64
13 Ord.Logging.DebugInfo.line=65 17 Ord.Logging.DebugInfo.line=65
14 Ord.Logging.DebugInfo.thid=66 18 Ord.Logging.DebugInfo.thid=66
...@@ -25,8 +29,8 @@ Ord.Logging.MetricMsg.metrics=82 ...@@ -25,8 +29,8 @@ Ord.Logging.MetricMsg.metrics=82
25 Ord.Logging.MetricMsg.start=80 29 Ord.Logging.MetricMsg.start=80
26 Ord.Logging.PegCount.value=80 30 Ord.Logging.PegCount.value=80
27 Ord.Logging.TaskReport.duration=114 31 Ord.Logging.TaskReport.duration=114
28 Ord.Logging.TaskReport.start=113
29 Ord.Logging.TaskReport.result=115 32 Ord.Logging.TaskReport.result=115
33 Ord.Logging.TaskReport.start=113
30 Ord.Logging.TaskReport.taskid=112 34 Ord.Logging.TaskReport.taskid=112
31 Ord.Logging.TraceMsg.level=96 35 Ord.Logging.TraceMsg.level=96
32 Ord.Logging.TransactionMsg.acctid=82 36 Ord.Logging.TransactionMsg.acctid=82
...@@ -61,6 +65,7 @@ SID.Tensor.CommandApi.Execute.Input=256 ...@@ -61,6 +65,7 @@ SID.Tensor.CommandApi.Execute.Input=256
61 SID.Tensor.CommandApi.Execute.Output=257 65 SID.Tensor.CommandApi.Execute.Output=257
62 Size.Logging.ActionMsg=-1 66 Size.Logging.ActionMsg=-1
63 Size.Logging.AppMetrics=-1 67 Size.Logging.AppMetrics=-1
68 Size.Logging.BatchPegCount=-1
64 Size.Logging.DebugInfo=-1 69 Size.Logging.DebugInfo=-1
65 Size.Logging.MessageBase=-1 70 Size.Logging.MessageBase=-1
66 Size.Logging.Metric=-1 71 Size.Logging.Metric=-1
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!