OpenTracing support added to start, stop, run, create, pull, and ps

Drop context.Context field from cli.Context

Signed-off-by: Sebastian Jug <sejug@redhat.com>

7 files changed, 80 insertions, 0 deletions

diff --git a/libpod/container_api.go b/libpod/container_api.go
index abe0df610..09d7f220d 100644
--- a/libpod/container_api.go
+++ b/libpod/container_api.go
@@ -14,6 +14,7 @@ import (
 	"github.com/containers/libpod/pkg/lookup"
 	"github.com/containers/storage/pkg/stringid"
 	"github.com/docker/docker/daemon/caps"
+	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"k8s.io/apimachinery/pkg/util/wait"
@@ -22,6 +23,10 @@ import (
 
 // Init creates a container in the OCI runtime
 func (c *Container) Init(ctx context.Context) (err error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "containerInit")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	if !c.batched {
 		c.lock.Lock()
 		defer c.lock.Unlock()
@@ -66,6 +71,10 @@ func (c *Container) Init(ctx context.Context) (err error) {
 // Init().
 // If recursive is set, Start will also start all containers this container depends on.
 func (c *Container) Start(ctx context.Context, recursive bool) (err error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "containerStart")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	if !c.batched {
 		c.lock.Lock()
 		defer c.lock.Unlock()
diff --git a/libpod/container_internal.go b/libpod/container_internal.go
index a54613443..b5f93c8a0 100644
--- a/libpod/container_internal.go
+++ b/libpod/container_internal.go
@@ -21,6 +21,7 @@ import (
 	"github.com/containers/storage/pkg/mount"
 	spec "github.com/opencontainers/runtime-spec/specs-go"
 	"github.com/opencontainers/selinux/go-selinux/label"
+	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/text/language"
@@ -247,6 +248,10 @@ func (c *Container) syncContainer() error {
 
 // Create container root filesystem for use
 func (c *Container) setupStorage(ctx context.Context) error {
+	span, _ := opentracing.StartSpanFromContext(ctx, "setupStorage")
+	span.SetTag("type", "container")
+	defer span.Finish()
+
 	if !c.valid {
 		return errors.Wrapf(ErrCtrRemoved, "container %s is not valid", c.ID())
 	}
@@ -779,6 +784,10 @@ func (c *Container) completeNetworkSetup() error {
 
 // Initialize a container, creating it in the runtime
 func (c *Container) init(ctx context.Context) error {
+	span, _ := opentracing.StartSpanFromContext(ctx, "init")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	// Generate the OCI spec
 	spec, err := c.generateSpec(ctx)
 	if err != nil {
@@ -812,6 +821,10 @@ func (c *Container) init(ctx context.Context) error {
 // Deletes the container in the runtime, and resets its state to Exited.
 // The container can be restarted cleanly after this.
 func (c *Container) cleanupRuntime(ctx context.Context) error {
+	span, _ := opentracing.StartSpanFromContext(ctx, "cleanupRuntime")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	// If the container is not ContainerStateStopped, do nothing
 	if c.state.State != ContainerStateStopped {
 		return nil
@@ -847,6 +860,10 @@ func (c *Container) cleanupRuntime(ctx context.Context) error {
 // Not necessary for ContainerStateExited - the container has already been
 // removed from the runtime, so init() can proceed freely.
 func (c *Container) reinit(ctx context.Context) error {
+	span, _ := opentracing.StartSpanFromContext(ctx, "reinit")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	logrus.Debugf("Recreating container %s in OCI runtime", c.ID())
 
 	if err := c.cleanupRuntime(ctx); err != nil {
@@ -1079,6 +1096,10 @@ func (c *Container) cleanupStorage() error {
 func (c *Container) cleanup(ctx context.Context) error {
 	var lastError error
 
+	span, _ := opentracing.StartSpanFromContext(ctx, "cleanup")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	logrus.Debugf("Cleaning up container %s", c.ID())
 
 	// Clean up network namespace, if present
@@ -1110,6 +1131,10 @@ func (c *Container) cleanup(ctx context.Context) error {
 // delete deletes the container and runs any configured poststop
 // hooks.
 func (c *Container) delete(ctx context.Context) (err error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "delete")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	if err := c.runtime.ociRuntime.deleteContainer(c); err != nil {
 		return errors.Wrapf(err, "error removing container %s from runtime", c.ID())
 	}
@@ -1125,6 +1150,10 @@ func (c *Container) delete(ctx context.Context) (err error) {
 // the OCI Runtime Specification (which requires them to run
 // post-delete, despite the stage name).
 func (c *Container) postDeleteHooks(ctx context.Context) (err error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "postDeleteHooks")
+	span.SetTag("struct", "container")
+	defer span.Finish()
+
 	if c.state.ExtensionStageHooks != nil {
 		extensionHooks, ok := c.state.ExtensionStageHooks["poststop"]
 		if ok {
diff --git a/libpod/container_internal_linux.go b/libpod/container_internal_linux.go
index 65cb47c8c..86f94477e 100644
--- a/libpod/container_internal_linux.go
+++ b/libpod/container_internal_linux.go
@@ -31,6 +31,7 @@ import (
 	spec "github.com/opencontainers/runtime-spec/specs-go"
 	"github.com/opencontainers/runtime-tools/generate"
 	"github.com/opencontainers/selinux/go-selinux/label"
+	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/sys/unix"
@@ -170,10 +171,15 @@ func (c *Container) cleanupNetwork() error {
 // Generate spec for a container
 // Accepts a map of the container's dependencies
 func (c *Container) generateSpec(ctx context.Context) (*spec.Spec, error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "generateSpec")
+	span.SetTag("type", "container")
+	defer span.Finish()
+
 	execUser, err := lookup.GetUserGroupInfo(c.state.Mountpoint, c.config.User, nil)
 	if err != nil {
 		return nil, err
 	}
+
 	g := generate.NewFromSpec(c.config.Spec)
 
 	// If network namespace was requested, add it now
diff --git a/libpod/image/image.go b/libpod/image/image.go
index 739372e77..028a795ea 100644
--- a/libpod/image/image.go
+++ b/libpod/image/image.go
@@ -27,6 +27,7 @@ import (
 	"github.com/containers/storage/pkg/reexec"
 	digest "github.com/opencontainers/go-digest"
 	ociv1 "github.com/opencontainers/image-spec/specs-go/v1"
+	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
@@ -126,6 +127,10 @@ func (ir *Runtime) NewFromLocal(name string) (*Image, error) {
 // New creates a new image object where the image could be local
 // or remote
 func (ir *Runtime) New(ctx context.Context, name, signaturePolicyPath, authfile string, writer io.Writer, dockeroptions *DockerRegistryOptions, signingoptions SigningOptions, forcePull bool, label *string) (*Image, error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "newImage")
+	span.SetTag("type", "runtime")
+	defer span.Finish()
+
 	// We don't know if the image is local or not ... check local first
 	newImage := Image{
 		InputName:    name,
@@ -805,6 +810,10 @@ func (i *Image) imageInspectInfo(ctx context.Context) (*types.ImageInspectInfo,
 
 // Inspect returns an image's inspect data
 func (i *Image) Inspect(ctx context.Context) (*inspect.ImageData, error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "imageInspect")
+	span.SetTag("type", "image")
+	defer span.Finish()
+
 	ociv1Img, err := i.ociv1Image(ctx)
 	if err != nil {
 		return nil, err
diff --git a/libpod/image/pull.go b/libpod/image/pull.go
index 6fef96e37..6b9f7fc67 100644
--- a/libpod/image/pull.go
+++ b/libpod/image/pull.go
@@ -19,6 +19,7 @@ import (
 	"github.com/containers/image/types"
 	"github.com/containers/libpod/pkg/registries"
 	multierror "github.com/hashicorp/go-multierror"
+	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
@@ -109,6 +110,9 @@ func (ir *Runtime) getSinglePullRefPairGoal(srcRef types.ImageReference, destNam
 
 // pullGoalFromImageReference returns a pull goal for a single ImageReference, depending on the used transport.
 func (ir *Runtime) pullGoalFromImageReference(ctx context.Context, srcRef types.ImageReference, imgName string, sc *types.SystemContext) (*pullGoal, error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "pullGoalFromImageReference")
+	defer span.Finish()
+
 	// supports pulling from docker-archive, oci, and registries
 	switch srcRef.Transport().Name() {
 	case DockerArchive:
@@ -194,6 +198,9 @@ func (ir *Runtime) pullGoalFromImageReference(ctx context.Context, srcRef types.
 // pullImageFromHeuristicSource pulls an image based on inputName, which is heuristically parsed and may involve configured registries.
 // Use pullImageFromReference if the source is known precisely.
 func (ir *Runtime) pullImageFromHeuristicSource(ctx context.Context, inputName string, writer io.Writer, authfile, signaturePolicyPath string, signingOptions SigningOptions, dockerOptions *DockerRegistryOptions, label *string) ([]string, error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "pullImageFromHeuristicSource")
+	defer span.Finish()
+
 	var goal *pullGoal
 	sc := GetSystemContext(signaturePolicyPath, authfile, false)
 	srcRef, err := alltransports.ParseImageName(inputName)
@@ -214,6 +221,9 @@ func (ir *Runtime) pullImageFromHeuristicSource(ctx context.Context, inputName s
 
 // pullImageFromReference pulls an image from a types.imageReference.
 func (ir *Runtime) pullImageFromReference(ctx context.Context, srcRef types.ImageReference, writer io.Writer, authfile, signaturePolicyPath string, signingOptions SigningOptions, dockerOptions *DockerRegistryOptions) ([]string, error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "pullImageFromReference")
+	defer span.Finish()
+
 	sc := GetSystemContext(signaturePolicyPath, authfile, false)
 	goal, err := ir.pullGoalFromImageReference(ctx, srcRef, transports.ImageName(srcRef), sc)
 	if err != nil {
@@ -224,6 +234,9 @@ func (ir *Runtime) pullImageFromReference(ctx context.Context, srcRef types.Imag
 
 // doPullImage is an internal helper interpreting pullGoal. Almost everyone should call one of the callers of doPullImage instead.
 func (ir *Runtime) doPullImage(ctx context.Context, sc *types.SystemContext, goal pullGoal, writer io.Writer, signingOptions SigningOptions, dockerOptions *DockerRegistryOptions, label *string) ([]string, error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "doPullImage")
+	defer span.Finish()
+
 	policyContext, err := getPolicyContext(sc)
 	if err != nil {
 		return nil, err
diff --git a/libpod/runtime_ctr.go b/libpod/runtime_ctr.go
index 185090cf7..1055da75b 100644
--- a/libpod/runtime_ctr.go
+++ b/libpod/runtime_ctr.go
@@ -15,6 +15,7 @@ import (
 	"github.com/containers/storage"
 	"github.com/containers/storage/pkg/stringid"
 	spec "github.com/opencontainers/runtime-spec/specs-go"
+	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"github.com/ulule/deepcopier"
@@ -46,6 +47,10 @@ func (r *Runtime) NewContainer(ctx context.Context, rSpec *spec.Spec, options ..
 }
 
 func (r *Runtime) newContainer(ctx context.Context, rSpec *spec.Spec, options ...CtrCreateOption) (c *Container, err error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "newContainer")
+	span.SetTag("type", "runtime")
+	defer span.Finish()
+
 	if rSpec == nil {
 		return nil, errors.Wrapf(ErrInvalidArg, "must provide a valid runtime spec to create container")
 	}
@@ -241,6 +246,10 @@ func (r *Runtime) RemoveContainer(ctx context.Context, c *Container, force bool,
 // Internal function to remove a container
 // Locks the container, but does not lock the runtime
 func (r *Runtime) removeContainer(ctx context.Context, c *Container, force bool, removeVolume bool) error {
+	span, _ := opentracing.StartSpanFromContext(ctx, "removeContainer")
+	span.SetTag("type", "runtime")
+	defer span.Finish()
+
 	if !c.valid {
 		if ok, _ := r.state.HasContainer(c.ID()); !ok {
 			// Container probably already removed
diff --git a/libpod/storage.go b/libpod/storage.go
index 17d231171..1a7b13da6 100644
--- a/libpod/storage.go
+++ b/libpod/storage.go
@@ -8,6 +8,7 @@ import (
 	"github.com/containers/image/types"
 	"github.com/containers/storage"
 	"github.com/opencontainers/image-spec/specs-go/v1"
+	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
@@ -62,6 +63,10 @@ func (metadata *RuntimeContainerMetadata) SetMountLabel(mountLabel string) {
 // CreateContainerStorage creates the storage end of things.  We already have the container spec created
 // TO-DO We should be passing in an Image object in the future.
 func (r *storageService) CreateContainerStorage(ctx context.Context, systemContext *types.SystemContext, imageName, imageID, containerName, containerID string, options storage.ContainerOptions) (cinfo ContainerInfo, err error) {
+	span, _ := opentracing.StartSpanFromContext(ctx, "createContainerStorage")
+	span.SetTag("type", "storageService")
+	defer span.Finish()
+
 	var imageConfig *v1.Image
 	if imageName != "" {
 		var ref types.ImageReference