improve player join log line to contain more information

[jxsl13]

https://github.com/ddnet/ddnet/blob/9a8541648c33f1879fbc7fc9b9f1e825bed6a591/src/engine/server/server.cpp#L1675

would be great if this log line was changed to contain as much player information as possible in order to reproduce the current server state by parsing logs / Econ.

https://github.com/teeworlds/teeworlds/issues/2475#issuecomment-944926682

reference log line

str_format(aBuf, sizeof(aBuf),"id=%d addr=%s version=%d name='%s' clan='%s' country=%d", ClientID, aClientAddr, ClientVersion, pName, pClan, Country);

example how the ddnet log line could look like:

player has entered the game. ClientID=%d addr=<{%s}> sixup=%d version=%d name='%s' clan='%s' country=%d

[ChillerDragon]

As a fellow log parser I like it. But the line feels a bit long :c

[jxsl13]

One could shorten the prefix to something like player entered or client entered. but In wanted to keep it as backwards compatible as possible.

[ChillerDragon]

Yea the just appending stuff at the end is convenient. While at it to change the log format and setting something new that we would want to stay backwards compatible to. How about we make it safer to parse. As in introduce proper escaping or encoding. What if someone uses the name foo'bar and the clan ' country= then it shows up as

player has entered the game. ClientID=0 addr=<{127.0.0.1}> sixup=1 version=0 name='foo'bar' clan='' country=' country=0

[jxsl13]

it does not matter for a decent regex implementation. They are (usually) greedy trying to find the longest (sub)match.

Example: https://regex101.com/r/zNPepP/2

[ChillerDragon]

Okay LGTM. I the chilled dragon :dragon: do hereby approve this RFC. :rocket: :heavy_check_mark:

[heinrich5991]

I don't see clan and country to be all that useful as these can change without log message. Name would be nice though.

[jxsl13]

There are two purposes that one might want have for that:

The first purpose is to attach an econ or log parser that is able to replicate the whole state of the server by parsing logs and allowing to visualize the state easily with languages other than C++ with e.g. a website or a discord bot, without having to poll master servers. Posting a gameover statboard in the context of ddnet-insta would be such a use case (even tho the current approach is different but ddnet-insta may not be the last pvp mod that's based on ddnet and has a statboard). Every possible information would be necessary for this as well as a log line for every state transition.

My (current) primary use case for this log line is primarily hooking into certain event log lines like

• player join (really necessary info: nickname, clan, ip, id, sixup, client version)
  • having a distributed ban server that's attached to a multitude of servers
  • having a vpn detection attached to multiple servers
  • collecting player ips that are associated to for example their nicknames, clans, client versions for the purpose of analyzing malicious players that frequently change their (primarily) nicknames or ips while disrupting the gameplay of others
  • (not yet witnessed but may be possible that not only individuals but whole groups may act maliciously with a certain clan tag, in which case it'd be interesting to see a collection of their ips in order to analyze those for patterns, specific ASNs, etc.)
• kick vote started
  • parsing the vote reason for automatic responses for some obvious cases like insults, etc.
  • providing an interaction for moderators for aborting the vote (via e.g. discord)
• kick vote ended (ban/abort)
  • disabling the (discord) interaction again
• chat messages
  • allowing ingame players to ping an admin via an econ bridge on e.g. discord
  • admins chatting with ingame players, warning players, etc. (- distributed periodic announcements)
  • allow players to participate in polls (limited for example to one participation per player ip or a more complex rule)
  • trivia bots, etc.
• kill messages
  • announcing stuff like killing sprees (more of a vanilla use case)
  • having some distributed statistics server (k/d, total kills, total deaths, etc) (because C++ is a pain)
• team change messages
  • collecting statistics like how long someone played the game
  • how long in spec, etc.

Some of those are just thoughts that might become a use case but for now it's just all of the stuff related to moderation and not necessarily trivia bots and so on.

[heinrich5991]

The first purpose is to attach an econ or log parser that is able to replicate the whole state of the server by parsing logs and allowing to visualize the state easily with languages other than C++ with e.g. a website or a discord bot, without having to poll master servers.

Starting to support that sounds like a pain, especially since log message changes now become breaking…

[jxsl13]

that's not my main purpose but yeah, that'd be a complete logging rework, preferrably with unique keywords describing state transitions. it's out of scope of this issue, I'd say.

[jxsl13]

player has entered the game. ClientID=%d addr=<{%s}> sixup=%d version=%d name='%s' clan='%s'

[jxsl13]

bump