LuaProfiler and logging

[orzelek]

Can someone give me some hints how to store output of those into script output?
I have a logger in RSO that accepts text and dumps all of it after a command to file. But I doesn't seem to be able to convert profiler to string in nice way.
Only way that seems to work is like this:
log{"Search time __1__ spawn time __2__ ", scanProfiler, placeProfiler}
and it writes something to log file but it's not fully working:
313.553 Script @__rso-mod__/control.lua:733: Unknown key: "Search time Duration: 234.668400ms spawn time 2 "
It seems that more then one of those doesn't want to work correctly?

I'd really prefer to be able to write it to script output as string even with risk of desyncs - I have a lot of debug output there and separate stuff on log() is hard to reconcile with it.

[Bilka]

It's just a localized string, so treat it like one: https://wiki.factorio.com/Tutorial:Localisation https://lua-api.factorio.com/latest/Con ... isedString

[orzelek]

The example with __1__ and __2__ in same string is exaclty what I used and as you can see the result was not as expected since second substitution didn't work.
And I don't think that adding a new localized string to mod for debugging purposes is the intended solution?
If thats the case then it's quite a convoluted way to do this.

[eradicator]

The example with __1__ and __2__ in same string is exaclty what I used

Templates can not be defined at runtime, so...

And I don't think that adding a new localized string to mod for debugging purposes is the intended solution?

Yes, that is exactly what you'll have to do.
Personally i use a generic

Code: Select all

[whatever]
mergetwo=__1____2__
mergethree=__1____2____3___

template to get around this engine limitation.

[Klonan]

Can someone give me some hints how to store output of those into script output?
I have a logger in RSO that accepts text and dumps all of it after a command to file. But I doesn't seem to be able to convert profiler to string in nice way.
Only way that seems to work is like this:
log{"Search time __1__ spawn time __2__ ", scanProfiler, placeProfiler}
and it writes something to log file but it's not fully working:
313.553 Script @__rso-mod__/control.lua:733: Unknown key: "Search time Duration: 234.668400ms spawn time 2 "
It seems that more then one of those doesn't want to work correctly?

I'd really prefer to be able to write it to script output as string even with risk of desyncs - I have a lot of debug output there and separate stuff on log() is hard to reconcile with it.

You need to do:


log{"", "Search time __1__ spawn time __2__ ", scanProfiler, placeProfiler}

[eradicator]

log{"", "Search time __1__ spawn time __2__ ", scanProfiler, placeProfiler}

How does that work? When i try it:

Code: Select all

/c log{"",'one __1__ two __2__',{'item-name.iron-plate'},game.create_profiler()}

>>one __1__ two __2__Iron plateElapsed: 0.024375ms

[Klonan]

log{"", "Search time __1__ spawn time __2__ ", scanProfiler, placeProfiler}

How does that work? When i try it:

Code: Select all

/c log{"",'one __1__ two __2__',{'item-name.iron-plate'},game.create_profiler()}

>>one __1__ two __2__Iron plateElapsed: 0.024375ms

Ah right, I was only looking at the 'Unknown key' issue.

Yea right now, it is not possible to use the 'parameter replacement' system with literal strings in this way

[eradicator]

Yea right now, it is not possible to use the 'parameter replacement' system with literal strings in this way

As a hacky-wacky-workaround, would it be realistic to have mergetwo (see post above) or similar added to the official english locale? And maybe even an official function that makes it easily usable? My current implementation is a variable argument function that uses nine predefined mergers to construct a nested locale table.

Code: Select all

---merges an arbitrary number of arguments into a locale compatible table
---because factorio doesn't have simple mergine of locale strings built in...
--@args arbitrary strings or locale-compatible tables. or a single table of arguments.
function liblocale.merge(...)

  local args = {...}
  
  --forgot arguments?
  if #args == 0 then
    stop('Too few locale.merge() arguments.')
    end
  
  --only one argument?
  if #args == 1 and type(args) ~= 'table' then
    stop('Too few locale.merge() arguments.')
    end
    
  --used a table instead of multiple arguments...
  if #args == 1 and type(args) == 'table' then
    args = args[1]
    end

  --construct nested "localized-string" table.
  --base game does not permit more than 20 arguments per table.
  repeat
    local new_args = {}
    for i=1,#args,9 do
      local x = (#args - i + 1)
      table_insert(new_args,{ --merge blocks of up to 9 things at a time
        'liblocale.merge'..tostring((x < 9) and x or 9), --the length of the last block must be precise!
        args[i+0],args[i+1],args[i+2],
        args[i+3],args[i+4],args[i+5],
        args[i+6],args[i+7],args[i+8],
        })
      end
    args = new_args
    until #args == 1 --nest things into each other until there's only *one* master table left
  
  return args[1]
  end

Usage example:

Code: Select all

log(merge('One: ',game.create_profiler(),'Two: ',game.create_profiler()))

Edit 1,2,3: So, as noted in the next post this whole hack can work just fine without locale.cfg entries. Time to fix my code.

[orzelek]

A lot of hacking here... seems like lua
Is there any actual way to log profiler time to log written to script-output?

Any way of allowing the profiler to change itself to string to be sent to logger would be pretty useful.

[eradicator]

Omf. I'm feel really stupid now. Ofc i can just use...

Code: Select all

/c log{'','First: [',game.create_profiler(),'], Second: [',game.create_profiler(),']'}
>> First: [Elapsed: 0.018388ms], Second: [Elapsed: 0.030790ms]

@orzelek: game.write_file accepts localized strings, so it should work the same.

[orzelek]

Omf. I'm feel really stupid now. Ofc i can just use...

Code: Select all

/c log{'','First: [',game.create_profiler(),'], Second: [',game.create_profiler(),']'}
>> First: [Elapsed: 0.018388ms], Second: [Elapsed: 0.030790ms]

@orzelek: game.write_file accepts localized strings, so it should work the same.

The thing is that it's wrapped into a debug object to cache strings and write up periodically. And it's a lua magic a bit for me (been in RSO for a long time before I took over). I guess I might need to make it go directly to write_file or write a debug method that accepts table and forwards it to write_file (if that makes sens in lua? I'm a c++/C# person ).

[eradicator]

The thing is that it's wrapped into a debug object to cache strings and write up periodically. And it's a lua magic a bit for me (been in RSO for a long time before I took over).

I didn't even know you *took over* RSO from someone else :p.

LuaProfiler is always a table, never a string, so if it's working now (except for the __1__ string replacements) then it shouldn't be a problem. Otherwise you'll have to fix the mod code to handle localized strings (==tables) in that part. Feel free to post links to github or something of the problematic parts? (No promises...)

For references i updated my merger (brand new and untested) to use the empty string method instead of relying on locale entries. But it's not really nessecary if you're merging fewer than 20 string "parts". (The "twenty" is a weird engine limitation btw, that merge() circumvents by chopping large tables up into smaller nested tables.)

Code: Select all

/c
--[[merges an arbitrary number of stuff into a localized string without needing locale.cfg entries]]
function merge2(...)
  local args = {...}
  
  local function pack20(tbl)
    local r = {''}
    for i=0,#tbl,20 do
      local segment = {''}
      for j=1,20 do
        local elm = tbl[i+j]
        segment[#segment+1] = (type(elm)=='table' and elm.valid) and {'','[',elm,']'} or elm
        end
      r[#r+1] = segment
      end
    return r
    end

  --[[each level can contain the { _KEY_ ,plus,twenty,strings,or,tables}]]
  repeat args = pack20(args) until #args < 22
  return args
  end

Example:

Code: Select all

/c
local long = {}
for i=1,90 do table.insert(long,' '..tostring(i)..' ') end  
local test = merge2('one: ',game.create_profiler(),'2: ',{'item-name.iron-plate'},game.player,unpack(long))
game.print(test)
print(serpent.line(test))

[slippycheeze]

FWIW, I've used the "just write it please" localized string format {"", text_to_print} successfully. I don't see why it wouldn't work here, and since you can compose the second string with arbitrary lua string operations you should be able to just use .. or table.join (or is it string.join, I never remember) to build the second argument. If it doesn't just write them all, I don't think I ever tried.