G.2 Trace Record Protocol Buffer (GPB) definitions
32.4233GPPRelease 16Subscriber and equipment traceTelecommunication managementTrace data definition and managementTS
Normative GPB Trace Record schema, defined per clause 5.2:
syntax = “proto3”;
/* Trace Record per 3GPP 32.423 specification.
* v16
*/
enum TraceRecordType {
NORMAL = 0;
TRACE_SESSION_START = 1;
TRACE_SESSION_STOP = 2;
TRACE_RECORDING_SESSION_START = 3;
TRACE_RECORDING_SESSION_STOP = 4;
TRACE_STREAM_HEARTBEAT = 5;
TRACE_RECORDING_SESSION_DROPPED_EVENTS = 6;
TRACE_RECORDING_SESSION_NOT_STARTED = 7
}
message TraceRecordHeader {
int64 time_stamp = 1;
string nf_instance_id = 2;
string nf_type = 3;
bytes trace_reference = 4;
bytes trace_recording_session_ref = 5;
TraceRecordType trace_rec_type_id = 6;
optional bytes ran_ue_id = 7;
optional string payload_schema_uri = 8;
map<string, string> vendor_extension = 9;
}
message TraceSessionStart {
map<string, string> vendor_extension = 1;
}
message TraceSessionStop {
map<string, string> vendor_extension = 1;
}
message TraceRecordingSessionStart {
map<string, string> vendor_extension = 1;
}
message TraceRecordingSessionStop {
map<string, string> vendor_extension = 1;
}
message TraceStreamHeartbeat {
map<string, string> vendor_extension = 1;
}
message TraceRecordingSessionDroppedEvents {
int64 number_of_dropped_events = 1;
map<string, string> vendor_extension = 2;
}
message TraceRecordingSessionNotStarted {
string reason = 1;
map<string, string> vendor_extension = 2;
}
message CommonTracePayload {
oneof record_payload {
TraceSessionStart trace_session_start = 1;
TraceSessionStop trace_session_stop = 2;
TraceRecordingSessionStart trace_recording_session_start = 3;
TraceRecordingSessionStop trace_recording_session_stop = 4;
TraceStreamHeartbeat trace_stream_heartbeat = 5;
TraceRecordingSessionDroppedEvents trace_recording_session_dropped_events = 6;
TraceRecordingSessionNotStarted trace_recording_session_not_started = 7;
}
}
message TraceRecordPayload {
optional int64 payload_size = 1;
bytes binary_payload = 2;
}
message TraceRecord {
TraceRecordHeader header = 1;
TraceRecordPayload payload = 2;
}
message StreamingTraceRecord {
TraceRecord record = 1;
optional CommonTracePayload administrative_message = 2;
}
Annex H (informative):
Examples of Protocol Buffer (GPB) encoded Streaming Trace administrative messages
The following examples illustrate the use of Prococol Buffer encoding for Streaming Trace administrative messages according to the definitions in clause 5.2.4.
The examples are in compact GPB format, using the schema defined in Annex G.
Example 1, Decoded Trace Session start message:
TraceRecord {
header {
time_stamp: 1584103023591,
nf_instance_id: NETWORK_MANAGED_ELEMENT_ID,
nf_type: RadioNode,
trace_reference: ”H,
trace_recording_session_reference: ”H,
trace_rec_type_id: TRACE_SESSION_START,
ran_ue_id: ”H,
},
payload: ”H
},
CommonTracePayload
}
Example 2, Decoded Trace Session stop message:
TraceRecord {
header {
time_stamp: 158415623591,
nf_instance_id: NETWORK_MANAGED_ELEMENT_ID,
nf_type: RadioNode,
trace_reference: ”H,
trace_recording_session_reference: ”H,
trace_rec_type_id: TRACE_SESSION_STOP,
ran_ue_id: ”H,
},
payload: ‘0A 01 09 11’H
},
CommonTracePayload {
trace_session_stop {
}
}
Example 3, Decoded Trace Recording Session Dropped Events message:
TraceRecord {
header {
time_stamp: 1584103023591,
nf_instance_id: NETWORK_MANAGED_ELEMENT_ID,
nf_type: RadioNode,
trace_reference: ”H,
trace_recording_session_reference: ”H,
trace_rec_type_id: TRACE_RECORDING_SESSION_DROPPED_EVENTS,
ran_ue_id: ”H,
},
payload: ‘0A’H
},
CommonTracePayload {
trace_recording_session_dropped_events {
number_of dropped_events: 6
}
}
Annex I (informative):
Change history
|
Change history |
||||||||
|
Date |
TSG # |
TSG Doc. |
CR |
Rev |
Subject/Comment |
Cat |
Old |
New |
|
Sep 2005 |
SA_29 |
SP-050623 |
0004 |
1 |
Clarify Trace Messages for FDD and TDD modes |
B |
6.2.0 |
7.0.0 |
|
Dec 2005 |
SA_30 |
SP-050690 |
0007 |
— |
Differentiate Trace Contents for FDD and TDD |
B |
7.0.0 |
7.1.0 |
|
Dec 2005 |
SA_30 |
SP-050709 |
0008 |
— |
Remove SFN-SFN observed time difference – Align with 25.331 |
A |
7.0.0 |
7.1.0 |
|
Dec 2005 |
SA_30 |
SP-050709 |
0009 |
— |
Correction to name space URI |
A |
7.0.0 |
7.1.0 |
|
Jun 2006 |
SA_32 |
SP-060258 |
0011 |
— |
Correction for compilation errors of schema and addition of the missing link |
A |
7.1.0 |
7.2.0 |
|
Sep 2006 |
SA_33 |
SP-060533 |
0013 |
— |
Correct UTRA Carrier RSSI for trace contents- Align with RAN2’s 25.331 |
A |
7.2.0 |
7.3.0 |
|
Sep 2006 |
SA_33 |
SP-060533 |
0015 |
— |
Correct CFN-SFN observed time difference for trace IE – Align with RAN2’s 25.331 |
A |
7.2.0 |
7.3.0 |
|
Sep 2006 |
SA_33 |
SP-060552 |
0016 |
— |
Add Trace IEs to differentiate UARFCN for FDD and TDD – Align with RAN2’s 25.331 |
C |
7.2.0 |
7.3.0 |
|
Sep 2006 |
SA_33 |
SP-060552 |
0018 |
— |
Correction in XML schema and examples |
F |
7.2.0 |
7.3.0 |
|
Dec 2006 |
SA_34 |
SP-060728 |
0019 |
— |
Correct the errors in figure and examples |
F |
7.3.0 |
7.4.0 |
|
Mar 2009 |
SA_43 |
SP-090207 |
0020 |
— |
Constraint of the presence for the "ue" element |
F |
7.4.0 |
8.0.0 |
|
Mar 2009 |
SA_43 |
SP-090207 |
0021 |
— |
Adding PGW trace record content |
B |
7.4.0 |
8.0.0 |
|
Mar 2009 |
SA_43 |
SP-090207 |
0022 |
— |
Alignment with 32.421 and 32.422. Introduction medium and minimum trace dept IEs for the GTP and S1AP protcols in MME |
B |
7.4.0 |
8.0.0 |
|
Mar 2009 |
SA_43 |
SP-090207 |
0023 |
— |
Alignment with 32.421 and 32.422. Introduction of E-UTRAN |
B |
7.4.0 |
8.0.0 |
|
Jun 2009 |
SA_44 |
SP-090289 |
0024 |
— |
Alignment with 32.421 and 32.422 – Introduction medium and minimum trace depth IEs in MME. |
F |
8.0.0 |
8.1.0 |
|
Jun 2009 |
SA_44 |
SP-090289 |
0025 |
— |
Add missing SGW Trace Record content |
F |
8.0.0 |
8.1.0 |
|
Jun 2009 |
SA_44 |
SP-090289 |
0026 |
— |
Add missing PGW Trace Record content for Gx and S6b interfaces |
F |
8.0.0 |
8.1.0 |
|
Jun 2009 |
SA_44 |
SP-090289 |
0027 |
— |
Alignment with 32.421 and 32.422 – Introduction medium and minimum trace dept IEs for NAS in MME. |
F |
8.0.0 |
8.1.0 |
|
Sep 2009 |
SA_45 |
SP-090534 |
0028 |
— |
Correction in TS 32.423 Trace Depth requirements for MME, SGW and PGW |
F |
8.1.0 |
8.2.0 |
|
Sep 2009 |
SA_45 |
SP-090534 |
0030 |
— |
Unable to uniquely identify file name when one file per UE trace |
F |
8.1.0 |
8.2.0 |
|
Sep 2009 |
SA_45 |
SP-090534 |
0031 |
— |
Added a file format and example for sending the IMSI/IMEI (SV) information from the MME |
F |
8.1.0 |
8.2.0 |
|
Sep 2009 |
SA-45 |
SP-090542 |
0029 |
— |
Correction on XML file format for Trace failure notification |
F |
8.2.0 |
9.0.0 |
|
Dec 2009 |
SA-46 |
SP-090719 |
0032 |
— |
Clarify Trace Reference and Trace Recording Session Reference format |
F |
9.0.0 |
9.1.0 |
|
Jan 2010 |
— |
— |
— |
— |
Removal of track changes |
— |
9.1.0 |
9.1.1 |
|
Mar 2010 |
SA-47 |
SP-100034 |
0034 |
— |
Align with 32.421 and 33.401 |
A |
9.1.1 |
9.2.0 |
|
Sep 2010 |
SA-49 |
SP-100487 |
0039 |
— |
Correcting references |
A |
9.2.0 |
9.3.0 |
|
Sep 2010 |
SA-49 |
SP-100489 |
0036 |
— |
Add Diameter in HSS Trace Record Content |
B |
9.2.0 |
9.3.0 |
|
Sep 2010 |
SA-49 |
SP-100488 |
0035 |
— |
Correct call trace file format to allow multiple targets |
F |
9.3.0 |
10.0.0 |
|
Dec 2010 |
SA-50 |
SP-100833 |
0040 |
1 |
Add trace Record Content in MME trace and SGSN trace – Align with 32.421 and 32.422 |
C |
10.0.0 |
10.1.0 |
|
Dec 2010 |
SA-50 |
SP-100858 |
0042 |
— |
Correcting the Trace Reference definition – Align with RAN3 TS 36.423, 36.413 |
A |
10.0.0 |
10.1.0 |
|
Dec 2010 |
SA-50 |
SP-100833 |
0043 |
— |
Adding the S6a trace interface for HSS |
B |
10.0.0 |
10.1.0 |
|
Dec 2010 |
SA-50 |
SP-100833 |
0044 |
— |
Correcting the Identification of IMS Subscriber Tracing – Align with 32.421 |
F |
10.0.0 |
10.1.0 |
|
Dec 2010 |
SA-50 |
SP-100831 |
0047 |
— |
Add missing interfaces S3, S4 and S6d trace record contents of SGSN – Align with 32.422 |
A |
10.0.0 |
10.1.0 |
|
Mar 2011 |
SA-51 |
SP-110095 |
0049 |
– |
Addition of trace Record Content of EIR Trace |
B |
10.1.0 |
10.2.0 |
|
May 2011 |
SA-52 |
SP-110292 |
0050 |
1 |
Applying trace data file to MDT data format |
B |
10.2.0 |
10.3.0 |
|
Dec 2011 |
SA-54 |
SP-110715 |
0054 |
— |
Correcting the description of meas vendorSpecific attribute in the XML trace file |
F |
10.3.0 |
10.4.0 |
|
Dec 2011 |
SA-54 |
SP-110716 |
0047 |
Clarification of eNB ID in E-UTRAN Trace Record |
B |
10.4.0 |
11.0.0 |
|
|
Dec 2011 |
SA-54 |
SP-110716 |
0053 |
— |
Rel11 CR to 32423 Update the trace record content for Uu and X2 interfaces |
C |
10.4.0 |
11.0.0 |
|
March 2012 |
SA55 |
SP-120053 |
0058 |
1 |
Correct IMSI retrieval file to include MDT anonymization info |
A |
11.0.0 |
11.1.0 |
|
March 2012 |
SA-55 |
SP-120044 |
0061 |
1 |
Modify E-UTRAN Trace Record Content |
A |
11.0.0 |
11.1.0 |
|
Sep-2012 |
SA-57 |
SP-120627 |
0064 |
1 |
Reference list correction to align with the corrected TS 29.212 title |
F |
11.1.0 |
11.2.0 |
|
Dic-2012 |
SA-58 |
SP-120783 |
0065 |
1 |
Correction of inconsistent specification of data type for Trace Recording Session Reference Length (TRSR) |
F |
11.2.0 |
11.3.0 |
|
SP-120796 |
0066 |
1 |
Specifying trace record content for immediate MDT measurements |
B |
||||
|
SP-120796 |
0067 |
– |
Add RCEF in Uu interface trace |
C |
||||
|
SP-120795 |
0068 |
1 |
Correction on the scope and reference related to MDT |
F |
||||
|
Mar-2013 |
SA-59 |
SP-130057 |
0069 |
– |
RCEF reporting in UMTS |
F |
11.3.0 |
11.4.0 |
|
June-2013 |
SA-60 |
SP-130265 |
0072 |
1 |
Correct trace file name format |
A |
11.4.0 |
11.5.0 |
|
SP-130304 |
0073 |
2 |
Correct the XML shcema for MDT data |
F |
||||
|
Sep-2013 |
SA-61 |
SP-130432 |
0075 |
2 |
Correction on some inconsistent definitons for trace data file parameters |
A |
11.5.0 |
11.6.0 |
|
Mar-2014 |
SA-63 |
SP-140029 |
0079 |
1 |
Corrections of Trace Session identifier |
A |
11.6.0 |
11.7.0 |
|
Jun-2014 |
SA-64 |
SP-140344 |
0083 |
– |
Corrections on the trace record content for immediate MDT measurements |
F |
11.7.0 |
11.8.0 |
|
Sep-2014 |
SA-65 |
SP-140560 |
0092 |
1 |
Correct the File naming convention |
B |
11.8.0 |
12.0.0 |
|
Dec-2014 |
SA-66 |
SP-140798 |
0093 |
– |
Remove characters in the Trace file name |
F |
12.0.0 |
12.1.0 |
|
SP-140800 |
0094 |
1 |
Introduction of network sharing. |
B |
||||
|
Jan 2016 |
Update to Rel-13 (MCC) |
12.1.0 |
13.0.0 |
|||||
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2017-03 |
SA#75 |
Promotion to Release 14 without technical change |
14.0.0 |
||||
|
2018-06 |
SA#80 |
SP-180434 |
0095 |
– |
B |
Add support for 5G Trace |
15.0.0 |
|
2019-06 |
SA#84 |
SP-190385 |
0097 |
1 |
F |
Update Trace Record Content to reflect the NR NRM in 28.541 for NSA support |
15.1.0 |
|
2020-03 |
SA#87E |
SP-200165 |
0099 |
1 |
F |
Add missing MDT trace record for LTE measurements |
15.2.0 |
|
2020-03 |
SA#87E |
SP-200173 |
0100 |
1 |
B |
Add MDT trace record for NR measurements |
16.0.0 |
|
2020-03 |
SA#87E |
SP-200175 |
0101 |
1 |
B |
Add streaming format for Trace Record Reporting |
16.0.0 |
|
2020-07 |
SA#88E |
SP-200488 |
0112 |
– |
A |
clean up of the editor notes |
16.1.0 |
|
2020-07 |
SA#88E |
SP-200485 |
0113 |
1 |
F |
Adding SINR measurement in M1 for Immediate MDT |
16.1.0 |
|
2020-07 |
SA#88E |
SP-200483 |
0115 |
1 |
F |
Correction of the Trace streaming format definitions |
16.1.0 |
|
2020-09 |
SA#89e |
SP-200723 |
0116 |
– |
F |
Add support for new administration messages when streaming trace data |
16.2.0 |
|
2020-12 |
SA#90e |
SP-201074 |
0117 |
– |
F |
Correct streaming trace record concept figure |
16.3.0 |
|
2020-12 |
SA#90e |
SP-201063 |
0118 |
– |
F |
Fix inconsistencies in NR positioning method |
16.3.0 |
|
2021-03 |
SA#91e |
SP-210168 |
0120 |
– |
F |
Correct trace record information for immediate MDT measurement in NR |
16.4.0 |
|
2021-12 |
SA#94e |
SP-211458 |
0127 |
1 |
F |
Introduce missing IEs for HSS and UDM Trace Record |
16.5.0 |
|
2022-06 |
SA#96 |
SP-220516 |
0129 |
1 |
F |
Adding missing interface related to SMF for trace record content |
16.6.0 |
|
2022-09 |
SA#97e |
SP-220853 |
0133 |
F |
GPB schema fix for trace streaming |
16.7.0 |
|
|
2022-12 |
SA#98e |
SP-221196 |
0137 |
– |
F |
Fixing the representation of the payload size in the figure for trace payload |
16.8.0 |