zonemaster-engine
zonemaster-engine copied to clipboard
zonemaster
Coherent naming of args in the log
Sometimes nsset is called ns. Sometimes ns is called name. Sometimes an "ns" is only a name of a name server, and sometimes it is attached to an IP-adress. Sometimes it is split into an "ns" and an "address".
Sometimes the args is also empty, when there there is likely to actually contain data.
We really need to have coherent naming of the args in the log, with specific types attached to the name.
This is assigned to the whole team, and should be a team effort. This should also be documented.
I have prepared this document as a starting point: https://github.com/dotse/zonemaster/blob/master/docs/benchmark/logconsistency.md
I'm currently going through the code and writing a list of all the types of information logged, so we can start with making a list of names for all the different kinds. When we have that, we can start changing the code to use them.
Yes of course, once I'll be back from vacation.
2015-04-27 11:18 GMT+02:00 Patrik Wallström [email protected]:
@vlevigneron https://github.com/vlevigneron Is this something you can spend some time on?
— Reply to this email directly or view it on GitHub https://github.com/dotse/zonemaster-engine/issues/60#issuecomment-96580399 .
https://github.com/dotse/zonemaster-engine/blob/master/doc/logentry_args.md has a table where we can fill in the names to be used for the various kinds of data used. There are 71 different kinds, and that does not include any SYSTEM messages. Do we need to cover those as well?
I don't think there is a need to look at the SYSTEM messages at this moment. At least I have never used them for anything useful - yet.
Ok. I think we will discuss with Vincent to decide on the release timings.
On 17 May 2015 at 18:10, Patrik Wallström [email protected] wrote:
I strongly think that we should have a higher priority on this than that...
— Reply to this email directly or view it on GitHub https://github.com/dotse/zonemaster-engine/issues/60#issuecomment-102819285 .
If it is ok, I will start fixing a number of those things soon.
I will create a new issue for each "name".
Hi Patrik,
In case if you do not need Vincent, i think you can start looking at it.
Sandoche.
On 6 August 2015 at 14:53, Patrik Wallström [email protected] wrote:
If it is ok, I will start fixing a number of those things soon.
I will create a new issue for each "name".
— Reply to this email directly or view it on GitHub https://github.com/dotse/zonemaster-engine/issues/60#issuecomment-128353033 .
@sandoche2k - Put https://github.com/dotse/zonemaster/blob/master/docs/benchmark/logconsistency.md into ZM/docs @pawal - Keep the issue open
Ping @sandoche2k - could you put logconsistency.md back somewhere in the docs structure?
This is an ongoing work. "Arguments for test case messages" has been updated with more well defined argument names for many arguments (last updated at the time of writing was 2022-05-16). The implementation of the test cases has also been updated to match the well-defined argument names.
- Add status column to the test case tracking issue (https://github.com/zonemaster/zonemaster/issues/1051).
- Most messages on DebugX level are not covered by the test cases.
- Create a tracking issue for the system message (messages outside the test case code).
- Extract the argument names used and compare with the defined names.