af5298f4aa
Adds OpenTracing in the Pulumi engine and plugin + langhost subprocesses. We currently create a single root span for any `Enging.plan` operation - which is a single `preview`, `update`, `destroy`, etc. The only sub-spans we currently create are at gRPC boundaries, both on the client and server sides and on both the langhost and provider plugin interfaces. We could extend this to include spans for any other semantically meaningful sections of compute inside the engine, though initial examples show we get pretty good granularity of coverage by focusing on the gRPC boundaries. In the future, this should be easily extensible to HTTP boundaries and to track other bulky I/O like datastore read/writes once we hook up to the PPC and Pulumi Cloud. We expose a `--trace <endpoint>` option to enable tracing on the CLI, which we will aim to thread through to subprocesses. We currently support sending tracing data to a Zipkin-compatible endpoint. This has been validated with both Zipkin and Jaeger UIs. We do not yet have any tracing inside the TypeScript side of the JS langhost RPC interface. There is not yet automatic gRPC OpenTracing instrumentation (though it looks like it's in progress now) - so we would need to manually create meaningful spans on that side of the interface.
51 lines
1.5 KiB
Go
51 lines
1.5 KiB
Go
// Copyright 2017, Pulumi Corporation. All rights reserved.
|
|
|
|
package engine
|
|
|
|
import (
|
|
opentracing "github.com/opentracing/opentracing-go"
|
|
"github.com/pkg/errors"
|
|
"github.com/pulumi/pulumi/pkg/resource/deploy"
|
|
"github.com/pulumi/pulumi/pkg/tokens"
|
|
"github.com/pulumi/pulumi/pkg/util/contract"
|
|
)
|
|
|
|
// Callers must call Close on the resulting planContext once they have completed the associated planning operation
|
|
func (eng *Engine) planContextFromStack(name tokens.QName, pkgarg string) (*planContext, error) {
|
|
contract.Require(name != tokens.QName(""), "name")
|
|
|
|
// Read in the deployment information, bailing if an IO error occurs.
|
|
target, err := eng.Targets.GetTarget(name)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not read target information")
|
|
}
|
|
|
|
snapshot, err := eng.Snapshots.GetSnapshot(name)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not read snapshot information")
|
|
}
|
|
|
|
contract.Assert(target != nil)
|
|
|
|
// Create a root span for the operation
|
|
tracingSpan := opentracing.StartSpan("pulumi-plan")
|
|
|
|
return &planContext{
|
|
Target: target,
|
|
Snapshot: snapshot,
|
|
PackageArg: pkgarg,
|
|
TracingSpan: tracingSpan,
|
|
}, nil
|
|
}
|
|
|
|
type planContext struct {
|
|
Target *deploy.Target // the target stack.
|
|
Snapshot *deploy.Snapshot // the stack's latest deployment snapshot
|
|
PackageArg string // an optional path to a package to pass to the compiler
|
|
TracingSpan opentracing.Span // An OpenTracing span to parent plan operations within.
|
|
}
|
|
|
|
func (ctx *planContext) Close() {
|
|
ctx.TracingSpan.Finish()
|
|
}
|