ipfs/kubo

Lower healthcheck interval

Open

#10,392 opened on Apr 9, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
P2help wantedkind/enhancement

Description

Checklist

  • My issue is specific & actionable.
  • I am not suggesting a protocol enhancement.
  • I have searched on the issue tracker for my issue.

Description

Could it be useful to lower the healthcheck interval? From: HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \ To: HEALTHCHECK --interval=5s --timeout=3s --start-period=5s --retries=20 \

Rationale: If you have a service that has IPFS/Kubo as dependency, about 15/20s of boot time get added for every fresh deployment.

This is not an impactful case for production cases, but pre-production & CI cases might see some improvement. In my personal case, I've already seen that gain when using a modified version of Kubo with these settings.
I might be missing something, but I cannot see many drawbacks to have a high interval value, although this could be due to missing some deep internal elements of a DAG resolution at boot time.

PS: if required & desired, I could do the PR myself, although I guess first it's better to agree here about going forward with this change.

Best.

Contributor guide

Tech stack
godocker
Domain
devops
Issue type
performance
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Docker knowledgeunderstanding of healthcheck
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the Dockerfile in the repository (likely at the root) to locate the HEALTHCHECK instruction. Verify the current settings and consider the proposed change to interval=5s and retries=20. Assess whether the lower interval could cause false positives in production or if it is safe for CI/pre production. The issue author has offered to submit a PR if agreed, so await maintainer feedback or initiate discussion on trade offs.
Lower healthcheck interval · ipfs/kubo#10392 | Good First Issue