Report build status to telemetry and segment (#3279)

api/server/handlers/porter_app/analytics.go

@@ -93,18 +93,47 @@ func (v *PorterAppAnalyticsHandler) ServeHTTP(w http.ResponseWriter, r *http.Req
 	v.WriteResult(w, r, user.ToUserType())
 }
 
-func TrackStackBuildFailure(
+func TrackStackBuildStatus(
 	config *config.Config,
 	user *models.User,
 	project *models.Project,
 	stackName string,
+	errorMessage string,
+	status string,
 ) error {
-	return config.AnalyticsClient.Track(analytics.StackBuildFailureTrack(&analytics.StackBuildFailureOpts{
-		ProjectScopedTrackOpts: analytics.GetProjectScopedTrackOpts(user.ID, project.ID),
-		StackName:              stackName,
-		Email:                  user.Email,
-		FirstName:              user.FirstName,
-		LastName:               user.LastName,
-		CompanyName:            user.CompanyName,
-	}))
+	if status == "PROGRESSING" {
+		return config.AnalyticsClient.Track(analytics.StackBuildProgressingTrack(&analytics.StackBuildOpts{
+			ProjectScopedTrackOpts: analytics.GetProjectScopedTrackOpts(user.ID, project.ID),
+			StackName:              stackName,
+			Email:                  user.Email,
+			FirstName:              user.FirstName,
+			LastName:               user.LastName,
+			CompanyName:            user.CompanyName,
+		}))
+	}
+
+	if status == "SUCCESS" {
+		return config.AnalyticsClient.Track(analytics.StackBuildSuccessTrack(&analytics.StackBuildOpts{
+			ProjectScopedTrackOpts: analytics.GetProjectScopedTrackOpts(user.ID, project.ID),
+			StackName:              stackName,
+			Email:                  user.Email,
+			FirstName:              user.FirstName,
+			LastName:               user.LastName,
+			CompanyName:            user.CompanyName,
+		}))
+	}
+
+	if status == "FAILED" {
+		return config.AnalyticsClient.Track(analytics.StackBuildFailureTrack(&analytics.StackBuildOpts{
+			ProjectScopedTrackOpts: analytics.GetProjectScopedTrackOpts(user.ID, project.ID),
+			StackName:              stackName,
+			ErrorMessage:           errorMessage,
+			Email:                  user.Email,
+			FirstName:              user.FirstName,
+			LastName:               user.LastName,
+			CompanyName:            user.CompanyName,
+		}))
+	}
+
+	return nil
 }

api/server/handlers/porter_app/create_and_update_events.go

@@ -2,7 +2,9 @@ package porter_app
 
 import (
 	"context"
+	"fmt"
 	"net/http"
+	"strings"
 
 	"github.com/google/uuid"
 	"github.com/porter-dev/porter/api/server/authz"
@@ -36,10 +38,8 @@ func (p *CreateUpdatePorterAppEventHandler) ServeHTTP(w http.ResponseWriter, r *
 	defer span.End()
 
 	cluster, _ := ctx.Value(types.ClusterScope).(*models.Cluster)
-	telemetry.WithAttributes(span,
-		telemetry.AttributeKV{Key: "cluster-id", Value: int(cluster.ID)},
-		telemetry.AttributeKV{Key: "project-id", Value: int(cluster.ProjectID)},
-	)
+	user, _ := ctx.Value(types.UserScope).(*models.User)
+	project, _ := ctx.Value(types.ProjectScope).(*models.Project)
 
 	request := &types.CreateOrUpdatePorterAppEventRequest{}
 	if ok := p.DecodeAndValidate(w, r, request); !ok {
@@ -56,12 +56,16 @@ func (p *CreateUpdatePorterAppEventHandler) ServeHTTP(w http.ResponseWriter, r *
 	}
 	telemetry.WithAttributes(span,
 		telemetry.AttributeKV{Key: "porter-app-name", Value: stackName},
-		telemetry.AttributeKV{Key: "porter-app-event-type-id", Value: request.Type},
+		telemetry.AttributeKV{Key: "porter-app-event-type", Value: string(request.Type)},
 		telemetry.AttributeKV{Key: "porter-app-event-status", Value: request.Status},
 		telemetry.AttributeKV{Key: "porter-app-event-external-source", Value: request.TypeExternalSource},
 		telemetry.AttributeKV{Key: "porter-app-event-id", Value: request.ID},
 	)
 
+	if request.Type == types.PorterAppEventType_Build {
+		reportBuildStatus(ctx, request, p.Config(), user, project, stackName)
+	}
+
 	if request.ID == "" {
 		event, err := p.createNewAppEvent(ctx, *cluster, stackName, request.Status, string(request.Type), request.TypeExternalSource, request.Metadata)
 		if err != nil {
@@ -82,6 +86,34 @@ func (p *CreateUpdatePorterAppEventHandler) ServeHTTP(w http.ResponseWriter, r *
 	p.WriteResult(w, r, event)
 }
 
+func reportBuildStatus(ctx context.Context, request *types.CreateOrUpdatePorterAppEventRequest, config *config.Config, user *models.User, project *models.Project, stackName string) {
+	ctx, span := telemetry.NewSpan(ctx, "report-build-status")
+	defer span.End()
+
+	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "porter-app-build-status", Value: request.Status})
+
+	var errStr string
+	if errors, ok := request.Metadata["errors"]; ok {
+		if errs, ok := errors.(map[string]interface{}); ok {
+			errStringMap := make(map[string]string)
+			for k, v := range errs {
+				if valueStr, ok := v.(string); ok {
+					errStringMap[k] = valueStr
+				}
+			}
+
+			for k, v := range errStringMap {
+				telemetry.WithAttributes(span, telemetry.AttributeKV{Key: telemetry.AttributeKey(fmt.Sprintf("resource-%s", k)), Value: v})
+				errStr += k + ": " + v + ", "
+			}
+			errStr = strings.TrimSuffix(errStr, ", ")
+			_ = telemetry.Error(ctx, span, nil, errStr)
+		}
+	}
+
+	_ = TrackStackBuildStatus(config, user, project, stackName, errStr, request.Status)
+}
+
 // createNewAppEvent will create a new app event for the given porter app name. If the app event is an agent event, then it will be created only if there is no existing event which has the agent ID. In the case that an existing event is found, that will be returned instead
 func (p *CreateUpdatePorterAppEventHandler) createNewAppEvent(ctx context.Context, cluster models.Cluster, porterAppName string, status string, eventType string, externalSource string, requestMetadata map[string]any) (types.PorterAppEvent, error) {
 	ctx, span := telemetry.NewSpan(ctx, "create-porter-app-event")

api/server/handlers/porter_app/list_events.go

@@ -3,13 +3,8 @@ package porter_app
 import (
 	"context"
 	"errors"
-	"fmt"
 	"net/http"
-	"reflect"
-	"strconv"
 
-	"github.com/bradleyfalzon/ghinstallation/v2"
-	"github.com/google/go-github/v41/github"
 	"github.com/google/uuid"
 	"github.com/gorilla/schema"
 	"github.com/porter-dev/porter/api/server/handlers"
@@ -134,13 +129,6 @@ func (p *PorterAppEventListHandler) updateExistingAppEvent(
 		telemetry.AttributeKV{Key: "project-id", Value: int(cluster.ProjectID)},
 	)
 
-	if appEvent.Type == string(types.PorterAppEventType_Build) && appEvent.TypeExternalSource == "GITHUB" {
-		err = p.updateBuildEvent_Github(ctx, &event, user, project, stackName)
-		if err != nil {
-			return models.PorterAppEvent{}, telemetry.Error(ctx, span, err, "error updating porter app event for github build")
-		}
-	}
-
 	telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "porter-app-event-updated-status", Value: event.Status})
 
 	err = p.Repo().PorterAppEvent().UpdateEvent(ctx, &event)
@@ -154,102 +142,3 @@ func (p *PorterAppEventListHandler) updateExistingAppEvent(
 
 	return event, nil
 }
-
-func (p *PorterAppEventListHandler) updateBuildEvent_Github(
-	ctx context.Context,
-	event *models.PorterAppEvent,
-	user *models.User,
-	project *models.Project,
-	stackName string,
-) error {
-	ctx, span := telemetry.NewSpan(ctx, "update-porter-app-build-event")
-	defer span.End()
-
-	repoOrg, ok := event.Metadata["org"].(string)
-	if !ok {
-		return telemetry.Error(ctx, span, nil, "error retrieving repo org from metadata")
-	}
-
-	repoName, ok := event.Metadata["repo"].(string)
-	if !ok {
-		return telemetry.Error(ctx, span, nil, "error retrieving repo name from metadata")
-	}
-
-	actionRunIDIface, ok := event.Metadata["action_run_id"]
-	if !ok {
-		return telemetry.Error(ctx, span, nil, "error retrieving action run id from metadata")
-	}
-	actionRunID, ok := actionRunIDIface.(float64)
-	if !ok {
-		telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "action-run-id-type", Value: reflect.TypeOf(actionRunIDIface).String()})
-		return telemetry.Error(ctx, span, nil, "error converting action run id to int")
-	}
-
-	accountIDIface, ok := event.Metadata["github_account_id"]
-	if !ok {
-		return telemetry.Error(ctx, span, nil, "error retrieving github account id from metadata")
-	}
-	githubAccountID, ok := accountIDIface.(float64)
-	if !ok {
-		telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "github-account-id-type", Value: reflect.TypeOf(accountIDIface).String()})
-		return telemetry.Error(ctx, span, nil, "error converting github account id to int")
-	}
-
-	// read the environment to get the environment id
-	env, err := p.Repo().GithubAppInstallation().ReadGithubAppInstallationByAccountID(int64(githubAccountID))
-	if err != nil {
-		return telemetry.Error(ctx, span, err, "error reading github environment by owner repo name")
-	}
-	if env == nil {
-		return telemetry.Error(ctx, span, nil, "github environment is nil")
-	}
-
-	ghClient, err := getGithubClientFromEnvironment(p.Config(), env.InstallationID)
-	if err != nil {
-		return telemetry.Error(ctx, span, err, "error getting github client using porter application")
-	}
-	if ghClient == nil {
-		return telemetry.Error(ctx, span, nil, "github client is nil")
-	}
-
-	actionRun, _, err := ghClient.Actions.GetWorkflowRunByID(ctx, repoOrg, repoName, int64(actionRunID))
-	if err != nil {
-		return telemetry.Error(ctx, span, err, "error getting github action run by id")
-	}
-	if actionRun == nil {
-		return telemetry.Error(ctx, span, nil, "github action run is nil")
-	}
-
-	if *actionRun.Status == "completed" {
-		if *actionRun.Conclusion == "success" {
-			event.Status = "SUCCESS"
-		} else {
-			event.Status = "FAILED"
-			_ = TrackStackBuildFailure(p.Config(), user, project, stackName)
-		}
-		event.Metadata["end_time"] = actionRun.GetUpdatedAt().Time
-	}
-
-	return nil
-}
-
-func getGithubClientFromEnvironment(config *config.Config, installationID int64) (*github.Client, error) {
-	// get the github app client
-	ghAppId, err := strconv.Atoi(config.ServerConf.GithubAppID)
-	if err != nil {
-		return nil, fmt.Errorf("malformed GITHUB_APP_ID in server configuration: %w", err)
-	}
-
-	// authenticate as github app installation
-	itr, err := ghinstallation.New(
-		http.DefaultTransport,
-		int64(ghAppId),
-		installationID,
-		config.ServerConf.GithubAppSecret,
-	)
-	if err != nil {
-		return nil, fmt.Errorf("error in creating github client from preview environment: %w", err)
-	}
-
-	return github.NewClient(&http.Client{Transport: itr}), nil
-}

cli/cmd/stack/apply.go

@@ -36,7 +36,7 @@ func CreateApplicationDeploy(client *api.Client, worker *switchboardWorker.Worke
 		return nil, fmt.Errorf("malformed application definition: %w", err)
 	}
 
-	deployStackHook := &DeployAppHook{
+	deployAppHook := &DeployAppHook{
 		Client:               client,
 		ApplicationName:      applicationName,
 		ProjectID:            cliConf.Project,
@@ -46,19 +46,12 @@ func CreateApplicationDeploy(client *api.Client, worker *switchboardWorker.Worke
 		Builder:              builder,
 	}
 
-	worker.RegisterHook("deploy-stack", deployStackHook)
-	if os.Getenv("GITHUB_RUN_ID") != "" {
-		err := createAppEvent(client, applicationName, cliConf)
-		if err != nil {
-			return nil, err
-		}
-	}
-
+	worker.RegisterHook("deploy-app", deployAppHook)
 	return resources, nil
 }
 
 // Create app event to signfy start of build
-func createAppEvent(client *api.Client, applicationName string, cliConf *config.CLIConfig) error {
+func createAppEvent(client *api.Client, applicationName string, projectId, clusterId uint) (string, error) {
 	req := &types.CreateOrUpdatePorterAppEventRequest{
 		Status:             "PROGRESSING",
 		Type:               types.PorterAppEventType_Build,
@@ -71,7 +64,7 @@ func createAppEvent(client *api.Client, applicationName string, cliConf *config.
 
 	repoNameSplit := strings.Split(os.Getenv("GITHUB_REPOSITORY"), "/")
 	if len(repoNameSplit) != 2 {
-		return fmt.Errorf("unable to parse GITHUB_REPOSITORY")
+		return "", fmt.Errorf("unable to parse GITHUB_REPOSITORY")
 	}
 	req.Metadata["repo"] = repoNameSplit[1]
 
@@ -79,7 +72,7 @@ func createAppEvent(client *api.Client, applicationName string, cliConf *config.
 	if actionRunID != "" {
 		arid, err := strconv.Atoi(actionRunID)
 		if err != nil {
-			return fmt.Errorf("unable to parse GITHUB_RUN_ID as int: %w", err)
+			return "", fmt.Errorf("unable to parse GITHUB_RUN_ID as int: %w", err)
 		}
 		req.Metadata["action_run_id"] = arid
 	}
@@ -88,18 +81,18 @@ func createAppEvent(client *api.Client, applicationName string, cliConf *config.
 	if repoOwnerAccountID != "" {
 		arid, err := strconv.Atoi(repoOwnerAccountID)
 		if err != nil {
-			return fmt.Errorf("unable to parse GITHUB_REPOSITORY_OWNER_ID as int: %w", err)
+			return "", fmt.Errorf("unable to parse GITHUB_REPOSITORY_OWNER_ID as int: %w", err)
 		}
 		req.Metadata["github_account_id"] = arid
 	}
 
 	ctx := context.Background()
-	_, err := client.CreateOrUpdatePorterAppEvent(ctx, cliConf.Project, cliConf.Cluster, applicationName, req)
+	event, err := client.CreateOrUpdatePorterAppEvent(ctx, projectId, clusterId, applicationName, req)
 	if err != nil {
-		return fmt.Errorf("unable to create porter app build event: %w", err)
+		return "", fmt.Errorf("unable to create porter app build event: %w", err)
 	}
 
-	return nil
+	return event.ID, nil
 }
 
 func createV1BuildResources(client *api.Client, app *Application, stackName string, projectID uint, clusterID uint) ([]*switchboardTypes.Resource, string, error) {
@@ -118,7 +111,6 @@ func createV1BuildResources(client *api.Client, app *Application, stackName stri
 		color.New(color.FgYellow).Printf("No build values specified in porter.yaml, attempting to load stack build settings instead \n")
 
 		res, err := client.GetPorterApp(context.Background(), stackConf.projectID, stackConf.clusterID, stackConf.stackName)
-
 		if err != nil {
 			return nil, "", fmt.Errorf("unable to read build info from DB: %w", err)
 		}
@@ -147,7 +139,6 @@ func createV1BuildResources(client *api.Client, app *Application, stackName stri
 			stackConf.clusterID,
 			stackConf.parsed.Env,
 		)
-
 		if err != nil {
 			return nil, "", err
 		}
@@ -164,7 +155,6 @@ func createV1BuildResources(client *api.Client, app *Application, stackName stri
 }
 
 func createStackConf(client *api.Client, app *Application, stackName string, projectID uint, clusterID uint) (*StackConf, error) {
-
 	err := config.ValidateCLIEnvironment()
 	if err != nil {
 		errMsg := composePreviewMessage("porter CLI is not configured correctly", Error)

cli/cmd/stack/hooks.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/base64"
 	"fmt"
+	"os"
 	"strings"
 
 	"github.com/fatih/color"
@@ -19,6 +20,7 @@ type DeployAppHook struct {
 	BuildImageDriverName string
 	PorterYAML           []byte
 	Builder              string
+	BuildEventID         string
 }
 
 func (t *DeployAppHook) PreApply() error {
@@ -27,6 +29,15 @@ func (t *DeployAppHook) PreApply() error {
 		errMsg := composePreviewMessage("porter CLI is not configured correctly", Error)
 		return fmt.Errorf("%s: %w", errMsg, err)
 	}
+
+	if os.Getenv("GITHUB_RUN_ID") != "" {
+		buildEventId, err := createAppEvent(t.Client, t.ApplicationName, t.ProjectID, t.ClusterID)
+		if err != nil {
+			return err
+		}
+		t.BuildEventID = buildEventId
+	}
+
 	return nil
 }
 
@@ -39,10 +50,17 @@ func (t *DeployAppHook) DataQueries() map[string]interface{} {
 
 // deploy the app
 func (t *DeployAppHook) PostApply(driverOutput map[string]interface{}) error {
-	client := config.GetAPIClient()
+	eventRequest := types.CreateOrUpdatePorterAppEventRequest{
+		Status:   "SUCCESS",
+		Type:     types.PorterAppEventType_Build,
+		Metadata: map[string]any{},
+		ID:       t.BuildEventID,
+	}
+	_, _ = t.Client.CreateOrUpdatePorterAppEvent(context.Background(), t.ProjectID, t.ClusterID, t.ApplicationName, &eventRequest)
+
 	namespace := fmt.Sprintf("porter-stack-%s", t.ApplicationName)
 
-	_, err := client.GetRelease(
+	_, err := t.Client.GetRelease(
 		context.Background(),
 		t.ProjectID,
 		t.ClusterID,
@@ -58,10 +76,10 @@ func (t *DeployAppHook) PostApply(driverOutput map[string]interface{}) error {
 		color.New(color.FgGreen).Printf("Found release for app %s: attempting update\n", t.ApplicationName)
 	}
 
-	return t.applyApp(client, shouldCreate, driverOutput)
+	return t.applyApp(shouldCreate, driverOutput)
 }
 
-func (t *DeployAppHook) applyApp(client *api.Client, shouldCreate bool, driverOutput map[string]interface{}) error {
+func (t *DeployAppHook) applyApp(shouldCreate bool, driverOutput map[string]interface{}) error {
 	var imageInfo types.ImageInfo
 	image, ok := driverOutput["image"].(string)
 	// if it contains a $, then it means the query didn't resolve to anything
@@ -77,7 +95,7 @@ func (t *DeployAppHook) applyApp(client *api.Client, shouldCreate bool, driverOu
 		}
 	}
 
-	_, err := client.CreatePorterApp(
+	_, err := t.Client.CreatePorterApp(
 		context.Background(),
 		t.ProjectID,
 		t.ClusterID,
@@ -101,5 +119,24 @@ func (t *DeployAppHook) applyApp(client *api.Client, shouldCreate bool, driverOu
 	return nil
 }
 
-func (t *DeployAppHook) OnConsolidatedErrors(map[string]error) {}
-func (t *DeployAppHook) OnError(error)                         {}
+func (t *DeployAppHook) OnConsolidatedErrors(errors map[string]error) {
+	errorStringMap := make(map[string]string)
+	for k, v := range errors {
+		errorStringMap[k] = v.Error()
+	}
+	eventRequest := types.CreateOrUpdatePorterAppEventRequest{
+		Status: "FAILED",
+		Type:   types.PorterAppEventType_Build,
+		Metadata: map[string]any{
+			"errors": errorStringMap,
+		},
+		ID: t.BuildEventID,
+	}
+	_, _ = t.Client.CreateOrUpdatePorterAppEvent(context.Background(), t.ProjectID, t.ClusterID, t.ApplicationName, &eventRequest)
+}
+
+func (t *DeployAppHook) OnError(err error) {
+	t.OnConsolidatedErrors(map[string]error{
+		"pre-apply": err,
+	})
+}

internal/analytics/track_events.go

@@ -48,10 +48,12 @@ const (
 	ClusterDestroyingSuccess SegmentEvent = "Cluster Destroying Success"
 
 	// porter apps
-	StackLaunchStart    SegmentEvent = "Stack Launch Started"
-	StackLaunchComplete SegmentEvent = "Stack Launch Complete"
-	StackLaunchSuccess  SegmentEvent = "Stack Launch Success"
-	StackLaunchFailure  SegmentEvent = "Stack Launch Failure"
-	StackDeletion       SegmentEvent = "Stack Deletion"
-	StackBuildFailure   SegmentEvent = "Stack Build Failure"
+	StackLaunchStart      SegmentEvent = "Stack Launch Started"
+	StackLaunchComplete   SegmentEvent = "Stack Launch Complete"
+	StackLaunchSuccess    SegmentEvent = "Stack Launch Success"
+	StackLaunchFailure    SegmentEvent = "Stack Launch Failure"
+	StackDeletion         SegmentEvent = "Stack Deletion"
+	StackBuildProgressing SegmentEvent = "Stack Build Progressing"
+	StackBuildFailure     SegmentEvent = "Stack Build Failure"
+	StackBuildSuccess     SegmentEvent = "Stack Build Success"
 )

internal/analytics/tracks.go

@@ -855,21 +855,23 @@ func StackDeletionTrack(opts *StackDeletionOpts) segmentTrack {
 	)
 }
 
-// StackBuildFailureOpts are the options for creating a track when a stack fails to build
-type StackBuildFailureOpts struct {
+// StackBuildOpts are the options for creating a track when a stack builds
+type StackBuildOpts struct {
 	*ProjectScopedTrackOpts
 
-	StackName   string
-	Email       string
-	FirstName   string
-	LastName    string
-	CompanyName string
+	StackName    string
+	ErrorMessage string
+	Email        string
+	FirstName    string
+	LastName     string
+	CompanyName  string
 }
 
 // StackBuildFailureTrack returns a track for when a stack fails to build
-func StackBuildFailureTrack(opts *StackBuildFailureOpts) segmentTrack {
+func StackBuildFailureTrack(opts *StackBuildOpts) segmentTrack {
 	additionalProps := make(map[string]interface{})
 	additionalProps["stack_name"] = opts.StackName
+	additionalProps["error_message"] = opts.ErrorMessage
 	additionalProps["email"] = opts.Email
 	additionalProps["name"] = opts.FirstName + " " + opts.LastName
 	additionalProps["company"] = opts.CompanyName
@@ -879,3 +881,31 @@ func StackBuildFailureTrack(opts *StackBuildFailureOpts) segmentTrack {
 		getDefaultSegmentTrack(additionalProps, StackBuildFailure),
 	)
 }
+
+// StackBuildSuccessTrack returns a track for when a stack succeeds to build
+func StackBuildSuccessTrack(opts *StackBuildOpts) segmentTrack {
+	additionalProps := make(map[string]interface{})
+	additionalProps["stack_name"] = opts.StackName
+	additionalProps["email"] = opts.Email
+	additionalProps["name"] = opts.FirstName + " " + opts.LastName
+	additionalProps["company"] = opts.CompanyName
+
+	return getSegmentProjectTrack(
+		opts.ProjectScopedTrackOpts,
+		getDefaultSegmentTrack(additionalProps, StackBuildSuccess),
+	)
+}
+
+// StackBuildProgressingTrack returns a track for when a stack starts to build
+func StackBuildProgressingTrack(opts *StackBuildOpts) segmentTrack {
+	additionalProps := make(map[string]interface{})
+	additionalProps["stack_name"] = opts.StackName
+	additionalProps["email"] = opts.Email
+	additionalProps["name"] = opts.FirstName + " " + opts.LastName
+	additionalProps["company"] = opts.CompanyName
+
+	return getSegmentProjectTrack(
+		opts.ProjectScopedTrackOpts,
+		getDefaultSegmentTrack(additionalProps, StackBuildProgressing),
+	)
+}