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.
57 lines
1.6 KiB
Go
57 lines
1.6 KiB
Go
// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/opentracing/opentracing-go"
|
|
|
|
"github.com/pulumi/pulumi/pkg/diag"
|
|
"github.com/pulumi/pulumi/pkg/util/rpcutil"
|
|
)
|
|
|
|
// Context is used to group related operations together so that associated OS resources can be cached, shared, and
|
|
// reclaimed as appropriate.
|
|
type Context struct {
|
|
Diag diag.Sink // the diagnostics sink to use for messages.
|
|
Host Host // the host that can be used to fetch providers.
|
|
|
|
tracingSpan opentracing.Span // the OpenTracing span to parent requests within.
|
|
}
|
|
|
|
// NewContext allocates a new context with a given sink and host. Note that the host is "owned" by this context from
|
|
// here forwards, such that when the context's resources are reclaimed, so too are the host's.
|
|
func NewContext(d diag.Sink, host Host, parentSpan opentracing.Span) (*Context, error) {
|
|
ctx := &Context{
|
|
Diag: d,
|
|
Host: host,
|
|
tracingSpan: parentSpan,
|
|
}
|
|
if host == nil {
|
|
h, err := NewDefaultHost(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
ctx.Host = h
|
|
}
|
|
return ctx, nil
|
|
}
|
|
|
|
// Request allocates a request sub-context.
|
|
func (ctx *Context) Request() context.Context {
|
|
// TODO[pulumi/pulumi#143]: support cancellation.
|
|
return opentracing.ContextWithSpan(context.Background(), ctx.tracingSpan)
|
|
}
|
|
|
|
// Close reclaims all resources associated with this context.
|
|
func (ctx *Context) Close() error {
|
|
if ctx.tracingSpan != nil {
|
|
ctx.tracingSpan.Finish()
|
|
}
|
|
err := ctx.Host.Close()
|
|
if err != nil && !rpcutil.IsBenignCloseErr(err) {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|