internal/commands/event/report.go

// Licensed to Apache Software Foundation (ASF) under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Apache Software Foundation (ASF) licenses this file to you 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 event

import (
	"strings"

	"github.com/google/uuid"
	"github.com/urfave/cli/v2"
	event "skywalking.apache.org/repo/goapi/collect/event/v3"

	"github.com/apache/skywalking-cli/internal/commands/interceptor"
	"github.com/apache/skywalking-cli/internal/flags"
	"github.com/apache/skywalking-cli/internal/model"
	"github.com/apache/skywalking-cli/pkg/display"
	"github.com/apache/skywalking-cli/pkg/display/displayable"
	"github.com/apache/skywalking-cli/pkg/grpc"
	"github.com/apache/skywalking-cli/pkg/logger"
)

var reportCommand = &cli.Command{
	Name:    "report",
	Aliases: []string{"r"},
	Usage:   "Report an event to OAP server via gRPC",
	Description: `When reporting an event, you typically execute the command twice, 
one for starting of the event (--start-time is required) and the other one for ending of the event 
(--uuid and --end-time are required).\n You can also report an event once with start time and end time.`,
	ArgsUsage: "[parameters...]",
	Flags: flags.Flags(
		flags.InstanceFlags,
		flags.EndpointFlags,

		[]cli.Flag{
			&cli.StringFlag{
				Name:        "uuid",
				Usage:       "Unique `ID` of the event, if not specified, a random one will be generated.",
				Value:       uuid.New().String(),
				DefaultText: "",
			},
			&cli.StringFlag{
				Name:  "name",
				Usage: "The name of the event. For example, 'Reboot' and 'Upgrade' etc.",
			},
			&cli.GenericFlag{
				Name:  "type",
				Usage: "The type of the event.",
				Value: &model.EventTypeEnumValue{
					Enum:     []event.Type{event.Type_Normal, event.Type_Error},
					Default:  event.Type_Normal,
					Selected: event.Type_Normal,
				},
			},
			&cli.StringFlag{
				Name:  "message",
				Usage: "The detail of the event. This should be a one-line message that briefly describes why the event is reported.",
			},
			&cli.Int64Flag{
				Name:  "start-time",
				Usage: "The start time (in milliseconds) of the event, measured between the current time and midnight, January 1, 1970 UTC.",
			},
			&cli.Int64Flag{
				Name:  "end-time",
				Usage: "The end time (in milliseconds) of the event, measured between the current time and midnight, January 1, 1970 UTC.",
			},
			&cli.StringFlag{
				Name:     "layer",
				Usage:    "Name of the layer to which the event belongs (case-insensitive), which can be queried via 'swctl layer list'",
				Required: true,
			},
		},
	),
	Action: func(ctx *cli.Context) error {
		parameters, err := interceptor.ParseParameters(ctx.Args())
		if err != nil {
			return err
		}

		e := event.Event{
			Uuid: ctx.String("uuid"),
			Source: &event.Source{
				Service:         ctx.String("service-name"),
				ServiceInstance: ctx.String("instance-name"),
				Endpoint:        ctx.String("endpoint-name"),
			},
			Name:       ctx.String("name"),
			Type:       ctx.Generic("type").(*model.EventTypeEnumValue).Selected,
			Message:    ctx.String("message"),
			Parameters: parameters,
			StartTime:  ctx.Int64("start-time"),
			EndTime:    ctx.Int64("end-time"),
			Layer:      strings.ToUpper(ctx.String("layer")),
		}

		reply, err := grpc.ReportEvent(ctx.String("grpc-addr"), &e)
		if err != nil {
			return err
		}

		logger.Log.Printf("Report the event successfully, whose uuid is %s\n", ctx.String("uuid"))
		return display.Display(ctx.Context, &displayable.Displayable{Data: reply})
	},
}