commands/metrics/single/single-metrics.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 single

import (
	"fmt"

	"github.com/apache/skywalking-cli/commands/flags"
	"github.com/apache/skywalking-cli/commands/interceptor"
	"github.com/apache/skywalking-cli/commands/model"
	"github.com/apache/skywalking-cli/display"
	"github.com/apache/skywalking-cli/display/displayable"
	"github.com/apache/skywalking-cli/graphql/metrics"
	"github.com/apache/skywalking-cli/graphql/schema"

	"github.com/urfave/cli"
)

var Command = cli.Command{
	Name:  "single",
	Usage: "Query single metrics defined in backend OAL",
	Flags: flags.Flags(
		flags.DurationFlags,
		flags.MetricsFlags,
	),
	Before: interceptor.BeforeChain([]cli.BeforeFunc{
		interceptor.TimezoneInterceptor,
		interceptor.DurationInterceptor,
	}),
	Action: func(ctx *cli.Context) error {
		end := ctx.String("end")
		start := ctx.String("start")
		step := ctx.Generic("step")

		metricsName := ctx.String("name")
		serviceName := ctx.String("service")
		normal := ctx.BoolT("isNormal")
		instanceName := ctx.String("instance")
		endpointName := ctx.String("endpoint")
		scope := interceptor.ParseScope(metricsName)

		if serviceName == "" {
			return fmt.Errorf("the name of service should be specified")
		}
		if scope == schema.ScopeAll {
			return fmt.Errorf("this command cannot be used to query `All` scope metrics")
		}

		duration := schema.Duration{
			Start: start,
			End:   end,
			Step:  step.(*model.StepEnumValue).Selected,
		}

		metricsValue := metrics.IntValues(ctx, schema.MetricsCondition{
			Name: metricsName,
			Entity: &schema.Entity{
				Scope:               scope,
				ServiceName:         &serviceName,
				Normal:              &normal,
				ServiceInstanceName: &instanceName,
				EndpointName:        &endpointName,
			},
		}, duration)

		return display.Display(ctx, &displayable.Displayable{Data: metricsValue})
	},
}