11.5 Streaming data reporting service
28.5323GPPGeneric management servicesManagement and orchestrationRelease 17TS
11.5.1 Operations and notifications
11.5.1.1 establishStreamingConnection operation (M)
11.5.1.1.1 Definition
This operation enables the MnS producer to establish a connection to the MnS consumer (i.e. streaming target). The connection establishement includes the exchange of meta-data (producer informs consumer about its own identity and the nature of the data to be reported via streaming) phase and the actual connection (a data pipe for streaming) establishment.
Established connection supports stream multiplexing (one connection supports one or more reporting streams simultaneously).
Upon successful connection establishment, the MnS consumer is aware of the MnS producer’s identity, the list of reporting streams and the nature of data being reported on each of the streams.
The established connection may be kept "alive" either by built-in functionality of the solution set or by periodic reporting of empty stream data.
11.5.1.1.2 Input parameters
Parameter Name |
S |
Information type |
Comment |
---|---|---|---|
producerId |
M |
The identity of the producer requesting the connection establishment. |
DN of the MnS producer. If the MnS producer is not modeled as 3GPP NRM MOI, an alternative identifer other than DN may be used. |
streamInfoList |
M |
List of StreamInfo |
This parameter contains the list of meta-data about each reporting stream. For streaming trace reporting each StreamInfo includes: – StreamType carrying the value "TRACE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – Trace Reference (see clause 5.6 of TS 32.422 [38]) as stream identifier; – TraceJob (see clause 4.3.30 of TS 28.622 [11]) providing the details about the configuration of the trace job for which the data is being reported. For streaming performance data reporting each StreamInfo includes: – StreamType carrying the value "PERFORMANCE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – measObjDn: the DN of the measured object instance; – performanceMetrics: a list of performance metric names whose values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550 [42]) via this stream. Performance metrics include measurement and KPI; – either: – jobId defined in the PerfMetricJob MOI (see clause 4.3.31 of TS 28.622 [11]) for which the data is being reported; – or: – jobId globally unique identifier of a measurement job (see TS 28.550 [42]). For streaming analytics reporting each StreamInfo includes: – StreamType carrying the value "ANALYTICS"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – AnalyticsInfo providing the details about the analytics activity for which the data is being reported. For proprietary data streaming reporting each StreamInfo includes: – StreamType carrying the value "PROPRIETARY"; – streamId globally unique stream identifier; – VsDataContainer (see clause 4.3.9 of TS 28.622 [11]) providing the details about the data being reported. |
11.5.1.1.3 Output parameters
Parameter Name |
S |
Matching Information |
Comment |
---|---|---|---|
connectionId |
M |
Identifier of the established streaming connection. |
It identifies the established streaming connection. The format may have dependency on the solution set. |
status |
M |
ENUM (Success, Failure) |
An operation may fail because of a specified or unspecified reason. |
11.5.1.1.4 Exceptions
Exception Name |
Definition |
---|---|
unexpectedStreams |
Condition: Some information in the list of streamInfo was unexpected by the MnS consumer. Returned Information: Name of the exception; status is set to "Failure". |
11.5.1.2 terminateStreamingConnection operation (M)
11.5.1.2.1 Definition
This operation enables the MnS producer to terminate the connection to theMnS consumer (i.e. streaming target).
Upon successful termination of the streaming connection, the MnS producer stops reporting data to the MnS consumer on this connection.
11.5.1.2.2 Input parameters
Parameter Name |
S |
Information type |
Comment |
---|---|---|---|
connectionId |
M |
See clause 11.5.1.1.3 |
It identifies the streaming connection being terminated. The format may have dependency on the solution set. |
11.5.1.2.3 Output parameters
Parameter Name |
S |
Matching Information |
Comment |
---|---|---|---|
status |
M |
ENUM (Success, Failure) |
An operation may fail because of a specified or unspecified reason. |
11.5.1.2.4 Exceptions
Exception Name |
Definition |
---|---|
unknownConnection |
Condition: the connectionId is invalid. Returned Information: Name of the exception; status is set to "Failure". |
11.5.1.3 reportStreamData operation (M)
11.5.1.3.1 Definition
This operation enables the MnS producer to send a unit of streaming data to the MnS consumer.
11.5.1.3.2 Input parameters
Parameter Name |
S |
Information type |
Comment |
---|---|---|---|
connectionId |
M |
See clause 11.5.1.1.3 |
It identifies the streaming connection on which the reported data are being sent. The format may have dependency on the solution set. |
streamingData |
M |
Unit of streaming data |
This parameter contains the actual data (payload) being reported via stream. For streaming trace reporting each streamingData is encoded according to the format specified in the clause 5 of 3GPP TS 32.423 [39]. For streaming performance data reporting each streamingData is encoded according to the format specified in the Annex C of 3GPP TS 28.550 [42]. For proprietary data streaming reporting each streamingData is encoded according to the format specified in the product documentation. |
11.5.1.3.3 Output parameters
Parameter Name |
S |
Matching Information |
Comment |
---|---|---|---|
status |
M |
ENUM (Success, Failure) |
An operation may fail because of a specified or unspecified reason. |
11.5.1.3.4 Exceptions
Exception Name |
Definition |
---|---|
11.5.1.4 addStream operation (M)
11.5.1.4.1 Definition
This operation allows the MnS producer to add one or more reporting streams to an already established streaming connection.
11.5.1.4.2 Input parameters
Parameter Name |
S |
Information type |
Comment |
---|---|---|---|
connectionId |
M |
See clause 11.5.1.1.3 |
It identifies the streaming connection to which new reporting streams are being added. The format may have dependency on the solution set. |
streamInfoList |
M |
List of StreamInfo |
This parameter contains the list of meta-data about each reporting stream being added to the already established connection. For streaming trace reporting each StreamInfo includes: – StreamType carrying the value "TRACE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – Trace Reference (see clause 5.6 of TS 32.422 [38]) as stream identifier; – TraceJob (see clause 4.3.30 of TS 28.622 [11]) providing the details about the configuration of the trace job for which the data is being reported. For streaming performance data reporting each StreamInfo includes: – StreamType carrying the value "PERFORMANCE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – measObjDn: the DN of the measured object instance; – performanceMetrics: a list of performance metric (i.e. measurement or KPI) names whose values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550 [42]) via this stream; – either: – jobId defined in the PerfMetricJob MOI (see clause 4.3.31 of TS 28.622 [11]) for which the data is being reported; – or: – jobId globally unique identifier of a measurement job (see TS 28.550 [42]). For streaming analytics reporting each StreamInfo includes: – StreamType carrying the value "ANALYTICS"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – AnalyticsInfo providing the details about the analytics activity for which the data is being reported. For proprietary data streaming reporting each StreamInfo includes: – StreamType carrying the value "PROPRIETARY"; – streamId globally unique stream identifier; – VsDataContainer (see clause 4.3.9 of TS 28.622 [11]) providing the details about the data being reported. |
11.5.1.4.3 Output parameters
Parameter Name |
S |
Matching Information |
Comment |
---|---|---|---|
streamInfoList |
M |
List of StreamInfo |
This parameter contains the list of meta-data about each reporting stream that has been successfully added as a result of this operation. For streaming trace reporting each StreamInfo includes: – StreamType carrying the value "TRACE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – Trace Reference (see clause 5.6 of 3GPP TS 32.422 [38]) as stream identifier; – TraceJob (see clause 4.3.30 of 3GPP TS 28.622 [11]) providing the details about the configuration of the trace job for which the data is being reported. For streaming performance data reporting each StreamInfo includes: – StreamType carrying the value "PERFORMANCE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – measObjDn: the DN of the measured object instance; – performanceMetrics: a list of performance metric names whose values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550 [42]) via this stream. Performance metrics include measurement and KPI; – either: – jobId defined in the PerfMetricJob MOI (see clause 4.3.31 of 3GPP TS 28.622 [11]) for which the data is being reported; – or: – jobId globally unique identifier of a measurement job (see TS 28.550 [42]). For streaming analytics reporting each StreamInfo includes: – StreamType carrying the value "ANALYTICS"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – AnalyticsInfo providing the details about the analytics activity for which the data is being reported. For proprietary data streaming reporting each StreamInfo includes: – StreamType carrying the value "PROPRIETARY"; – streamId globally unique stream identifier; – VsDataContainer (see clause 4.3.9 of 3GPP TS 28.622 [11]) providing the details about the data being reported. |
status |
M |
ENUM (Success, Failure, PartialSuccess) |
An operation may fail because of a specified or unspecified reason. |
11.5.1.4.4 Exceptions
Exception Name |
Definition |
---|---|
duplicateStream |
Condition: One or more of stream identifiers in the streamInfoList already exist on this connection. Returned Information: Name of the exception; status is set to "Failure" or "PartialSuccess". |
unexpectedStreams |
Condition: Some information in the list of streamInfo was unexpected by the MnS consumer. Returned Information: Name of the exception; status is set to "Failure". |
unknownConnection |
Condition: the connectionId is invalid. Returned Information: Name of the exception; status is set to "Failure". |
11.5.1.5 deleteStream operation (M)
11.5.1.5.1 Definition
This operation allows the MnS producer to remove one or more reporting streams from an already established streaming connection.
11.5.1.5.2 Input parameters
Parameter Name |
S |
Information type |
Comment |
---|---|---|---|
connectionId |
M |
See clause 11.5.1.1.3 |
It identifies the streaming connection from which the reporting streams are being removed. The format may have dependency on the solution set. |
streamIdList |
M |
List of stream identifiers |
This parameter contains the list of identifiers for streams being removed from the already established connection. For streaming trace reporting Trace Reference (see clause 5.6 of 3GPP TS 32.422 [38]) is used as stream identifier. For streaming performance data reporting streamId globally unique stream identifier. For streaming analytics reporting streamId globally unique stream identifier. For proprietary data streaming reporting streamId globally unique stream identifier. |
11.5.1.5.3 Output parameters
Parameter Name |
S |
Matching Information |
Comment |
---|---|---|---|
status |
M |
ENUM (Success, Failure, PartialSuccess) |
An operation may fail because of a specified or unspecified reason. |
11.5.1.5.4 Exceptions
Exception Name |
Definition |
---|---|
unknownStreamId |
Condition: One or more of stream identifiers in the streamIdList does not exist on this connection. Returned Information: Name of the exception; status is set to "Failure" or "PartialSuccess". |
unknownConnection |
Condition: the connectionId is invalid. Returned Information: Name of the exception; status is set to "Failure". |
11.5.1.6 getConnectionInfo operation (M)
11.5.1.6.1 Definition
This operation enables the MnS producer to obtain information about one or more streaming connections from the MnS consumer.
11.5.1.6.2 Input parameters
Parameter Name |
S |
Information type |
Comment |
---|---|---|---|
connectionIdList |
M |
List of streaming connection identifiers |
This parameter contains the list of streaming connection identifiers for which the stream information is to be returned. The empty list indicates the stream information for all connections are to be returned. |
11.5.1.6.3 Output parameters
Parameter Name |
S |
Matching Information |
Comment |
---|---|---|---|
connectionInfoList |
M |
List of <connectionId, streamReporter, streamIdList> tuples |
This parameter contains the list of meta-data about each streaming connection requested by this operation. Each entry in this list is a tuple of connectionId, streamReporter and streamIdList. For streaming trace reporting: – streamReporter is the identity of the streaming data reporting MnS producer reporting data for this connectionId; – streamIdList is the list of Trace References (see clause 5.6 of 3GPP TS 32.422 [38]) used as stream identifiers. For streaming performance data reporting: – streamReporter is the identity of the streaming data reporting MnS producer reporting data for this connectionId; – streamIdList is the list of streamId globally unique stream identifiers. For streaming analytics reporting: – streamReporter is the identity of the streaming data reporting MnS producer reporting data for this connectionId; – streamIdList is the list of streamId globally unique stream identifiers. For streaming proprietary data reporting: – streamReporter is the identity of the streaming data reporting MnS producer reporting data for this connectionId; – streamIdList is the list of streamId globally unique stream identifiers. |
status |
M |
ENUM (Success, Failure, PartialSuccess) |
An operation may fail because of a specified or unspecified reason. |
11.5.1.6.4 Exceptions
Exception Name |
Definition |
---|---|
unknownConnectionId |
Condition: One or more of connection identifiers in the connectionIdList is not known to this MnS consumer. Returned Information: Name of the exception; status is set to "Failure" or "PartialSuccess". |
11.5.1.7 getStreamInfo operation (M)
11.5.1.7.1 Definition
This operation enables theMnS producer to obtain information about one or more reporting streams the MnS consumer.
11.5.1.7.2 Input parameters
Parameter Name |
S |
Information type |
Comment |
---|---|---|---|
streamIdList |
M |
List of stream identifiers |
This parameter contains the list of stream identifiers for which the stream information is to be returned. The empty list indicates the stream information for all streams are to be returned. For streaming trace reporting Trace Reference (see clause 5.6 of 3GPP TS 32.422 [38]) is used as stream identifier. For streaming performance data reporting streamId globally unique stream identifier. For streaming analytics reporting streamId globally unique stream identifier. For proprietary data streaming reporting streamId globally unique stream identifier. |
11.5.1.7.3 Output parameters
Parameter Name |
S |
Matching Information |
Comment |
---|---|---|---|
streamInfoSumList |
M |
List of <StreamInfo, StreamReporters> tuples |
This parameter contains the list of meta-data about each reporting stream requested by this operation. Each entry in this list is a tuple of StreamInfo and StreamReporters. For streaming trace reporting each StreamInfo includes: – StreamType carrying the value "TRACE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – Trace Reference (see clause 5.6 of TS 32.422 [38]) as stream identifier; – TraceJob (see clause 4.3.30 of TS 28.622 [11]) providing the details about the configuration of the trace job for which the data is being reported. For streaming trace the StreamReporters is a list of the identities of the streaming data reporting MnS producer(s) reporting data for this Trace Reference to this MnS consumer. For streaming PM reporting each StreamInfo includes: – StreamType carrying the value "PERFORMANCE"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – measObjDn: the DN of the measured object instance; – performanceMetrics: a list of performance metric names whose values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550 [42]) via this stream. Performance metrics include measurement and KPI; – either: – jobId defined in the PerfMetricJob MOI (see clause 4.3.31 of TS 28.622 [11]) for which the data is being reported; – or: – jobId globally unique identifier of a measurement job (see TS 28.550 [42]). For streaming performance data the StreamReporters is a list of the identities of the streaming data reporting MnS producer(s) reporting data for this streamId to this MnS consumer. For streaming analytics reporting each StreamInfo includes: – StreamType carrying the value "ANALYTICS"; – SerializationFormat carrying the value "GPB" or "ASN1"; – streamId globally unique stream identifier; – AnalyticsInfo providing the details about the analytics activity for which the data is being reported. For streaming analytics the StreamReporters is a list of the identities of the streaming data reporting MnS producer(s) reporting data for this streamId to this MnS consumer. For proprietary data streaming reporting each StreamInfo includes: – StreamType carrying the value "PROPRIETARY"; – streamId globally unique stream identifier; – VsDataContainer (see clause 4.3.9 of TS 28.622 [11]) providing the details about the data being reported. For proprietary data streaming the StreamReporters is a list of the identities of the streaming data reporting MnS producer(s) reporting data for this streamId to this MnS consumer. |
status |
M |
ENUM (Success, Failure, PartialSuccess) |
An operation may fail because of a specified or unspecified reason. |
11.5.1.7.4 Exceptions
Exception Name |
Definition |
---|---|
unknownStreamId |
Condition: One or more of stream identifiers in the streamIdList is not known to this MnS consumer. Returned Information: Name of the exception; status is set to "Failure" or "PartialSuccess". |