Skip to content

Commit 723be0a

Browse files
calaveracalavera
committed
Merge pull request #18888 from calavera/event_types
Event all the things!
2 parents dc4ca0e + 851fe00 commit 723be0a

40 files changed

Lines changed: 1318 additions & 565 deletions

‎api/client/events.go‎

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
package client
22

33
import (
4+
"encoding/json"
5+
"fmt"
6+
"io"
7+
"strings"
8+
"time"
9+
410
"github.com/docker/docker/api/types"
11+
eventtypes "github.com/docker/docker/api/types/events"
512
"github.com/docker/docker/api/types/filters"
613
Cli "github.com/docker/docker/cli"
714
"github.com/docker/docker/opts"
8-
"github.com/docker/docker/pkg/jsonmessage"
15+
"github.com/docker/docker/pkg/jsonlog"
916
flag "github.com/docker/docker/pkg/mflag"
1017
)
1118

@@ -46,5 +53,56 @@ func (cli *DockerCli) CmdEvents(args ...string) error {
4653
}
4754
defer responseBody.Close()
4855

49-
return jsonmessage.DisplayJSONMessagesStream(responseBody, cli.out, cli.outFd, cli.isTerminalOut)
56+
return streamEvents(responseBody, cli.out)
57+
}
58+
59+
// streamEvents decodes prints the incoming events in the provided output.
60+
func streamEvents(input io.Reader, output io.Writer) error {
61+
return decodeEvents(input, func(event eventtypes.Message, err error) error {
62+
if err != nil {
63+
return err
64+
}
65+
printOutput(event, output)
66+
return nil
67+
})
68+
}
69+
70+
type eventProcessor func(event eventtypes.Message, err error) error
71+
72+
func decodeEvents(input io.Reader, ep eventProcessor) error {
73+
dec := json.NewDecoder(input)
74+
for {
75+
var event eventtypes.Message
76+
err := dec.Decode(&event)
77+
if err != nil && err == io.EOF {
78+
break
79+
}
80+
81+
if procErr := ep(event, err); procErr != nil {
82+
return procErr
83+
}
84+
}
85+
return nil
86+
}
87+
88+
// printOutput prints all types of event information.
89+
// Each output includes the event type, actor id, name and action.
90+
// Actor attributes are printed at the end if the actor has any.
91+
func printOutput(event eventtypes.Message, output io.Writer) {
92+
if event.TimeNano != 0 {
93+
fmt.Fprintf(output, "%s ", time.Unix(0, event.TimeNano).Format(jsonlog.RFC3339NanoFixed))
94+
} else if event.Time != 0 {
95+
fmt.Fprintf(output, "%s ", time.Unix(event.Time, 0).Format(jsonlog.RFC3339NanoFixed))
96+
}
97+
98+
fmt.Fprintf(output, "%s %s %s", event.Type, event.Action, event.Actor.ID)
99+
100+
if len(event.Actor.Attributes) > 0 {
101+
var attrs []string
102+
for k, v := range event.Actor.Attributes {
103+
attrs = append(attrs, fmt.Sprintf("%s=%s", k, v))
104+
}
105+
fmt.Fprintf(output, " (%s)", strings.Join(attrs, ", "))
106+
}
107+
fmt.Fprint(output, "\n")
50108
}

‎api/client/stats.go‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ import (
1111
"time"
1212

1313
"github.com/docker/docker/api/types"
14+
"github.com/docker/docker/api/types/events"
15+
"github.com/docker/docker/api/types/filters"
1416
Cli "github.com/docker/docker/cli"
15-
"github.com/docker/docker/pkg/jsonmessage"
1617
"github.com/docker/go-units"
1718
)
1819

@@ -189,23 +190,27 @@ func (cli *DockerCli) CmdStats(args ...string) error {
189190
err error
190191
}
191192
getNewContainers := func(c chan<- watch) {
192-
options := types.EventsOptions{}
193+
f := filters.NewArgs()
194+
f.Add("type", "container")
195+
options := types.EventsOptions{
196+
Filters: f,
197+
}
193198
resBody, err := cli.client.Events(options)
194199
if err != nil {
195200
c <- watch{err: err}
196201
return
197202
}
198203
defer resBody.Close()
199204

200-
dec := json.NewDecoder(resBody)
201-
for {
202-
var j *jsonmessage.JSONMessage
203-
if err := dec.Decode(&j); err != nil {
205+
decodeEvents(resBody, func(event events.Message, err error) error {
206+
if err != nil {
204207
c <- watch{err: err}
205-
return
208+
return nil
206209
}
207-
c <- watch{j.ID[:12], j.Status, nil}
208-
}
210+
211+
c <- watch{event.ID[:12], event.Action, nil}
212+
return nil
213+
})
209214
}
210215
go func(stopChan chan<- error) {
211216
cChan := make(chan watch)

‎api/server/router/network/backend.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,5 @@ type Backend interface {
1919
DisconnectContainerFromNetwork(containerName string,
2020
network libnetwork.Network) error
2121
NetworkControllerEnabled() bool
22+
DeleteNetwork(name string) error
2223
}

‎api/server/router/network/network_routes.go‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -148,21 +148,7 @@ func (n *networkRouter) postNetworkDisconnect(ctx context.Context, w http.Respon
148148
}
149149

150150
func (n *networkRouter) deleteNetwork(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
151-
if err := httputils.ParseForm(r); err != nil {
152-
return err
153-
}
154-
155-
nw, err := n.backend.FindNetwork(vars["id"])
156-
if err != nil {
157-
return err
158-
}
159-
160-
if runconfig.IsPreDefinedNetwork(nw.Name()) {
161-
return httputils.WriteJSON(w, http.StatusForbidden,
162-
fmt.Sprintf("%s is a pre-defined network and cannot be removed", nw.Name()))
163-
}
164-
165-
return nw.Delete()
151+
return n.backend.DeleteNetwork(vars["id"])
166152
}
167153

168154
func buildNetworkResource(nw libnetwork.Network) *types.NetworkResource {

‎api/server/router/system/backend.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ package system
22

33
import (
44
"github.com/docker/docker/api/types"
5+
"github.com/docker/docker/api/types/events"
56
"github.com/docker/docker/api/types/filters"
6-
"github.com/docker/docker/pkg/jsonmessage"
77
)
88

99
// Backend is the methods that need to be implemented to provide
1010
// system specific functionality.
1111
type Backend interface {
1212
SystemInfo() (*types.Info, error)
1313
SystemVersion() types.Version
14-
SubscribeToEvents(since, sinceNano int64, ef filters.Args) ([]*jsonmessage.JSONMessage, chan interface{})
14+
SubscribeToEvents(since, sinceNano int64, ef filters.Args) ([]events.Message, chan interface{})
1515
UnsubscribeFromEvents(chan interface{})
1616
AuthenticateToRegistry(authConfig *types.AuthConfig) (string, error)
1717
}

‎api/server/router/system/system_routes.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ import (
99
"github.com/docker/docker/api"
1010
"github.com/docker/docker/api/server/httputils"
1111
"github.com/docker/docker/api/types"
12+
"github.com/docker/docker/api/types/events"
1213
"github.com/docker/docker/api/types/filters"
1314
timetypes "github.com/docker/docker/api/types/time"
1415
"github.com/docker/docker/pkg/ioutils"
15-
"github.com/docker/docker/pkg/jsonmessage"
1616
"golang.org/x/net/context"
1717
)
1818

@@ -98,8 +98,9 @@ func (s *systemRouter) getEvents(ctx context.Context, w http.ResponseWriter, r *
9898
for {
9999
select {
100100
case ev := <-l:
101-
jev, ok := ev.(*jsonmessage.JSONMessage)
101+
jev, ok := ev.(events.Message)
102102
if !ok {
103+
logrus.Warnf("unexpected event message: %q", ev)
103104
continue
104105
}
105106
if err := enc.Encode(jev); err != nil {

‎api/types/events/events.go‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package events
2+
3+
const (
4+
// ContainerEventType is the event type that containers generate
5+
ContainerEventType = "container"
6+
// ImageEventType is the event type that images generate
7+
ImageEventType = "image"
8+
// VolumeEventType is the event type that volumes generate
9+
VolumeEventType = "volume"
10+
// NetworkEventType is the event type that networks generate
11+
NetworkEventType = "network"
12+
)
13+
14+
// Actor describes something that generates events,
15+
// like a container, or a network, or a volume.
16+
// It has a defined name and a set or attributes.
17+
// The container attributes are its labels, other actors
18+
// can generate these attributes from other properties.
19+
type Actor struct {
20+
ID string
21+
Attributes map[string]string
22+
}
23+
24+
// Message represents the information an event contains
25+
type Message struct {
26+
// Deprecated information from JSONMessage.
27+
// With data only in container events.
28+
Status string `json:"status,omitempty"`
29+
ID string `json:"id,omitempty"`
30+
From string `json:"from,omitempty"`
31+
32+
Type string
33+
Action string
34+
Actor Actor
35+
36+
Time int64 `json:"time,omitempty"`
37+
TimeNano int64 `json:"timeNano,omitempty"`
38+
}

‎api/types/filters/parse.go‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,22 @@ func (filters Args) ExactMatch(field, source string) bool {
197197
return false
198198
}
199199

200+
// FuzzyMatch returns true if the source matches exactly one of the filters,
201+
// or the source has one of the filters as a prefix.
202+
func (filters Args) FuzzyMatch(field, source string) bool {
203+
if filters.ExactMatch(field, source) {
204+
return true
205+
}
206+
207+
fieldValues := filters.fields[field]
208+
for prefix := range fieldValues {
209+
if strings.HasPrefix(source, prefix) {
210+
return true
211+
}
212+
}
213+
return false
214+
}
215+
200216
// Include returns true if the name of the field to filter is in the filters.
201217
func (filters Args) Include(field string) bool {
202218
_, ok := filters.fields[field]

‎api/types/filters/parse_test.go‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,3 +349,21 @@ func TestWalkValues(t *testing.T) {
349349
t.Fatalf("Expected to not iterate when the field doesn't exist, got %v", err)
350350
}
351351
}
352+
353+
func TestFuzzyMatch(t *testing.T) {
354+
f := NewArgs()
355+
f.Add("container", "foo")
356+
357+
cases := map[string]bool{
358+
"foo": true,
359+
"foobar": true,
360+
"barfoo": false,
361+
"bar": false,
362+
}
363+
for source, match := range cases {
364+
got := f.FuzzyMatch("container", source)
365+
if got != match {
366+
t.Fatalf("Expected %v, got %v: %s", match, got, source)
367+
}
368+
}
369+
}

‎container/container_unix.go‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ func detachMounted(path string) error {
618618
}
619619

620620
// UnmountVolumes unmounts all volumes
621-
func (container *Container) UnmountVolumes(forceSyscall bool) error {
621+
func (container *Container) UnmountVolumes(forceSyscall bool, volumeEventLog func(name, action string, attributes map[string]string)) error {
622622
var (
623623
volumeMounts []volume.MountPoint
624624
err error
@@ -649,6 +649,12 @@ func (container *Container) UnmountVolumes(forceSyscall bool) error {
649649
if err := volumeMount.Volume.Unmount(); err != nil {
650650
return err
651651
}
652+
653+
attributes := map[string]string{
654+
"driver": volumeMount.Volume.DriverName(),
655+
"container": container.ID,
656+
}
657+
volumeEventLog(volumeMount.Volume.Name(), "unmount", attributes)
652658
}
653659
}
654660

0 commit comments

Comments
 (0)