Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

optimization of log string generation #2292

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

optimization of log string generation #2292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb517e5
optimization of log string generation
agav99 Nov 15, 2024
e854c3e
remove the elevated source logging for calls to getDevStates
agav99 Nov 16, 2024
8511840
Please remove the commented checks for debug device
agav99 Nov 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 31 additions & 23 deletions lib/statescontroller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,6 @@
if (!this.adapter.zbController || !this.adapter.zbController.connected()) {
return;
}
if (this.debugDevices === undefined) {
this.getDebugDevices();
}
if (state && !state.ack) {
if (id.endsWith('pairingCountdown') || id.endsWith('pairingMessage') || id.endsWith('connection')) {
return;
Expand Down Expand Up @@ -202,6 +199,7 @@
} else {
states = stateModel.states;
}

if (typeof states === 'function' && !states.prototype) {
const entity = await this.adapter.zbController.resolveEntity(deviceId);
if (entity) {
Expand All @@ -217,7 +215,7 @@
}

async publishFromState(deviceId, model, stateKey, state, options) {
if (this.debugDevices === undefined) this.getDebugDevices();

this.debug(`Change state '${stateKey}' at device ${deviceId} type '${model}'`);
const elevated = this.checkDebugDevice(deviceId);

Expand Down Expand Up @@ -617,27 +615,37 @@
}

async publishToState(devId, model, payload) {
const devStates = await this.getDevStates(`0x${devId}`, model);
let has_debug = false;
if (this.debugDevices === undefined) this.getDebugDevices();
if (this.checkDebugDevice(devId))
{
if (!payload.hasOwnProperty('msg_from_zigbee')) {
this.warn(`ELEVATED publishToState: message received '${JSON.stringify(payload)}' from device ${devId} type '${model}'`);
has_debug = true;
}

var isMsg_from_zigbee = payload.hasOwnProperty('msg_from_zigbee');
var isCommonState = isMsg_from_zigbee||
payload.hasOwnProperty('linkquality');

let has_debug = ! isMsg_from_zigbee && this.checkDebugDevice(devId);

if (has_debug){
this.warn(`ELEVATED publishToState: message received '${JSON.stringify(payload)}' from device ${devId} type '${model}'`);

Check notice

Code scanning / CodeQL

Semicolon insertion Note

Avoid automated semicolon insertion (96% of all statements in
the enclosing function
Loading
have an explicit semicolon).
}

let states = undefined;
if (isCommonState){
states = statesMapping.commonStates;
}
if (!devStates) {
if (has_debug) this.error(`ELEVATED publishToState: no device states for device ${devId} type '${model}'`)
return;
else{
const devStates = await this.getDevStates(`0x${devId}`, model);

if (!devStates) {
if (has_debug) this.error(`ELEVATED publishToState: no device states for device ${devId} type '${model}'`)
return;
}

states = statesMapping.commonStates.concat(
devStates.states.filter(statedesc => payload.hasOwnProperty(statedesc.prop || statedesc.id))
);
}

// find states for payload
if (devStates.states !== undefined) {
if (states!== undefined) {
try {
const states = statesMapping.commonStates.concat(
devStates.states.filter(statedesc => payload.hasOwnProperty(statedesc.prop || statedesc.id))
);

for (const stateInd in states) {
const statedesc = states[stateInd];
let value;
Expand All @@ -653,8 +661,8 @@

let stateID = statedesc.id;

if (has_debug && statedesc.id !== 'msg_from_zigbee') {
this.warn(`ELEVATED publishToState: value generated '${JSON.stringify(value)}' from device ${devId} for '${statedesc.name}'`);
if (has_debug) {
this.warn(`ELEVATED publishToState: value generated '${JSON.stringify(value)}' from device ${devId} for '${statedesc.name}'`);
}

const common = {
Expand Down
7 changes: 3 additions & 4 deletions lib/zigbeecontroller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -697,13 +697,12 @@ class ZigbeeController extends EventEmitter {
}

async handleMessage(data) {
this.debug(`handleMessage`, data);
//this.debug(`handleMessage`, data);
const entity = await this.resolveEntity(data.device || data.ieeeAddr);
const name = (entity && entity._modelID) ? entity._modelID : data.device.ieeeAddr;
this.debug(
`Received Zigbee message from '${name}', type '${data.type}', cluster '${data.cluster}'` +
`, data '${JSON.stringify(data.data)}' from endpoint ${data.endpoint.ID}` +
(data.hasOwnProperty('groupID') ? ` with groupID ${data.groupID}` : ``)
`HandleMessage. Received Zigbee message from '${name}', type '${data.type}', cluster '${data.cluster}', from endpoint ${data.endpoint.ID}` +
(data.hasOwnProperty('groupID') ? ` with groupID ${data.groupID}` : ``) + ` data:`,data.data
);
this.event(data.type, entity, data);

Expand Down
36 changes: 29 additions & 7 deletions main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,8 @@
}

async onZigbeeEvent(type, entity, message) {
this.log.debug(`Type ${type} device ${safeJsonStringify(entity)} incoming event: ${safeJsonStringify(message)}`);
//Optimization: Use checkDebugDevice as entity and message objects can be very large (ie PTVO 8chanels relay safeJsonStringify(entity) -> 90 kb size)
//this.log.debug(`Type ${type} device ${safeJsonStringify(entity)} incoming event: ${safeJsonStringify(message)}`);

const device = entity.device;
const mappedModel = entity.mapped;
Expand All @@ -468,15 +469,24 @@
const meta = {device};

if (this.stController.checkDebugDevice(devId)) {

//Full log:
//this.log.debug(`ELEVATED: Zigbee Event of Type "${type}" from device: ${safeJsonStringify(entity)}`);
//this.log.debug(`ELEVATED: incoming event:${safeJsonStringify(message)}`);

const shortMessage = {};
for(const propertyName in message) {
shortMessage[propertyName] = message[propertyName];
}
shortMessage.device = device.ieeeAddr;
shortMessage.meta = undefined;
shortMessage.endpoint = (message.endpoint.ID ? message.endpoint.ID: -1);
this.log.warn(`ELEVATED: Zigbee Event of Type ${type} from device ${safeJsonStringify(device.ieeeAddr)}, incoming event: ${safeJsonStringify(shortMessage)}`);
}
this.log.warn(`* ELEVATED: Zigbee Event of Type "${type}" from device "${safeJsonStringify(device.ieeeAddr)}" incoming event: ${safeJsonStringify(shortMessage)}`);
}else
{
this.onLog('debug',`* Zigbee Event of Type ${type} from device ${devId}. incoming event:`, message);
};

// this assigment give possibility to use iobroker logger in code of the converters, via meta.logger
meta.logger = this.log;

Expand Down Expand Up @@ -576,7 +586,11 @@
async processConverters(converters, devId, model, mappedModel, message, meta) {
for (const converter of converters) {
const publish = (payload) => {
this.log.debug(`Publish ${safeJsonStringify(payload)} to ${safeJsonStringify(devId)}`);

if (this.stController.checkDebugDevice(devId))
this.log.warn(`ELEVATED: ProcessConverters devId:${devId} payload: ${safeJsonStringify(payload)}`);
else this.onLog('debug', `Publish to ${devId}. payload:`, payload);

if (typeof payload === 'object') {
this.publishToState(devId, model, payload);
}
Expand Down Expand Up @@ -625,15 +639,21 @@
let isGroup = false;
const has_elevated_debug = this.stController.checkDebugDevice(deviceId)

this.log.debug(`publishFromState : ${deviceId} ${model} ${safeJsonStringify(stateList)}`);

if(has_elevated_debug)
this.log.warn(`ELEVATED: PublishFromState : ${deviceId} ${model} stateList: ${safeJsonStringify(stateList)}`)
else this.onLog('debug',`PublishFromState : ${deviceId} ${model}. stateList:`, stateList);

if (model === 'group') {
isGroup = true;
deviceId = parseInt(deviceId);
}
try {
const entity = await this.zbController.resolveEntity(deviceId);

this.log.debug(`entity: ${deviceId} ${model} ${safeJsonStringify(entity)}`);
if (has_elevated_debug)
this.log.warn(`ELEVATED: PublishFromState. ${deviceId} ${model} entity: ${safeJsonStringify(entity)}`)
else this.onLog('debug',`PublishFromState : ${deviceId} ${model} entity:`, entity);

const mappedModel = entity.mapped;

Expand Down Expand Up @@ -1086,7 +1106,9 @@
if (typeof data === 'string') {
logger(`${msg}. ${data}`);
} else {
logger(`${msg}. ${safeJsonStringify(data)}`);
if (this.log.level==level)
logger(`${msg}. ${safeJsonStringify(data)}`)

Check notice

Code scanning / CodeQL

Semicolon insertion Note

Avoid automated semicolon insertion (93% of all statements in
the enclosing function
Loading
have an explicit semicolon).
else logger(`${msg}. {DATA unavailable. Check log level}`);
}
} else {
logger(msg);
Expand Down
Loading