server/plugin/tracing/tracing.go

/*
 * Licensed to the 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.
 * The 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 tracing

import (
	"context"

	"github.com/apache/servicecomb-service-center/pkg/plugin"
	"github.com/apache/servicecomb-service-center/pkg/util"
)

const (
	TRACING      plugin.Kind = "tracing"
	CtxTraceSpan util.CtxKey = "x-trace-span"
)

type Tracing interface {
	ServerBegin(operationName string, r interface{}) interface{}
	ServerEnd(span interface{}, code int, message string)
	ClientBegin(operationName string, r interface{}) interface{}
	ClientEnd(span interface{}, code int, message string)
}

type Request struct {
	Ctx      context.Context
	Endpoint string
	Method   string
	URL      string
}

func Trace() Tracing {
	return plugin.Plugins().Instance(TRACING).(Tracing)
}

func ServerBegin(operationName string, r interface{}) interface{} {
	return Trace().ServerBegin(operationName, r)
}

func ServerEnd(span interface{}, code int, message string) {
	Trace().ServerEnd(span, code, message)
}

func ClientBegin(operationName string, r interface{}) interface{} {
	return Trace().ClientBegin(operationName, r)
}

func ClientEnd(span interface{}, code int, message string) {
	Trace().ClientEnd(span, code, message)
}