Add command to fetch console logs from instances for a cluster

openshift · Oct 4, 2021 · bf07a33 · bf07a33
1 parent 47dede3
commit bf07a33
Show file tree

Hide file tree

Showing 4 changed files with 179 additions and 0 deletions.
diff --git a/cmd/consolelogs/aws/getlogs.go b/cmd/consolelogs/aws/getlogs.go
@@ -0,0 +1,151 @@
+package aws
+
+import (
+	"context"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"os/signal"
+	"path/filepath"
+	"syscall"
+	"time"
+
+	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/service/ec2"
+	"github.com/spf13/cobra"
+	"k8s.io/apimachinery/pkg/types"
+	utilerrors "k8s.io/apimachinery/pkg/util/errors"
+
+	hyperv1 "github.com/openshift/hypershift/api/v1alpha1"
+	awsutil "github.com/openshift/hypershift/cmd/infra/aws/util"
+	"github.com/openshift/hypershift/cmd/util"
+)
+
+type consoleLogOpts struct {
+	Name               string
+	Namespace          string
+	AWSCredentialsFile string
+	OutputDir          string
+}
+
+func NewCommand() *cobra.Command {
+
+	opts := &consoleLogOpts{
+		Name:      "example",
+		Namespace: "clusters",
+	}
+
+	cmd := &cobra.Command{
+		Use:          "aws",
+		Short:        "Get AWS machine instance console logs",
+		SilenceUsage: true,
+	}
+
+	cmd.Flags().StringVarP(&opts.Namespace, "namespace", "n", opts.Namespace, "A cluster namespace")
+	cmd.Flags().StringVar(&opts.Name, "name", opts.Name, "A cluster name")
+	cmd.Flags().StringVar(&opts.AWSCredentialsFile, "aws-creds", opts.AWSCredentialsFile, "Path to an AWS credentials file (required)")
+	cmd.Flags().StringVar(&opts.OutputDir, "output-dir", opts.OutputDir, "Directory where to place console logs (required)")
+
+	cmd.MarkFlagRequired("aws-creds")
+	cmd.MarkFlagRequired("output-dir")
+
+	cmd.Run = func(cmd *cobra.Command, args []string) {
+		ctx, cancel := context.WithCancel(context.Background())
+		sigs := make(chan os.Signal, 1)
+		signal.Notify(sigs, syscall.SIGINT)
+		go func() {
+			<-sigs
+			cancel()
+		}()
+
+		if err := opts.Run(ctx); err != nil {
+			log.Error(err, "Failed to get console logs")
+			os.Exit(1)
+		}
+		log.Info("Successfully retrieved console logs")
+	}
+
+	return cmd
+}
+
+func (o *consoleLogOpts) Run(ctx context.Context) error {
+	c := util.GetClientOrDie()
+
+	var hostedCluster hyperv1.HostedCluster
+	if err := c.Get(ctx, types.NamespacedName{Namespace: o.Namespace, Name: o.Name}, &hostedCluster); err != nil {
+		return fmt.Errorf("failed to get hostedcluster: %w", err)
+	}
+	infraID := hostedCluster.Spec.InfraID
+	region := hostedCluster.Spec.Platform.AWS.Region
+	awsSession := awsutil.NewSession("cli-create-infra")
+	awsConfig := awsutil.NewConfig(o.AWSCredentialsFile, region)
+	ec2Client := ec2.New(awsSession, awsConfig)
+
+	// Fetch any instances belonging to the cluster
+	instances, err := getEC2Instances(ctx, ec2Client, infraID)
+	if err != nil {
+		return fmt.Errorf("failed to get AWS instances: %w", err)
+	}
+	// get the console output
+	if err := getInstanceConsoleOutput(ctx, ec2Client, instances, o.OutputDir); err != nil {
+		return fmt.Errorf("failed to get instance console output: %w", err)
+	}
+
+	return nil
+}
+
+func getEC2Instances(ctx context.Context, ec2Client *ec2.EC2, infraID string) (map[string]string, error) {
+	ctxWithTimeout, cancel := context.WithTimeout(ctx, 2*time.Minute)
+	defer cancel()
+	clusterTagFilter := fmt.Sprintf("tag:kubernetes.io/cluster/%s", infraID)
+	clusterTagValue := "owned"
+	output, err := ec2Client.DescribeInstancesWithContext(ctxWithTimeout, &ec2.DescribeInstancesInput{
+		Filters: []*ec2.Filter{
+			{
+				Name:   &clusterTagFilter,
+				Values: []*string{&clusterTagValue},
+			},
+		},
+	})
+	if err != nil {
+		return nil, err
+	}
+	instances := map[string]string{}
+	for _, r := range output.Reservations {
+		for _, instance := range r.Instances {
+			if aws.StringValue(instance.State.Name) == "running" {
+				nameKey := aws.StringValue(instance.InstanceId)
+				for _, tag := range instance.Tags {
+					if aws.StringValue(tag.Key) == "Name" {
+						nameKey = aws.StringValue(tag.Value)
+					}
+				}
+				instances[nameKey] = aws.StringValue(instance.InstanceId)
+			}
+		}
+	}
+	return instances, nil
+}
+
+func getInstanceConsoleOutput(ctx context.Context, ec2Client *ec2.EC2, instances map[string]string, outputDir string) error {
+	if err := os.MkdirAll(outputDir, 0755); err != nil {
+		return err
+	}
+	errs := []error{}
+	for name, instanceID := range instances {
+		ctxWithTimeout, cancel := context.WithTimeout(ctx, 2*time.Minute)
+		defer cancel()
+		output, err := ec2Client.GetConsoleOutputWithContext(ctxWithTimeout, &ec2.GetConsoleOutputInput{
+			InstanceId: aws.String(instanceID),
+		})
+		if err != nil {
+			errs = append(errs, err)
+			continue
+		}
+		ioutil.WriteFile(filepath.Join(outputDir, name+".log"), []byte(aws.StringValue(output.Output)), 0644)
+	}
+	if len(errs) > 0 {
+		return utilerrors.NewAggregate(errs)
+	}
+	return nil
+}
diff --git a/cmd/consolelogs/aws/logging.go b/cmd/consolelogs/aws/logging.go
@@ -0,0 +1,8 @@
+package aws
+
+import (
+	"github.com/bombsimon/logrusr"
+	"github.com/sirupsen/logrus"
+)
+
+var log = logrusr.NewLogger(logrus.New())
diff --git a/cmd/consolelogs/logs.go b/cmd/consolelogs/logs.go
@@ -0,0 +1,18 @@
+package consolelogs
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/openshift/hypershift/cmd/consolelogs/aws"
+)
+
+func NewCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:          "console-logs",
+		Short:        "Get machine instance console logs",
+		SilenceUsage: true,
+	}
+
+	cmd.AddCommand(aws.NewCommand())
+	return cmd
+}
diff --git a/main.go b/main.go
@@ -22,6 +22,7 @@ import (
 
 	"github.com/spf13/cobra"
 
+	consolelogs "github.com/openshift/hypershift/cmd/consolelogs"
 	createcmd "github.com/openshift/hypershift/cmd/create"
 	destroycmd "github.com/openshift/hypershift/cmd/destroy"
 	dumpcmd "github.com/openshift/hypershift/cmd/dump"
@@ -41,6 +42,7 @@ func main() {
 	cmd.AddCommand(createcmd.NewCommand())
 	cmd.AddCommand(destroycmd.NewCommand())
 	cmd.AddCommand(dumpcmd.NewCommand())
+	cmd.AddCommand(consolelogs.NewCommand())
 
 	if err := cmd.Execute(); err != nil {
 		fmt.Fprintf(os.Stderr, "%v\n", err)