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
<?xml version="1.0" encoding="UTF-8" ?>
<specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
identity="IlpSubmissionApi.xid">
<title>ILP Submission API</title>
<comment>
This document defines a lightweight Observation Submission API for submitting ILP compatible observation
data without invoking the full get position operation.
</comment>
<import ref="https://xid.location.studio/Tensor/V1.1/ApiBase.xid.xml" local="ApiBase.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<namespace name="ILP">
<using namespace="HPE"/>
<using namespace="Tensor"/>
<!-- SubmitInput structure definition.
Note: all the tags are defined. These have to
match CalculateInput tags of the same name.
-->
<struct name="PositionInfo" type="InputBase" >
<comment>Used as ILP.Submission.PositionInfo input.</comment>
<elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
<comment>
Optional position information.\n
At least one of observations or state is required,
otherwise there is insufficient data to process.
</comment>
</elem>
<elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88">
<comment>
Observation set encoding format. Observations may be passed to the service in
an encoding format different than that outer wire format.
</comment>
</elem>
<elem name="observations" multiplicity="0..1" type="ObservationSet" encoding ="encObs" ord="89">
<comment>
Optional Set of observation data encoded in the format specified by encObs.\n
At least one of observations or state is required,
otherwise there is insufficient data to process.
</comment>
</elem>
</struct>
<!--
*******************************************************
Observation Submission API
*******************************************************
-->
<interface name="Submission">
<comment>Interface for submitting data to ILP. </comment>
<operation name="PositionInfo">
<comment>
Interaction submits position and observation data.\n
There is no response besides bearer response codes.
</comment>
<input name="Input" type="PositionInfo" sid="0x101E"/>
</operation>
</interface>
</namespace>
</specification>
Tensor/V1.1/Logging.xid.xml
......@@ -173,6 +173,9 @@
<literal name="AppMetrics" value="2">
<comment>Defines a complex metric measuring duration and concurrency.</comment>
</literal>
<literal name="BatchPegCount" value="3">
<comment>Defines a batch of values for simple monotonically incremented counter.</comment>
</literal>
</enum>
<struct name="Metric">
......@@ -190,6 +193,17 @@
</elem>
</struct>
<struct name="BatchPegCount" type="Metric" rttkey="Logging.MetricType.BatchPegCount">
<comment>Defines a batch of PegCount values at the time granularity.</comment>
<elem name="value" type="uint32" multiplicity="1..*" ord="80">
<comment>Value of peg count since last granularity.</comment>
</elem>
<elem name="granularity" type="uint16" multiplicity="1" ord="81">
<tag name="unit" value="sec"/>
<comment>The time granularity of each value.</comment>
</elem>
</struct>
<struct name="AppMetrics" type="Metric" rttkey="Logging.MetricType.AppMetrics">
<elem name="totalCount" type="uint32" multiplicity="1" ord="80">
<comment>Total count of invocations since last reporting.</comment>
......@@ -200,22 +214,31 @@
<elem name="peakCount" type="uint32" multiplicity="1" ord="82">
<comment>Peak concurrent invocations since last reporting.</comment>
</elem>
<elem name="totalTime" type="uint64" multiplicity="1" ord="83">
<comment>Total time spent on invocations in nanoseconds since last reporting.</comment>
<elem name="successTotalTime" type="uint64" multiplicity="1" ord="83">
<tag name="unit" value="nanoseconds"/>
<comment>Total time spent on successful invocations since last reporting.</comment>
</elem>
<elem name="peakTime" type="uint64" multiplicity="1" ord="84">
<comment>Peak time for an invocation in nanoseconds since last reporting.</comment>
<elem name="successPeakTime" type="uint64" multiplicity="1" ord="84">
<tag name="unit" value="nanoseconds"/>
<comment>Peak time for a successful invocation since last reporting.</comment>
</elem>
<elem name="successCount" type="uint32" multiplicity="1" ord="85">
<comment>Count of successful invocations since last reporting.</comment>
</elem>
<elem name="failureTotalTime" type="uint64" multiplicity="1" ord="87">
<tag name="unit" value="nanoseconds"/>
<comment>Total time spent on failed invocations since last reporting.</comment>
</elem>
<elem name="failurePeakTime" type="uint64" multiplicity="1" ord="88">
<tag name="unit" value="nanoseconds"/>
<comment>Peak time for a failed invocation since last reporting.</comment>
</elem>
<elem name="failureCount" type="uint32" multiplicity="1" ord="86">
<comment>Count of failed invocations since last reporting.</comment>
</elem>
</struct>
<!--
*******************************************************
Message Structure Definitions
......
Tensor/V1.1/XIDData.prop
......@@ -4,11 +4,15 @@ Ord.Logging.ActionMsg.iid=99
Ord.Logging.ActionMsg.severity=97
Ord.Logging.AppMetrics.currentCount=81
Ord.Logging.AppMetrics.failureCount=86
Ord.Logging.AppMetrics.failurePeakTime=88
Ord.Logging.AppMetrics.failureTotalTime=87
Ord.Logging.AppMetrics.peakCount=82
Ord.Logging.AppMetrics.peakTime=84
Ord.Logging.AppMetrics.successCount=85
Ord.Logging.AppMetrics.successPeakTime=84
Ord.Logging.AppMetrics.successTotalTime=83
Ord.Logging.AppMetrics.totalCount=80
Ord.Logging.AppMetrics.totalTime=83
Ord.Logging.BatchPegCount.granularity=81
Ord.Logging.BatchPegCount.value=80
Ord.Logging.DebugInfo.file=64
Ord.Logging.DebugInfo.line=65
Ord.Logging.DebugInfo.thid=66
......@@ -25,8 +29,8 @@ Ord.Logging.MetricMsg.metrics=82
Ord.Logging.MetricMsg.start=80
Ord.Logging.PegCount.value=80
Ord.Logging.TaskReport.duration=114
Ord.Logging.TaskReport.start=113
Ord.Logging.TaskReport.result=115
Ord.Logging.TaskReport.start=113
Ord.Logging.TaskReport.taskid=112
Ord.Logging.TraceMsg.level=96
Ord.Logging.TransactionMsg.acctid=82
......@@ -61,6 +65,7 @@ SID.Tensor.CommandApi.Execute.Input=256
SID.Tensor.CommandApi.Execute.Output=257
Size.Logging.ActionMsg=-1
Size.Logging.AppMetrics=-1
Size.Logging.BatchPegCount=-1
Size.Logging.DebugInfo=-1
Size.Logging.MessageBase=-1
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!