pulumi/cmd/view-trace.go
Pat Gavlin 82204230e1
Improve tracing support. (#3238)
* Fix some tracing issues.

- Add endpoints for `startUpdate` and `postEngineEventsBatch` so that
  spans for these invocations have proper names
- Inject a tracing span when walking a plan so that resource operations
  are properly parented
- When handling gRPC calls, inject a tracing span into the call's
  metadata if no span is already present so that resource monitor and
  engine spans are properly parented
- Do not trace client gRPC invocations of the empty method so that these
  calls (which are used to determine server availability) do not muddy
  the trace. Note that I tried parenting these spans appropriately, but
  doing so broke the trace entirely.

With these changes, the only unparented span in a typical Pulumi
invocation is a single call to `getUser`. This span is unparented
because that call does not have a context available. Plumbing a context
into that particular call is surprisingly tricky, as it is often called
by other context-less functions.

* Make tracing support more flexible.

- Add support for writing trace data to a local file using Appdash
- Add support for viewing Appdash traces via the CLI
2019-09-16 14:16:43 -07:00

83 lines
2.3 KiB
Go

// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"fmt"
"io"
"net/http"
"net/url"
"os"
"github.com/spf13/cobra"
"sourcegraph.com/sourcegraph/appdash"
"sourcegraph.com/sourcegraph/appdash/traceapp"
"github.com/pulumi/pulumi/pkg/util/cmdutil"
"github.com/pulumi/pulumi/pkg/util/contract"
)
func readTrace(path string, store io.ReaderFrom) error {
f, err := os.Open(path)
if err != nil {
return err
}
defer contract.IgnoreClose(f)
_, err = store.ReadFrom(f)
return err
}
func newViewTraceCmd() *cobra.Command {
var port int
var cmd = &cobra.Command{
Use: "view-trace [trace-file]",
Short: "Display a trace from the Pulumi CLI",
Long: "Display a trace from the Pulumi CLI.\n" +
"\n" +
"This command is used to display execution traces collected by a prior\n" +
"invocation of the Pulumi CLI.\n" +
"\n" +
"This command loads trace data from the indicated file and starts a\n" +
"webserver to display the trace. By default, this server will listen\n" +
"port 8008; the --port flag can be used to change this if necessary.",
Args: cmdutil.ExactArgs(1),
Run: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
url, err := url.Parse(fmt.Sprintf("http://localhost:%d", port))
if err != nil {
return err
}
store := appdash.NewMemoryStore()
if err := readTrace(args[0], store); err != nil {
return err
}
app, err := traceapp.New(nil, url)
if err != nil {
return err
}
app.Store, app.Queryer = store, store
fmt.Printf("Displaying trace at %v\n", url)
return http.ListenAndServe(fmt.Sprintf(":%d", port), app)
}),
}
cmd.PersistentFlags().IntVar(&port, "port", 8008,
"the port the trace viewer will listen on")
return cmd
}