Skip to content

docs(timestamps): fix outdated enabling timestamping section#787

Open
Chennamma-Hotkar wants to merge 1 commit into
urunc-dev:mainfrom
Chennamma-Hotkar:docs/issue-624-fix-timestamping-guide
Open

docs(timestamps): fix outdated enabling timestamping section#787
Chennamma-Hotkar wants to merge 1 commit into
urunc-dev:mainfrom
Chennamma-Hotkar:docs/issue-624-fix-timestamping-guide

Conversation

@Chennamma-Hotkar

@Chennamma-Hotkar Chennamma-Hotkar commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Description

The "How to enable timestamping" section in docs/developer-guide/timestamps.md described an outdated method (creating a separate containerd-shim wrapper + URUNC_TIMESTAMPS=1 env var). urunc has since moved to a config.toml-based approach (confirmed via #596).

This PR updates the docs to:

  • Show the current config.toml approach for enabling timestamps
  • Fix the example runtime command from io.containerd.uruncts.v2 to io.containerd.urunc.v2
  • Correct the log path from /tmp/urunc.zlog to /var/log/urunc/timestamps.log
  • Remove the outdated "hardcoded path" note, since the destination is now configurable
  • Mention the graceful degradation behavior introduced in fix(metrics): fallback to mock writer on file open failure to prevent panic #596

Related issues

How was this tested?

Verified no other files reference the outdated method:

grep -rn "URUNC_TIMESTAMPS\|uruncts\|urunc.zlog" docs/
# (no results)

Manually reviewed the full rendered file for correct markdown formatting and accuracy against the current urunc_config.go defaults and PR #596.

LLM usage

N/A

Checklist

  • I have read the contribution guide.
  • The linter passes locally (make lint).
  • The e2e tests of at least one tool pass locally (make test_ctr, make test_nerdctl, make test_docker, make test_crictl).
  • If LLMs were used: I have read the llm policy.

Replace old shim/env-var instructions with config.toml approach.
Update log path from /tmp/urunc.zlog to /var/log/urunc/timestamps.log.

Closes urunc-dev#624

Signed-off-by: Chennamma-Hotkar <channuhotkar@gmail.com>
@netlify

netlify Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deploy Preview for urunc ready!

Name Link
🔨 Latest commit 90fc8cb
🔍 Latest deploy log https://app.netlify.com/projects/urunc/deploys/6a3e9b85dc834f0009262098
😎 Deploy Preview https://deploy-preview-787--urunc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant