util

Documentation

Index

• Variables
• func BuildResource(namespace string, args ...string) (pb.Resource, error)
• func BuildStatSummaryRequest(p StatSummaryRequestParams) (*pb.StatSummaryRequest, error)
• func BuildTapByResourceRequest(params TapRequestParams) (*pb.TapByResourceRequest, error)
• func GRPCError(err error) error
• func RenderTapEvent(event *pb.TapEvent) string
• type StatSummaryRequestParams
• type TapRequestParams

Variables

var (

	// ValidTargets specifies resource types allowed as a target:
	// target resource on an inbound query
	// target resource on an outbound 'to' query
	// destination resource on an outbound 'from' query
	ValidTargets = []string{
		k8s.Deployment,
		k8s.Namespace,
		k8s.Pod,
		k8s.ReplicationController,
		k8s.Authority,
	}

	// ValidDestinations specifies resource types allowed as a destination:
	// destination resource on an outbound 'to' query
	// target resource on an outbound 'from' query
	ValidDestinations = []string{
		k8s.Deployment,
		k8s.Namespace,
		k8s.Pod,
		k8s.ReplicationController,
		k8s.Service,
	}
)

Functions

func BuildResource

func BuildResource(namespace string, args ...string) (pb.Resource, error)

BuildResource parses input strings, typically from CLI flags, to build a Resource object for use in the protobuf API.

func BuildStatSummaryRequest

func BuildStatSummaryRequest(p StatSummaryRequestParams) (*pb.StatSummaryRequest, error)

func BuildTapByResourceRequest

func BuildTapByResourceRequest(params TapRequestParams) (*pb.TapByResourceRequest, error)

func GRPCError

func GRPCError(err error) error

GRPCError generates a gRPC error code, as defined in google.golang.org/grpc/status. If the error is nil or already a gRPC error, return the error. If the error is of type k8s.io/apimachinery/pkg/apis/meta/v1#StatusReason, attempt to map the reason to a gRPC error.

func RenderTapEvent

func RenderTapEvent(event *pb.TapEvent) string

Types

type StatSummaryRequestParams

type StatSummaryRequestParams struct {
	TimeWindow    string
	Namespace     string
	ResourceType  string
	ResourceName  string
	ToNamespace   string
	ToType        string
	ToName        string
	FromNamespace string
	FromType      string
	FromName      string
	AllNamespaces bool
}

type TapRequestParams

type TapRequestParams struct {
	Resource    string
	Namespace   string
	ToResource  string
	ToNamespace string
	MaxRps      float32
	Scheme      string
	Method      string
	Authority   string
	Path        string
}