← Back to Packages
  • ObjectLogger

ObjectLogger

Package information

by Ida Hackett

Github cli

A powerful and easy-to-use operational logging system that supports analysis of changes in object properties

Support

#objectlogger on Discord

Views

696

License

MIT

Documentation

ObjectLogger

ObjectLogger

language version codebeat badge license

The powerful and easy-to-use object log system, supports writing and querying of object attribute changes.


中文说明


1 Introduction

ObjectLogger is powerful and easy-to-use object log system, which supports writing and querying of object attribute changes.

It can be used in many scenarios, such as user operation log record, object attribute change record and so on.

The system has the following characteristics:

The project consists of four parts:

2 Quick Start

2.1 Create Data Tables

Use /server/database/init_data_table.sql to init two data tables.

2.2 Start Server

Download the new target jar file from /server/target/ObjectLoggerServer-*.jar.

Start the jar with the following statement:

java -jar ObjectLoggerServer-*.jar --spring.datasource.driver-class-name={db_driver} --spring.datasource.url=jdbc:{db}://{db_address}/{db_name} --spring.datasource.username={db_username} --spring.datasource.password={db_password}

The above configuration items are described below:

After starting the jar package, you can see:

The default welcome page is:

http://127.0.0.1:12301/ObjectLoggerServer/

Visit the above address to see the following welcome interface:

The ObjectLoggerServer system has been built.

3 Access Service System

This section explains how to configure the business system to analyze the object changes in the business system through ObjectLoggerClient and then record them in ObjectLoggerServer.

The use of this part can refer to the ObjectLoggerDemo project, which gives a detailed example of business system integration ObjectLoggerClient. ObjectLoggerDemo's product package can be obtained from /demo/target/ObjectLoggerDemo-*. jar, and the project can be started directly without any other configuration by running java -jar ObjectLoggerDemo-*. jar.

3.1 Add Dependency

Add dependency package in POM file:

<dependency>
<groupId>com.github.yeecode.objectlogger</groupId>
<artifactId>ObjectLoggerClient</artifactId>
<version>{last_version}</version>
</dependency>

3.2 Scan Beans in ObjectLoggerClient

3.2.1 SpringBoot

Add @ComponentScan and add com.github.yeecode.objectlogger in basePackages

@SpringBootApplication
@ComponentScan(basePackages={"{your_beans_root}","com.github.yeecode.objectlogger"})
public class MyBootAppApplication {
public static void main(String[] args) {
// Eliminate other code
}
}

3.2.2 Spring

Add the following code to applicationContext.xml file:

<context:component-scan base-package="com.github.yeecode.objectlogger">
</context:component-scan>

3.3 Configuration

Add the following code to application.properties:

yeecode.objectLogger.serverAddress=http://{ObjectLoggerServer_address}
yeecode.objectLogger.businessAppName={your_app_name}
yeecode.objectLogger.autoLogAttributes=true

At this point, the configuration of the business system is completed.

4 Query Logs

The logs recorded in the system can be queried by http://127.0.0.1:12301/ObjectLoggerServer/log/query, and the logs can be filtered by passing in parameters.

5 Show Logs

react-object-logger is the react plugin for ObjectLogger project to show logs in web. Demo: react-object-logger demo

More information can be obtained via react-object-logger.

Plugins for other Front-end technology stacks are also under development.

6 Insert Logs

The business system introduces LogClient in any class that requires logging:

@Autowired
private LogClient logClient;

6.1 Simple Use

Just put the zero, one or more attributes of the object into List<BaseAttributeModel> and call logAttributes method. For example, a business application calls:

logClient.logAttributes(
"CleanRoomTask",
5,
"Tom",
"add",
"Add New Task",
"Create a cleanRoomTask",
"taskName is :Demo Task",
null);

Query form ObjectLoggerServer:

http://127.0.0.1:12301/ObjectLoggerServer/log/query?appName=ObjectLoggerDemo&objectName=CleanRoomTask&objectId=5

Results:

{
"respMsg": "SUCCESS",
"respData": [
{
"id": 1,
"appName": "ObjectLoggerDemo",
"objectName": "CleanRoomTask",
"objectId": 5,
"operator": "Jone",
"operationName": "start",
"operationAlias": "Start a Task",
"extraWords": "Begin to clean room...",
"comment": "Come on and start cleaning up.",
"operationTime": "2019-07-04T06:53:40.000+0000",
"attributeModelList": [
{
"attributeType": "NORMAL",
"attributeName": "status",
"attributeAlias": "Status",
"oldValue": "TODO",
"newValue": "DOING",
"diffValue": null,
"id": 1,
"operationId": 1
}
]
}
],
"respCode": "1000"
}

6.2 Automatic Recording of Object Attributes

This function can automatically complete the comparison between old and new objects, and insert multiple attribute changes into the log system together. When used, ensure that the old and new objects belong to the same class.

For example:

CleanRoomTask task = new CleanRoomTask();
task.setId(5);
task.setTaskName("Demo Task");
task.setStatus("TODO");
task.setDescription("Do something...");
 
CleanRoomTask oldTask = logClient.deepCopy(task);
 
task.setId(5);
task.setTaskName("Demo Task");
task.setStatus("DOING");
task.setDescription("The main job is to clean the floor.");
task.setAddress("Sunny Street");
task.setRoomNumber(702);
 
logClient.logObject(
cleanRoomTask.getId().toString(),
"Tom",
"update",
"Update a Task",
null,
null,
oldTask,
task);

Query form ObjectLoggerServer:

http://127.0.0.1:12301/ObjectLoggerServer/log/query?appName=ObjectLoggerDemo&objectName=CleanRoomTask&objectId=5

Results:

{
"respMsg": "SUCCESS",
"respData": [
{
"id": 4,
"appName": "ObjectLoggerDemo",
"objectName": "CleanRoomTask",
"objectId": 5,
"operator": "Tom",
"operationName": "update",
"operationAlias": "Update a Task",
"extraWords": null,
"comment": null,
"operationTime": "2019-07-04T07:22:59.000+0000",
"attributeModelList": [
{
"attributeType": "NORMAL",
"attributeName": "roomNumber",
"attributeAlias": "roomNumber",
"oldValue": "",
"newValue": "702",
"diffValue": null,
"id": 5,
"operationId": 4
},
{
"attributeType": "NORMAL",
"attributeName": "address",
"attributeAlias": "address",
"oldValue": "",
"newValue": "Sunny Street",
"diffValue": null,
"id": 6,
"operationId": 4
},
{
"attributeType": "NORMAL",
"attributeName": "status",
"attributeAlias": "Status",
"oldValue": "TODO",
"newValue": "DOING",
"diffValue": null,
"id": 7,
"operationId": 4
},
{
"attributeType": "TEXT",
"attributeName": "description",
"attributeAlias": "Description",
"oldValue": "Do something...",
"newValue": "The main job is to clean the floor.",
"diffValue": "Line 1<br/>&nbsp;&nbsp;&nbsp; -: <del> Do something... </del> <br/>&nbsp;&nbsp; +: <u> The main job is to clean the floor. </u> <br/>",
"id": 8,
"operationId": 4
}
]
}
],
"respCode": "1000"
}

7 Object Attribute Filtering

Some object attributes do not need to be logged, such as updateTime, hashCode, etc. ObjectLoggerClient supports filtering attributes of objects, tracking only attributes that we are interested in.

And for each attribute, we can change the way it is recorded in the ObjectLoggerClient system, such as changing the name.

To enable this function, first change the yeecode.objectLogger.autoLogAttributes in the configuration to false.

yeecode.objectLogger.autoLogAttributes=true

Then, the @LogTag annotation should be added to the attributes that need to be logged for change. Attributes without the annotation will be automatically skipped when logging.

For example, if the annotation configuration is as follows, id field changes will be ignored.

private Integer id;
 
@LogTag
private String taskName;
 
@LogTag(alias = "UserId", extendedType = "userIdType")
private int userId;
 
@LogTag(alias = "Status")
private String status;
 
@LogTag(alias = "Description", builtinType = BuiltinTypeHandler.TEXT)
private String description;

8 Extended Processing Attribute

In many cases, users want to be able to decide how to handle certain object attributes independently. For example, users may want to convert the userId attribute of the Task object into a name and store it in the log system, thus completely decoupling the log system from userId.

ObjectLoggerClient fully supports this scenario, allowing users to decide how to log certain attributes independently. To achieve this function, first assign a string value to the extendedType attribute of @LogTag that needs to be extended. For example:

@LogTag(alias = "UserId", extendedType = "userIdType")
private int userId;

And new a Bean implements BaseExtendedTypeHandler in business system:

@Service
public class ExtendedTypeHandler implements BaseExtendedTypeHandler {
@Override
public BaseAttributeModel handleAttributeChange(String extendedType, String attributeName, String attributeAlias, Object oldValue, Object newValue) {
// TODO
}
}

When ObjectLoggerClient processes this property, it passes information about the property into the handleAttributeChangemethod of the extended bean. The four parameters introduced are explained as follows:

For example, we can deal with the userIdType attribute in the following way:

@Service
public class ExtendedTypeHandler implements BaseExtendedTypeHandler {
@Override
public BaseAttributeModel handleAttributeChange(String extendedType, String attributeName, String attributeAlias, Object oldValue, Object newValue) {
BaseAttributeModel baseAttributeModel = new BaseAttributeModel();
if (extendedType.equals("userIdType")) {
// For example only, you can call external application here to convert user number to user name.
baseAttributeModel.setOldValue("USER_" + oldValue);
baseAttributeModel.setNewValue("USER_" + newValue);
baseAttributeModel.setDiffValue(oldValue + "->" + newValue);
}
return baseAttributeModel;
}
}

9 Roadmap