From 261c8d2eb590354fd0727a79467dd5d25d6b73cb Mon Sep 17 00:00:00 2001 From: Maxime Heckel Date: Tue, 15 Nov 2016 13:22:58 -0800 Subject: [PATCH] update dockercloud events api doc with filters --- .../source/includes/dockercloud-events.md | 28 +++++++++---- .../includes/dockercloud-events.html | 42 +++++++++++++++---- apidocs/docker-cloud/index.html | 42 +++++++++++++++---- apidocs/layouts/single.html | 42 +++++++++++++++---- 4 files changed, 126 insertions(+), 28 deletions(-) diff --git a/apidocs/cloud-api-source/source/includes/dockercloud-events.md b/apidocs/cloud-api-source/source/includes/dockercloud-events.md index 28f5132500..c636dd25f3 100644 --- a/apidocs/cloud-api-source/source/includes/dockercloud-events.md +++ b/apidocs/cloud-api-source/source/includes/dockercloud-events.md @@ -83,17 +83,23 @@ events.run_forever() ```go import "github.com/docker/go-dockercloud/dockercloud" -c := make(chan dockercloud.Event) -e := make(chan error) +// Listens for container events only +myFilter := dockercloud.NewStreamFilter(&dockercloud.EventFilter{Type: "container"}) -go dockercloud.Events(c, e) +stream := dockercloud.NewStream(myFilter) + +if err := stream.Connect(); err == nil { + go stream.RunForever() +} else { + log.Print("Connect err: " + err.Error()) +} for { select { - case event := <-c: - log.Println(event) - case err := <-e: - log.Println(err) + case event := <-stream.MessageChan: + log.Println(event) + case err := <-stream.ErrorChan: + log.Println(err) } } ``` @@ -119,3 +125,11 @@ Available in Docker Cloud's **STREAM API** ### HTTP Request `GET /api/audit/v1/[optional_namespace/]events/` + +### Query Parameters + +Parameter | Description +--------- | ----------- +type | Filter by type +object | Filter by object resource URI +parent | Filter by object parents diff --git a/apidocs/docker-cloud/includes/dockercloud-events.html b/apidocs/docker-cloud/includes/dockercloud-events.html index 352f969571..8d01a27208 100644 --- a/apidocs/docker-cloud/includes/dockercloud-events.html +++ b/apidocs/docker-cloud/includes/dockercloud-events.html @@ -183,17 +183,23 @@ 
import "github.com/docker/go-dockercloud/dockercloud"
 
-c := make(chan dockercloud.Event)
-e := make(chan error)
+// Listens for container events only
+myFilter := dockercloud.NewStreamFilter(&dockercloud.EventFilter{Type: "container"})
 
-go dockercloud.Events(c, e)
+stream := dockercloud.NewStream(myFilter)
+
+if err := stream.Connect(); err == nil {
+    go stream.RunForever()
+} else {
+    log.Print("Connect err: " + err.Error())
+}
 
 for {
     select {
-        case event := <-c:
-            log.Println(event)
-        case err := <-e:
-            log.Println(err)
+    case event := <-stream.MessageChan:
+        log.Println(event)
+    case err := <-stream.ErrorChan:
+        log.Println(err)
     }
 }
@@ -216,6 +222,28 @@

GET /api/audit/v1/[optional_namespace/]events/

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + +
ParameterDescription
typeFilter by type
objectFilter by object resource URI
parentFilter by object parents
+
diff --git a/apidocs/docker-cloud/index.html b/apidocs/docker-cloud/index.html index 8e6414035e..907e0a8ebe 100644 --- a/apidocs/docker-cloud/index.html +++ b/apidocs/docker-cloud/index.html @@ -6465,17 +6465,23 @@ container.execute("ls", handler=msg_handler) 
import "github.com/docker/go-dockercloud/dockercloud"
 
-c := make(chan dockercloud.Event)
-e := make(chan error)
+// Listens for container events only
+myFilter := dockercloud.NewStreamFilter(&dockercloud.EventFilter{Type: "container"})
 
-go dockercloud.Events(c, e)
+stream := dockercloud.NewStream(myFilter)
+
+if err := stream.Connect(); err == nil {
+    go stream.RunForever()
+} else {
+    log.Print("Connect err: " + err.Error())
+}
 
 for {
     select {
-        case event := <-c:
-            log.Println(event)
-        case err := <-e:
-            log.Println(err)
+    case event := <-stream.MessageChan:
+        log.Println(event)
+    case err := <-stream.ErrorChan:
+        log.Println(err)
     }
 }
@@ -6498,6 +6504,28 @@ container.execute("ls", handler=msg_handler)

GET /api/audit/v1/[optional_namespace/]events/

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + +
ParameterDescription
typeFilter by type
objectFilter by object resource URI
parentFilter by object parents
+

Errors

diff --git a/apidocs/layouts/single.html b/apidocs/layouts/single.html index 8e6414035e..907e0a8ebe 100644 --- a/apidocs/layouts/single.html +++ b/apidocs/layouts/single.html @@ -6465,17 +6465,23 @@ container.execute("ls", handler=msg_handler) 
import "github.com/docker/go-dockercloud/dockercloud"
 
-c := make(chan dockercloud.Event)
-e := make(chan error)
+// Listens for container events only
+myFilter := dockercloud.NewStreamFilter(&dockercloud.EventFilter{Type: "container"})
 
-go dockercloud.Events(c, e)
+stream := dockercloud.NewStream(myFilter)
+
+if err := stream.Connect(); err == nil {
+    go stream.RunForever()
+} else {
+    log.Print("Connect err: " + err.Error())
+}
 
 for {
     select {
-        case event := <-c:
-            log.Println(event)
-        case err := <-e:
-            log.Println(err)
+    case event := <-stream.MessageChan:
+        log.Println(event)
+    case err := <-stream.ErrorChan:
+        log.Println(err)
     }
 }
@@ -6498,6 +6504,28 @@ container.execute("ls", handler=msg_handler)

GET /api/audit/v1/[optional_namespace/]events/

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + +
ParameterDescription
typeFilter by type
objectFilter by object resource URI
parentFilter by object parents
+

Errors