Skip to content

feat(ps): show container health status in STATUS column #4933

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AkihiroSuda merged 1 commit into from
May 26, 2026
+132 −0
Merged

feat(ps): show container health status in STATUS column #4933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions cmd/nerdctl/container/container_list_linux_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,13 @@ import (

"gotest.tools/v3/assert"

"github.com/containerd/nerdctl/mod/tigron/expect"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/tig"

"github.com/containerd/nerdctl/v2/pkg/formatter"
"github.com/containerd/nerdctl/v2/pkg/healthcheck"
"github.com/containerd/nerdctl/v2/pkg/strutil"
"github.com/containerd/nerdctl/v2/pkg/tabutil"
"github.com/containerd/nerdctl/v2/pkg/testutil"
Expand Down Expand Up @@ -699,3 +702,118 @@ func TestContainerListStatusFilter(t *testing.T) {

testCase.Run(t)
}

func TestContainerListWithHealthStatus(t *testing.T) {
testCase := nerdtest.Setup()

testCase.Require = require.All(
// Docker CLI does not provide a standalone healthcheck command.
require.Not(nerdtest.Docker),
Copy link
Copy Markdown
Member

@AkihiroSuda AkihiroSuda May 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the reason as a code comment

Copy link
Copy Markdown
Member Author

@haytok haytok May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I've added the reason. (// Docker CLI does not provide a standalone healthcheck command.)

require.Not(nerdtest.Rootless),
)

testCase.SubTests = []*test.Case{
{
Description: "ps shows healthy status after a successful probe",
Setup: func(data test.Data, helpers test.Helpers) {
helpers.Ensure("run", "-d", "--name", data.Identifier(),
"--health-cmd", "true", "--health-interval", "3s",
testutil.CommonImage, "sleep", nerdtest.Infinity,
)
helpers.Ensure("container", "healthcheck", data.Identifier())
},
Cleanup: func(data test.Data, helpers test.Helpers) {
helpers.Anyhow("rm", "-f", data.Identifier())
},
Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
return helpers.Command("ps", "--filter", "name="+data.Identifier())
},
Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
return &test.Expected{
ExitCode: expect.ExitCodeSuccess,
Output: expect.Contains(fmt.Sprintf("(%s)", healthcheck.Healthy)),
}
},
},
{
Description: "ps shows starting status",
Setup: func(data test.Data, helpers test.Helpers) {
helpers.Ensure("run", "-d", "--name", data.Identifier(),
"--health-cmd", "exit 1",
"--health-interval", "1s",
"--health-start-period", "60s",
"--health-retries", "2",
testutil.CommonImage, "sleep", nerdtest.Infinity)
nerdtest.EnsureContainerStarted(helpers, data.Identifier())
helpers.Ensure("container", "healthcheck", data.Identifier())
},
Cleanup: func(data test.Data, helpers test.Helpers) {
helpers.Anyhow("rm", "-f", data.Identifier())
},
Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
return helpers.Command("ps", "--filter", "name="+data.Identifier())
},
Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
return &test.Expected{
ExitCode: expect.ExitCodeSuccess,
Output: expect.Contains(fmt.Sprintf("(health: %s)", healthcheck.Starting)),
}
},
},
{
Description: "ps shows unhealthy status",
Setup: func(data test.Data, helpers test.Helpers) {
helpers.Ensure("run", "-d", "--name", data.Identifier(),
"--health-cmd", "not-a-real-cmd",
"--health-interval", "1s",
"--health-retries", "1",
testutil.CommonImage, "sleep", nerdtest.Infinity)
nerdtest.EnsureContainerStarted(helpers, data.Identifier())
helpers.Ensure("container", "healthcheck", data.Identifier())
},
Cleanup: func(data test.Data, helpers test.Helpers) {
helpers.Anyhow("rm", "-f", data.Identifier())
},
Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
return helpers.Command("ps", "--filter", "name="+data.Identifier())
},
Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
return &test.Expected{
ExitCode: expect.ExitCodeSuccess,
Output: expect.Contains(fmt.Sprintf("(%s)", healthcheck.Unhealthy)),
}
},
},
{
Description: "ps does not show health suffix for stopped containers",
Setup: func(data test.Data, helpers test.Helpers) {
helpers.Ensure("run", "-d", "--name", data.Identifier(),
"--health-cmd", "true",
testutil.CommonImage, "sleep", nerdtest.Infinity)
helpers.Ensure("container", "healthcheck", data.Identifier())
helpers.Ensure("stop", data.Identifier())
},
Cleanup: func(data test.Data, helpers test.Helpers) {
helpers.Anyhow("rm", "-f", data.Identifier())
},
Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
return helpers.Command("ps", "-a", "--filter", "name="+data.Identifier())
},
Expected: func(data test.Data, helpers test.Helpers) *test.Expected {
return &test.Expected{
ExitCode: expect.ExitCodeSuccess,
Output: expect.All(
expect.Contains("Exited"),
expect.DoesNotContain(
"(health:",
fmt.Sprintf("(%s)", healthcheck.Healthy),
fmt.Sprintf("(%s)", healthcheck.Unhealthy),
),
),
}
},
},
}

testCase.Run(t)
}
14 changes: 14 additions & 0 deletions pkg/cmd/container/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import (
"github.com/containerd/nerdctl/v2/pkg/containerdutil"
"github.com/containerd/nerdctl/v2/pkg/containerutil"
"github.com/containerd/nerdctl/v2/pkg/formatter"
"github.com/containerd/nerdctl/v2/pkg/healthcheck"
"github.com/containerd/nerdctl/v2/pkg/imgutil"
"github.com/containerd/nerdctl/v2/pkg/labels"
"github.com/containerd/nerdctl/v2/pkg/portutil"
Expand Down Expand Up @@ -161,6 +162,19 @@ func prepareContainers(ctx context.Context, client *containerd.Client, container
var status string
if s, ok := statusPerContainer[c.ID()]; ok {
status = s
if strings.HasPrefix(status, "Up") && info.Labels[labels.HealthState] != "" {
healthState, err := healthcheck.HealthStateFromJSON(info.Labels[labels.HealthState])
if err != nil {
log.G(ctx).WithError(err).Debugf("failed to parse health state for container %s", c.ID())
} else {
switch healthState.Status {
case healthcheck.Healthy, healthcheck.Unhealthy:
status = fmt.Sprintf("%s (%s)", status, healthState.Status)
case healthcheck.Starting:
status = fmt.Sprintf("%s (health: %s)", status, healthState.Status)
}
}
}
} else {
return nil, fmt.Errorf("can't get container %s status", c.ID())
}
Expand Down
Loading