docs: Developer Guide > Execution time breakdown > How to enable timestamping outdated

[jiwahn]

• In the doc, Developer Guide > Execution time breakdown > How to enable timestamping section, it said that we need to set URNC_TIMESTAMPS=1 to enable timestamping.
• It now seems like urunc uses configuration file to enable timestamp. We need to update the doc.
• https://urunc.io/configuration/

[r0hansaxena]

I'll raise a PR for this

[jiwahn]

Great. You could be assigned once maintainer approves this issue, and then a PR.

[cmainas]

Hello @jiwahn ,

thank you for opening the issue. Indeed, the docs need to be updated.

[neo-0007]

Hi , While using the configuration file for enabling the timestamps.
I discovered a bug. The current docs suggests that we use "/var/log/urunc/timestamps.log" as path for the log file . But if the directory /var/log/urunc/ does not exists. We get a runtime error:

FATA[0000] failed to create shim task: OCI runtime create failed: urunc did not terminate successfully: exit status 2: panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x20 pc=0x76e8d1]

goroutine 1 [running]:
main.createUnikontainer(0xcd8960, 0xc00006a840)
	/home/neo-0007/urunc/cmd/urunc/create.go:97 +0x71
main.init.func1({0xcd8960?, 0xa07868?}, 0xcd8960)
	/home/neo-0007/urunc/cmd/urunc/create.go:78 +0x1e5
github.com/urfave/cli/v3.(*Command).run(0xcd8960, {0xa07868, 0xc00019e240}, {0xc000182a00, 0x8, 0x8})
	/home/neo-0007/urunc/vendor/github.com/urfave/cli/v3/command_run.go:364 +0x2a4c
github.com/urfave/cli/v3.(*Command).run(0xc000141b88, {0xa07868, 0xc000109da0}, {0xc0000160f0, 0xf, 0xf})
	/home/neo-0007/urunc/vendor/github.com/urfave/cli/v3/command_run.go:298 +0x22b6
github.com/urfave/cli/v3.(*Command).Run(...)
	/home/neo-0007/urunc/vendor/github.com/urfave/cli/v3/command_run.go:93
main.main()
	/home/neo-0007/urunc/cmd/urunc/main.go:151 +0x446 

@r0hansaxena If you are working on the docs for this please keep this in mind. I will open an other issue for the bug with better explanation and my suggested ideas to fix this. I think we should keep the docs issue on hold until the bug is fixed, so we don't document a path like /var/log/urunc/ that will silently crash urunc if the directory doesn't exist. what do you think @jiwahn , @cmainas ?

[jiwahn]

Hi @neo-0007, Thanks for sharing this. Could you share how to reproduce this as well?

[neo-0007]

Hi @jiwahn , I have created an issue for this #630 , please let me know if you can reproduce this. Thanks !

---

Edit : This issue has already been reported and confirmed in #596

[Chennamma-Hotkar]

I would like to collaborate on this. As I read through that discussion I traced back the dependency chain where #630 was a duplicate of #595 which is currently still open and in progress (#596). Right now, it indicates that if we change the docs now to destination="/var/log/urunc/timestamps.log" without being fixed by #595, users will follow the new docs and hit the same crash.

I see two possibilities: we can wait for #596 to merge and then update the docs together, or we can do it now but use /tmp/urunc-timestamps.log as the example path, since /tmp always exists. Which method do you prefer @cmainas and @jiwahn?