servicecontrolreport

package
Version: v0.0.0-...-062eff5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 12, 2018 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package servicecontrolreport is a generated protocol buffer package.

The `servicecontrolreport` template is used by the [Google Service Control](https://istio.io/docs/reference/config/policy-and-telemetry/adapters/servicecontrol/) adapter.

Example config:

“`yaml apiVersion: "config.istio.io/v1alpha2" kind: servicecontrolreport metadata:

name: report
namespace: istio-system

spec:

api_version : api.version | ""
api_operation : api.operation | ""
api_protocol : api.protocol | ""
api_service : api.service | ""
api_key : api.key | ""
request_time : request.time
request_method : request.method
request_path : request.path
request_bytes: request.size
response_time : response.time
response_code : response.code | 520
response_bytes : response.size | 0
response_latency : response.duration | "0ms"

“`

A template used by Google Service Control (servicecontrol) adapter. The adapter generates metrics and logentry for each request based on the data point defined by this template.

It is generated from these files:

mixer/adapter/servicecontrol/template/servicecontrolreport/template_handler_service.proto

It has these top-level messages:

HandleServicecontrolReportRequest
InstanceMsg
Type
InstanceParam

Index

Constants

View Source
const TemplateName = "servicecontrolreport"

Fully qualified name of the template

Variables

View Source
var (
	ErrInvalidLengthTemplateHandlerService = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTemplateHandlerService   = fmt.Errorf("proto: integer overflow")
)

Functions

func RegisterHandleServicecontrolReportServiceServer

func RegisterHandleServicecontrolReportServiceServer(s *grpc.Server, srv HandleServicecontrolReportServiceServer)

Types

type HandleServicecontrolReportRequest

type HandleServicecontrolReportRequest struct {
	// 'servicecontrolreport' instances.
	Instances []*InstanceMsg `protobuf:"bytes,1,rep,name=instances" json:"instances,omitempty"`
	// Adapter specific handler configuration.
	//
	// Note: Backends can also implement [InfrastructureBackend][https://istio.io/docs/reference/config/mixer/istio.mixer.adapter.model.v1beta1.html#InfrastructureBackend]
	// service and therefore opt to receive handler configuration during session creation through [InfrastructureBackend.CreateSession][TODO: Link to this fragment]
	// call. In that case, adapter_config will have type_url as 'google.protobuf.Any.type_url' and would contain string
	// value of session_id (returned from InfrastructureBackend.CreateSession).
	AdapterConfig *google_protobuf1.Any `protobuf:"bytes,2,opt,name=adapter_config,json=adapterConfig" json:"adapter_config,omitempty"`
	// Id to dedupe identical requests from Mixer.
	DedupId string `protobuf:"bytes,3,opt,name=dedup_id,json=dedupId,proto3" json:"dedup_id,omitempty"`
}

Request message for HandleServicecontrolReport method.

func (*HandleServicecontrolReportRequest) Descriptor

func (*HandleServicecontrolReportRequest) Descriptor() ([]byte, []int)

func (*HandleServicecontrolReportRequest) Marshal

func (m *HandleServicecontrolReportRequest) Marshal() (dAtA []byte, err error)

func (*HandleServicecontrolReportRequest) MarshalTo

func (m *HandleServicecontrolReportRequest) MarshalTo(dAtA []byte) (int, error)

func (*HandleServicecontrolReportRequest) ProtoMessage

func (*HandleServicecontrolReportRequest) ProtoMessage()

func (*HandleServicecontrolReportRequest) Reset

func (*HandleServicecontrolReportRequest) Size

func (m *HandleServicecontrolReportRequest) Size() (n int)

func (*HandleServicecontrolReportRequest) String

func (*HandleServicecontrolReportRequest) Unmarshal

func (m *HandleServicecontrolReportRequest) Unmarshal(dAtA []byte) error

type HandleServicecontrolReportServiceClient

type HandleServicecontrolReportServiceClient interface {
	// HandleServicecontrolReport is called by Mixer at request-time to deliver 'servicecontrolreport' instances to the backend.
	HandleServicecontrolReport(ctx context.Context, in *HandleServicecontrolReportRequest, opts ...grpc.CallOption) (*istio_mixer_adapter_model_v1beta11.ReportResult, error)
}

type HandleServicecontrolReportServiceServer

type HandleServicecontrolReportServiceServer interface {
	// HandleServicecontrolReport is called by Mixer at request-time to deliver 'servicecontrolreport' instances to the backend.
	HandleServicecontrolReport(context.Context, *HandleServicecontrolReportRequest) (*istio_mixer_adapter_model_v1beta11.ReportResult, error)
}

type Handler

type Handler interface {
	adapter.Handler

	// HandleServicecontrolReport is called by Mixer at request time to deliver instances to
	// to an adapter.
	HandleServicecontrolReport(context.Context, []*Instance) error
}

Handler must be implemented by adapter code if it wants to process data associated with the 'servicecontrolreport' template.

Mixer uses this interface to call into the adapter at request time in order to dispatch created instances to the adapter. Adapters take the incoming instances and do what they need to achieve their primary function.

The name of each instance can be used as a key into the Type map supplied to the adapter at configuration time via the method 'SetServicecontrolReportTypes'. These Type associated with an instance describes the shape of the instance

type HandlerBuilder

type HandlerBuilder interface {
	adapter.HandlerBuilder

	// SetServicecontrolReportTypes is invoked by Mixer to pass the template-specific Type information for instances that an adapter
	// may receive at runtime. The type information describes the shape of the instance.
	SetServicecontrolReportTypes(map[string]*Type)
}

HandlerBuilder must be implemented by adapters if they want to process data associated with the 'servicecontrolreport' template.

Mixer uses this interface to call into the adapter at configuration time to configure it with adapter-specific configuration as well as all template-specific type information.

type Instance

type Instance struct {
	// Name of the instance as specified in configuration.
	Name string

	ApiVersion string

	ApiOperation string

	ApiProtocol string

	ApiService string

	ApiKey string

	RequestTime time.Time

	RequestMethod string

	RequestPath string

	RequestBytes int64

	ResponseTime time.Time

	ResponseCode int64

	ResponseBytes int64

	ResponseLatency time.Duration
}

Instance is constructed by Mixer for the 'servicecontrolreport' template.

A template used by Google Service Control (servicecontrol) adapter. The adapter generates metrics and logentry for each request based on the data point defined by this template.

type InstanceMsg

type InstanceMsg struct {
	// Name of the instance as specified in configuration.
	Name            string                          `protobuf:"bytes,72295727,opt,name=name,proto3" json:"name,omitempty"`
	ApiVersion      string                          `protobuf:"bytes,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	ApiOperation    string                          `protobuf:"bytes,2,opt,name=api_operation,json=apiOperation,proto3" json:"api_operation,omitempty"`
	ApiProtocol     string                          `protobuf:"bytes,3,opt,name=api_protocol,json=apiProtocol,proto3" json:"api_protocol,omitempty"`
	ApiService      string                          `protobuf:"bytes,4,opt,name=api_service,json=apiService,proto3" json:"api_service,omitempty"`
	ApiKey          string                          `protobuf:"bytes,5,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	RequestTime     *istio_policy_v1beta1.TimeStamp `protobuf:"bytes,6,opt,name=request_time,json=requestTime" json:"request_time,omitempty"`
	RequestMethod   string                          `protobuf:"bytes,7,opt,name=request_method,json=requestMethod,proto3" json:"request_method,omitempty"`
	RequestPath     string                          `protobuf:"bytes,8,opt,name=request_path,json=requestPath,proto3" json:"request_path,omitempty"`
	RequestBytes    int64                           `protobuf:"varint,9,opt,name=request_bytes,json=requestBytes,proto3" json:"request_bytes,omitempty"`
	ResponseTime    *istio_policy_v1beta1.TimeStamp `protobuf:"bytes,10,opt,name=response_time,json=responseTime" json:"response_time,omitempty"`
	ResponseCode    int64                           `protobuf:"varint,11,opt,name=response_code,json=responseCode,proto3" json:"response_code,omitempty"`
	ResponseBytes   int64                           `protobuf:"varint,12,opt,name=response_bytes,json=responseBytes,proto3" json:"response_bytes,omitempty"`
	ResponseLatency *istio_policy_v1beta1.Duration  `protobuf:"bytes,13,opt,name=response_latency,json=responseLatency" json:"response_latency,omitempty"`
}

Contains instance payload for 'servicecontrolreport' template. This is passed to infrastructure backends during request-time through HandleServicecontrolReportService.HandleServicecontrolReport.

func (*InstanceMsg) Descriptor

func (*InstanceMsg) Descriptor() ([]byte, []int)

func (*InstanceMsg) Marshal

func (m *InstanceMsg) Marshal() (dAtA []byte, err error)

func (*InstanceMsg) MarshalTo

func (m *InstanceMsg) MarshalTo(dAtA []byte) (int, error)

func (*InstanceMsg) ProtoMessage

func (*InstanceMsg) ProtoMessage()

func (*InstanceMsg) Reset

func (m *InstanceMsg) Reset()

func (*InstanceMsg) Size

func (m *InstanceMsg) Size() (n int)

func (*InstanceMsg) String

func (this *InstanceMsg) String() string

func (*InstanceMsg) Unmarshal

func (m *InstanceMsg) Unmarshal(dAtA []byte) error

type InstanceParam

type InstanceParam struct {
	ApiVersion      string `protobuf:"bytes,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	ApiOperation    string `protobuf:"bytes,2,opt,name=api_operation,json=apiOperation,proto3" json:"api_operation,omitempty"`
	ApiProtocol     string `protobuf:"bytes,3,opt,name=api_protocol,json=apiProtocol,proto3" json:"api_protocol,omitempty"`
	ApiService      string `protobuf:"bytes,4,opt,name=api_service,json=apiService,proto3" json:"api_service,omitempty"`
	ApiKey          string `protobuf:"bytes,5,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	RequestTime     string `protobuf:"bytes,6,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
	RequestMethod   string `protobuf:"bytes,7,opt,name=request_method,json=requestMethod,proto3" json:"request_method,omitempty"`
	RequestPath     string `protobuf:"bytes,8,opt,name=request_path,json=requestPath,proto3" json:"request_path,omitempty"`
	RequestBytes    string `protobuf:"bytes,9,opt,name=request_bytes,json=requestBytes,proto3" json:"request_bytes,omitempty"`
	ResponseTime    string `protobuf:"bytes,10,opt,name=response_time,json=responseTime,proto3" json:"response_time,omitempty"`
	ResponseCode    string `protobuf:"bytes,11,opt,name=response_code,json=responseCode,proto3" json:"response_code,omitempty"`
	ResponseBytes   string `protobuf:"bytes,12,opt,name=response_bytes,json=responseBytes,proto3" json:"response_bytes,omitempty"`
	ResponseLatency string `protobuf:"bytes,13,opt,name=response_latency,json=responseLatency,proto3" json:"response_latency,omitempty"`
}

Represents instance configuration schema for 'servicecontrolreport' template.

func (*InstanceParam) Descriptor

func (*InstanceParam) Descriptor() ([]byte, []int)

func (*InstanceParam) Marshal

func (m *InstanceParam) Marshal() (dAtA []byte, err error)

func (*InstanceParam) MarshalTo

func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)

func (*InstanceParam) ProtoMessage

func (*InstanceParam) ProtoMessage()

func (*InstanceParam) Reset

func (m *InstanceParam) Reset()

func (*InstanceParam) Size

func (m *InstanceParam) Size() (n int)

func (*InstanceParam) String

func (this *InstanceParam) String() string

func (*InstanceParam) Unmarshal

func (m *InstanceParam) Unmarshal(dAtA []byte) error

type Type

type Type struct {
}

Contains inferred type information about specific instance of 'servicecontrolreport' template. This is passed to infrastructure backends during configuration-time through [InfrastructureBackend.CreateSession][TODO: Link to this fragment].

func (*Type) Descriptor

func (*Type) Descriptor() ([]byte, []int)

func (*Type) Marshal

func (m *Type) Marshal() (dAtA []byte, err error)

func (*Type) MarshalTo

func (m *Type) MarshalTo(dAtA []byte) (int, error)

func (*Type) ProtoMessage

func (*Type) ProtoMessage()

func (*Type) Reset

func (m *Type) Reset()

func (*Type) Size

func (m *Type) Size() (n int)

func (*Type) String

func (this *Type) String() string

func (*Type) Unmarshal

func (m *Type) Unmarshal(dAtA []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL