Documentation ¶
Overview ¶
Package pb is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterAnalyticsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterAnalyticsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AnalyticsServiceClient) error
- func RegisterAnalyticsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterAnalyticsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AnalyticsServiceServer) error
- func RegisterAnalyticsServiceServer(s grpc.ServiceRegistrar, srv AnalyticsServiceServer)
- type AnalyticsEvents
- type AnalyticsServiceClient
- type AnalyticsServiceServer
- type DeliveryType
- func (DeliveryType) Descriptor() protoreflect.EnumDescriptor
- func (x DeliveryType) Enum() *DeliveryType
- func (DeliveryType) EnumDescriptor() ([]byte, []int)deprecated
- func (x DeliveryType) Number() protoreflect.EnumNumber
- func (x DeliveryType) String() string
- func (DeliveryType) Type() protoreflect.EnumType
- type Event
- func (*Event) Descriptor() ([]byte, []int)deprecated
- func (x *Event) GetDeliverTo() DeliveryType
- func (x *Event) GetEvent() string
- func (x *Event) GetProperties() []byte
- func (*Event) ProtoMessage()
- func (x *Event) ProtoReflect() protoreflect.Message
- func (x *Event) Reset()
- func (x *Event) String() string
- type Nothing
- type UnimplementedAnalyticsServiceServer
- type UnsafeAnalyticsServiceServer
Constants ¶
const (
AnalyticsService_Analytics_FullMethodName = "/analytics.pb.AnalyticsService/Analytics"
)
Variables ¶
var ( DeliveryType_name = map[int32]string{ 0: "Local", 1: "ThinkingData", 2: "ClickHouse", 3: "Mixpanel", } DeliveryType_value = map[string]int32{ "Local": 0, "ThinkingData": 1, "ClickHouse": 2, "Mixpanel": 3, } )
Enum value maps for DeliveryType.
var AnalyticsService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "analytics.pb.AnalyticsService", HandlerType: (*AnalyticsServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Analytics", Handler: _AnalyticsService_Analytics_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "analytics/analytics.proto", }
AnalyticsService_ServiceDesc is the grpc.ServiceDesc for AnalyticsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_analytics_analytics_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAnalyticsServiceHandler ¶
func RegisterAnalyticsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterAnalyticsServiceHandler registers the http handlers for service AnalyticsService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterAnalyticsServiceHandlerClient ¶
func RegisterAnalyticsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AnalyticsServiceClient) error
RegisterAnalyticsServiceHandlerClient registers the http handlers for service AnalyticsService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "AnalyticsServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "AnalyticsServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "AnalyticsServiceClient" to call the correct interceptors.
func RegisterAnalyticsServiceHandlerFromEndpoint ¶
func RegisterAnalyticsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterAnalyticsServiceHandlerFromEndpoint is same as RegisterAnalyticsServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterAnalyticsServiceHandlerServer ¶
func RegisterAnalyticsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AnalyticsServiceServer) error
RegisterAnalyticsServiceHandlerServer registers the http handlers for service AnalyticsService to "mux". UnaryRPC :call AnalyticsServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterAnalyticsServiceHandlerFromEndpoint instead.
func RegisterAnalyticsServiceServer ¶
func RegisterAnalyticsServiceServer(s grpc.ServiceRegistrar, srv AnalyticsServiceServer)
Types ¶
type AnalyticsEvents ¶
type AnalyticsEvents struct { Events []*Event `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"` // contains filtered or unexported fields }
func (*AnalyticsEvents) Descriptor
deprecated
func (*AnalyticsEvents) Descriptor() ([]byte, []int)
Deprecated: Use AnalyticsEvents.ProtoReflect.Descriptor instead.
func (*AnalyticsEvents) GetEvents ¶
func (x *AnalyticsEvents) GetEvents() []*Event
func (*AnalyticsEvents) ProtoMessage ¶
func (*AnalyticsEvents) ProtoMessage()
func (*AnalyticsEvents) ProtoReflect ¶
func (x *AnalyticsEvents) ProtoReflect() protoreflect.Message
func (*AnalyticsEvents) Reset ¶
func (x *AnalyticsEvents) Reset()
func (*AnalyticsEvents) String ¶
func (x *AnalyticsEvents) String() string
type AnalyticsServiceClient ¶
type AnalyticsServiceClient interface { // Analytics send a batch of analytics events to the analytics service,return Nothing // 发送一批分析事件到分析服务,返回Nothing Analytics(ctx context.Context, in *AnalyticsEvents, opts ...grpc.CallOption) (*Nothing, error) }
AnalyticsServiceClient is the client API for AnalyticsService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
AnalyticsService is the service that allows clients to send analytics events to the analytics service. 统计服务: 允许客户端将分析事件发送到分析服务的服务。
func NewAnalyticsServiceClient ¶
func NewAnalyticsServiceClient(cc grpc.ClientConnInterface) AnalyticsServiceClient
type AnalyticsServiceServer ¶
type AnalyticsServiceServer interface { // Analytics send a batch of analytics events to the analytics service,return Nothing // 发送一批分析事件到分析服务,返回Nothing Analytics(context.Context, *AnalyticsEvents) (*Nothing, error) }
AnalyticsServiceServer is the server API for AnalyticsService service. All implementations should embed UnimplementedAnalyticsServiceServer for forward compatibility
AnalyticsService is the service that allows clients to send analytics events to the analytics service. 统计服务: 允许客户端将分析事件发送到分析服务的服务。
type DeliveryType ¶
type DeliveryType int32
const ( // Deliver to the local file DeliveryType_Local DeliveryType = 0 // Deliver to ThinkingData // https://www.thinkingdata.cn/ DeliveryType_ThinkingData DeliveryType = 1 // Deliver to clickhouse DeliveryType_ClickHouse DeliveryType = 2 // Deliver to Mixpanel // https://mixpanel.com/ DeliveryType_Mixpanel DeliveryType = 3 )
func (DeliveryType) Descriptor ¶
func (DeliveryType) Descriptor() protoreflect.EnumDescriptor
func (DeliveryType) Enum ¶
func (x DeliveryType) Enum() *DeliveryType
func (DeliveryType) EnumDescriptor
deprecated
func (DeliveryType) EnumDescriptor() ([]byte, []int)
Deprecated: Use DeliveryType.Descriptor instead.
func (DeliveryType) Number ¶
func (x DeliveryType) Number() protoreflect.EnumNumber
func (DeliveryType) String ¶
func (x DeliveryType) String() string
func (DeliveryType) Type ¶
func (DeliveryType) Type() protoreflect.EnumType
type Event ¶
type Event struct { // The unique name for this event. Be pragmatic with event names and store additional properties in the // properties field. // NOTE: only contain: number,letter(ignoring case) and underscore"_" ,no spaces in the configuration Event string `protobuf:"bytes,1,opt,name=event,proto3" json:"event,omitempty"` // Generic JSON property key/value pairs. {"id":"fun","age":10} Properties []byte `protobuf:"bytes,2,opt,name=properties,proto3" json:"properties,omitempty"` // Where to deliver this event to, defaults to Local. DeliverTo DeliveryType `protobuf:"varint,3,opt,name=deliver_to,json=deliverTo,proto3,enum=analytics.pb.DeliveryType" json:"deliver_to,omitempty"` // contains filtered or unexported fields }
AnalyticsEvent is a single analytics event to capture.
func (*Event) Descriptor
deprecated
func (*Event) GetDeliverTo ¶
func (x *Event) GetDeliverTo() DeliveryType
func (*Event) GetProperties ¶
func (*Event) ProtoMessage ¶
func (*Event) ProtoMessage()
func (*Event) ProtoReflect ¶
func (x *Event) ProtoReflect() protoreflect.Message
type Nothing ¶
type Nothing struct {
// contains filtered or unexported fields
}
Nothing is an empty message. Used when there's nothing to send.
func (*Nothing) Descriptor
deprecated
func (*Nothing) ProtoMessage ¶
func (*Nothing) ProtoMessage()
func (*Nothing) ProtoReflect ¶
func (x *Nothing) ProtoReflect() protoreflect.Message
type UnimplementedAnalyticsServiceServer ¶
type UnimplementedAnalyticsServiceServer struct { }
UnimplementedAnalyticsServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedAnalyticsServiceServer) Analytics ¶
func (UnimplementedAnalyticsServiceServer) Analytics(context.Context, *AnalyticsEvents) (*Nothing, error)
type UnsafeAnalyticsServiceServer ¶
type UnsafeAnalyticsServiceServer interface {
// contains filtered or unexported methods
}
UnsafeAnalyticsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AnalyticsServiceServer will result in compilation errors.