Lightweight M2M – Event Log Object (LwM2M Object – EventLog)

Approved Version: 2.0 - 2023-01-31

Open Mobile Alliance

OMA-TS-LWM2M_EventLog-V2_0-20230131-A

master: 07 Mar 2023 10:11:00 rev: 0cf199c

Unless this document is clearly designated as an approved specification, this document is a work in process, is not an approved Open Mobile Alliance™ specification, and is subject to revision or removal without notice.

You may use this document or any part of the document for internal or educational purposes only, provided you do not modify, edit or take out of context the information in this document in any manner. Information contained in this document may be used, at your sole risk, for any purposes. You may not use this document in any other manner without the prior written permission of the Open Mobile Alliance. The Open Mobile Alliance authorizes you to copy this document, provided that you retain all copyright and other proprietary notices contained in the original materials on any copies of the materials and that you comply strictly with these terms. This copyright permission does not constitute an endorsement of the products or services. The Open Mobile Alliance assumes no responsibility for errors or omissions in this document.

Each Open Mobile Alliance member has agreed to use reasonable endeavors to inform the Open Mobile Alliance in a timely manner of Essential IPR as it becomes aware that the Essential IPR is related to the prepared or published specification.
However, the members do not have an obligation to conduct IPR searches. The declared Essential IPR is publicly available to members and non-members of the Open Mobile Alliance and may be found on the “OMA IPR Declarations” list at https://www.omaspecworks.org/about/intellectual-property-rights/. The Open Mobile Alliance has not conducted an independent IPR review of this document and the information contained herein, and makes no representations or warranties regarding third party IPR, including without limitation patents, copyrights or trade secret rights. This document may contain inventions for which you must obtain licenses from third parties before making, using or selling the inventions. Defined terms above are set forth in the schedule to the Open Mobile Alliance Application Form.

NO REPRESENTATIONS OR WARRANTIES (WHETHER EXPRESS OR IMPLIED) ARE MADE BY THE OPEN MOBILE ALLIANCE OR ANY OPEN MOBILE ALLIANCE MEMBER OR ITS AFFILIATES REGARDING ANY OF THE IPR’S REPRESENTED ON THE “OMA IPR DECLARATIONS” LIST, INCLUDING, BUT NOT LIMITED TO THE ACCURACY, COMPLETENESS, VALIDITY OR RELEVANCE OF THE INFORMATION OR WHETHER OR NOT SUCH RIGHTS ARE ESSENTIAL OR NON-ESSENTIAL.

THE OPEN MOBILE ALLIANCE IS NOT LIABLE FOR AND HEREBY DISCLAIMS ANY DIRECT, INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES ARISING OUT OF OR IN CONNECTION WITH THE USE OF DOCUMENTS AND THE INFORMATION CONTAINED IN THE DOCUMENTS.

THIS DOCUMENT IS PROVIDED ON AN "AS IS" "AS AVAILABLE" AND "WITH ALL FAULTS" BASIS.

Copyright 2023 Open Mobile Alliance.

Used with the permission of the Open Mobile Alliance under the terms set forth above.

1. Scope

This document defines a set of Objects to be used in conjunction with the Lightweight M2M enabler in order to interact with event logs within a device.

The LwM2M object provides a standardised interface to query logs within a device. The actual implementation of the underlying log functionality is outside the scope of this TS.

2. References

2.1. Normative References

2.2. Informative References

3. Terminology and Conventions

3.1. Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].

All sections and appendixes, except "Scope" and "Introduction", are normative, unless they are explicitly indicated to be informative.

3.2. Definitions

See also [3GPP-TS_21.905] for 3GPP-specific definitions.

3.3. Abbreviations

See also [3GPP-TS_21.905] for 3GPP-specific abbreviations.

4. Introduction

This specification enables the transfer of log information from a device to an LwM2M server.

4.1. Version 1.0

V1.0 of the specification covers:

1. Communication of generic log information

4.1.1. Version 1.0.1

4.2. Version 2.0

5. Use cases

5.1. Controlling the recording of log data

This uses the LogStart/Stop resource, 4011/4012

1. The LwM2M Server sends an EXECUTE command to the LwM2M Client on the device specifying

• the IDs of the Log Object and its instance (/20/0),
• the Log Start Resource ID (4011) to indicate to start the Data Collection logging process and
• the payload containing the arguments of the EXECUTE command : namely argument 1 for indicating a Data Collection Period of 100s is requested, and argument 0 (which could be omitted) for indicating that the logging process is started with a virgin Data Collection

2. The LwM2M Client enables log data collection for the next 100 seconds
3. The LwM2M Client sends successful response to LwM2M Server.
4. The LwM2M Server sends an EXECUTE command to the LwM2M Client on the device specifying

• the IDs of the Log Object and its Instance (20/0),
• the Log Start Resource ID (4012) to indicate to stop the Data Collection logging process and
• the payload containing the argument 0 (which could be omitted here) of the EXECUTE command for indicating that Data Collection is preserved when the logging process is stopped

5. The LwM2M Client disable log data collection
6. The LwM2M Client sends successful response to LwM2M Server.

5.2. Reporting the logging status

This uses the LogStatus resource 4013. The LogStatus could be reported either by a READ from the LwM2M Server or NOTIFICATION from the LwM2M Client. This use case introduces the READ for example.

1. The LwM2M Server sends a read request to the LwM2M Client running on the device specifying

• the IDs of the Log Object and its instance (/20/0),
• the LogStatus Resource ID 4013 to indicate to get the log status information.

2. The LwM2M Client returns the log running status to the LwM2M server

5.3. Collecting the log data

This uses the LogData resource, 4014

1. The LwM2M Server sends a read request to the LwM2M Client running on the device specifying:

• the IDs of the Log Object and its instance (/20/0),
• the LogData Resource ID 4014 to indicate to get the log data information.

2. The LwM2M Client returns the log data to the LwM2M Server

5.4. Categorizing the log data

This uses the LogClass resource, 4010

1. The LwM2M Server sends a write request to the LwM2M Client specifying:

• the IDs of the Log Object and its instance (/20/0),
• the Log Class Resource ID 4010 to indicate to set the log class information,
• the payload containing the argument 0 of the EXECUTE command for indicating that only generic log class should be collected.

2. The LwM2M Client sends response to the LwM2M Server with the changed result.

6. LwM2M Object: Event Log

Description

The Event Log Object is a multiple Instances Object defined for logging data in a straightforward and generic way. The Resources of that Object are based on the OMA LwM2M set of reusable Resources dedicated to logging event activity.

Object definition

Resource definitions

7. Guidance on how to use the resource, the generic object

• Configuration phase: the LogClass is set, the OBSERVE on LogStatus is requested

• Active phase :

• The Data Collection process is started with a period of 5 minutes (300 sec)

• Some LogStatus notification take place for LwM2M Server Analysis

• When Data Collection logging ends (period expires), the LwM2M Server can retrieve the LogData information (the data format is pre-configured between the Client and the Server)

Appendix A. Change History (Informative)

A.1 Approved Version History

Appendix B. Example objects and resources (Informative)