Skip to content

Commit ef915fd

Browse files
vdemeestervdemeester
committed
Add support for Names and ID in stats format
This adds support to display names or id of container instead of what was provided in the request. This keeps the default behavior (`docker stats byname` will display `byname` in the `CONTAINER` colmun and `docker stats byid` will display the id in the `CONTAINER` column) but adds two new format directive. Signed-off-by: Vincent Demeester <vincent@sbr.pm>
1 parent 1f41378 commit ef915fd

File tree

5 files changed

+33
-13
lines changed

5 files changed

+33
-13
lines changed

‎api/types/stats.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,9 @@ type Stats struct {
170170
type StatsJSON struct {
171171
Stats
172172

173+
Name string `json:"name,omitempty"`
174+
ID string `json:"id,omitempty"`
175+
173176
// Networks request version >=1.21
174177
Networks map[string]NetworkStats `json:"networks,omitempty"`
175178
}

‎cli/command/container/stats_helpers.go‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var daemonOSType string
2929
func (s *stats) add(cs *formatter.ContainerStats) bool {
3030
s.mu.Lock()
3131
defer s.mu.Unlock()
32-
if _, exists := s.isKnownContainer(cs.Name); !exists {
32+
if _, exists := s.isKnownContainer(cs.Container); !exists {
3333
s.cs = append(s.cs, cs)
3434
return true
3535
}
@@ -46,15 +46,15 @@ func (s *stats) remove(id string) {
4646

4747
func (s *stats) isKnownContainer(cid string) (int, bool) {
4848
for i, c := range s.cs {
49-
if c.Name == cid {
49+
if c.Container == cid {
5050
return i, true
5151
}
5252
}
5353
return -1, false
5454
}
5555

5656
func collect(s *formatter.ContainerStats, ctx context.Context, cli client.APIClient, streamStats bool, waitFirst *sync.WaitGroup) {
57-
logrus.Debugf("collecting stats for %s", s.Name)
57+
logrus.Debugf("collecting stats for %s", s.Container)
5858
var (
5959
getFirst bool
6060
previousCPU uint64
@@ -70,7 +70,7 @@ func collect(s *formatter.ContainerStats, ctx context.Context, cli client.APICli
7070
}
7171
}()
7272

73-
response, err := cli.ContainerStats(ctx, s.Name, streamStats)
73+
response, err := cli.ContainerStats(ctx, s.Container, streamStats)
7474
if err != nil {
7575
s.SetError(err)
7676
return
@@ -125,6 +125,8 @@ func collect(s *formatter.ContainerStats, ctx context.Context, cli client.APICli
125125
}
126126
netRx, netTx := calculateNetwork(v.Networks)
127127
s.SetStatistics(formatter.StatsEntry{
128+
Name: v.Name,
129+
ID: v.ID,
128130
CPUPercentage: cpuPercent,
129131
Memory: mem,
130132
MemoryPercentage: memPerc,

‎cli/command/formatter/stats.go‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ const (
2424

2525
// StatsEntry represents represents the statistics data collected from a container
2626
type StatsEntry struct {
27+
Container string
2728
Name string
29+
ID string
2830
CPUPercentage float64
2931
Memory float64 // On Windows this is the private working set
3032
MemoryLimit float64 // Not used on Windows
@@ -85,7 +87,7 @@ func (cs *ContainerStats) SetError(err error) {
8587
func (cs *ContainerStats) SetStatistics(s StatsEntry) {
8688
cs.mutex.Lock()
8789
defer cs.mutex.Unlock()
88-
s.Name = cs.Name
90+
s.Container = cs.Container
8991
s.OSType = cs.OSType
9092
cs.StatsEntry = s
9193
}
@@ -109,9 +111,9 @@ func NewStatsFormat(source, osType string) Format {
109111
}
110112

111113
// NewContainerStats returns a new ContainerStats entity and sets in it the given name
112-
func NewContainerStats(name, osType string) *ContainerStats {
114+
func NewContainerStats(container, osType string) *ContainerStats {
113115
return &ContainerStats{
114-
StatsEntry: StatsEntry{Name: name, OSType: osType},
116+
StatsEntry: StatsEntry{Container: container, OSType: osType},
115117
}
116118
}
117119

@@ -138,7 +140,18 @@ type containerStatsContext struct {
138140

139141
func (c *containerStatsContext) Container() string {
140142
c.AddHeader(containerHeader)
141-
return c.s.Name
143+
return c.s.Container
144+
}
145+
146+
func (c *containerStatsContext) Name() string {
147+
c.AddHeader(nameHeader)
148+
name := c.s.Name[1:]
149+
return name
150+
}
151+
152+
func (c *containerStatsContext) ID() string {
153+
c.AddHeader(containerIDHeader)
154+
return c.s.ID
142155
}
143156

144157
func (c *containerStatsContext) CPUPerc() string {

‎cli/command/formatter/stats_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ func TestContainerStatsContext(t *testing.T) {
1818
expHeader string
1919
call func() string
2020
}{
21-
{StatsEntry{Name: containerID}, containerID, containerHeader, ctx.Container},
21+
{StatsEntry{Container: containerID}, containerID, containerHeader, ctx.Container},
2222
{StatsEntry{CPUPercentage: 5.5}, "5.50%", cpuPercHeader, ctx.CPUPerc},
2323
{StatsEntry{CPUPercentage: 5.5, IsInvalid: true}, "--", cpuPercHeader, ctx.CPUPerc},
2424
{StatsEntry{NetworkRx: 0.31, NetworkTx: 12.3}, "0.31 B / 12.3 B", netIOHeader, ctx.NetIO},
@@ -82,7 +82,7 @@ container2 --
8282
for _, te := range tt {
8383
stats := []StatsEntry{
8484
{
85-
Name: "container1",
85+
Container: "container1",
8686
CPUPercentage: 20,
8787
Memory: 20,
8888
MemoryLimit: 20,
@@ -96,7 +96,7 @@ container2 --
9696
OSType: "linux",
9797
},
9898
{
99-
Name: "container2",
99+
Container: "container2",
100100
CPUPercentage: 30,
101101
Memory: 30,
102102
MemoryLimit: 30,
@@ -150,7 +150,7 @@ container2 -- --
150150
for _, te := range tt {
151151
stats := []StatsEntry{
152152
{
153-
Name: "container1",
153+
Container: "container1",
154154
CPUPercentage: 20,
155155
Memory: 20,
156156
MemoryLimit: 20,
@@ -164,7 +164,7 @@ container2 -- --
164164
OSType: "windows",
165165
},
166166
{
167-
Name: "container2",
167+
Container: "container2",
168168
CPUPercentage: 30,
169169
Memory: 30,
170170
MemoryLimit: 30,

‎daemon/stats.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ func (daemon *Daemon) ContainerStats(ctx context.Context, prefixOrName string, c
4444
var preRead time.Time
4545
getStatJSON := func(v interface{}) *types.StatsJSON {
4646
ss := v.(types.StatsJSON)
47+
ss.Name = container.Name
48+
ss.ID = container.ID
4749
ss.PreCPUStats = preCPUStats
4850
ss.PreRead = preRead
4951
preCPUStats = ss.CPUStats

0 commit comments

Comments
 (0)