aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/google.golang.org/grpc/stats
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/google.golang.org/grpc/stats')
-rw-r--r--vendor/google.golang.org/grpc/stats/handlers.go64
-rw-r--r--vendor/google.golang.org/grpc/stats/stats.go210
2 files changed, 274 insertions, 0 deletions
diff --git a/vendor/google.golang.org/grpc/stats/handlers.go b/vendor/google.golang.org/grpc/stats/handlers.go
new file mode 100644
index 0000000..05b384c
--- /dev/null
+++ b/vendor/google.golang.org/grpc/stats/handlers.go
@@ -0,0 +1,64 @@
1/*
2 *
3 * Copyright 2016 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19package stats
20
21import (
22 "net"
23
24 "golang.org/x/net/context"
25)
26
27// ConnTagInfo defines the relevant information needed by connection context tagger.
28type ConnTagInfo struct {
29 // RemoteAddr is the remote address of the corresponding connection.
30 RemoteAddr net.Addr
31 // LocalAddr is the local address of the corresponding connection.
32 LocalAddr net.Addr
33}
34
35// RPCTagInfo defines the relevant information needed by RPC context tagger.
36type RPCTagInfo struct {
37 // FullMethodName is the RPC method in the format of /package.service/method.
38 FullMethodName string
39 // FailFast indicates if this RPC is failfast.
40 // This field is only valid on client side, it's always false on server side.
41 FailFast bool
42}
43
44// Handler defines the interface for the related stats handling (e.g., RPCs, connections).
45type Handler interface {
46 // TagRPC can attach some information to the given context.
47 // The context used for the rest lifetime of the RPC will be derived from
48 // the returned context.
49 TagRPC(context.Context, *RPCTagInfo) context.Context
50 // HandleRPC processes the RPC stats.
51 HandleRPC(context.Context, RPCStats)
52
53 // TagConn can attach some information to the given context.
54 // The returned context will be used for stats handling.
55 // For conn stats handling, the context used in HandleConn for this
56 // connection will be derived from the context returned.
57 // For RPC stats handling,
58 // - On server side, the context used in HandleRPC for all RPCs on this
59 // connection will be derived from the context returned.
60 // - On client side, the context is not derived from the context returned.
61 TagConn(context.Context, *ConnTagInfo) context.Context
62 // HandleConn processes the Conn stats.
63 HandleConn(context.Context, ConnStats)
64}
diff --git a/vendor/google.golang.org/grpc/stats/stats.go b/vendor/google.golang.org/grpc/stats/stats.go
new file mode 100644
index 0000000..338a3a7
--- /dev/null
+++ b/vendor/google.golang.org/grpc/stats/stats.go
@@ -0,0 +1,210 @@
1/*
2 *
3 * Copyright 2016 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19// Package stats is for collecting and reporting various network and RPC stats.
20// This package is for monitoring purpose only. All fields are read-only.
21// All APIs are experimental.
22package stats // import "google.golang.org/grpc/stats"
23
24import (
25 "net"
26 "time"
27)
28
29// RPCStats contains stats information about RPCs.
30type RPCStats interface {
31 isRPCStats()
32 // IsClient returns true if this RPCStats is from client side.
33 IsClient() bool
34}
35
36// Begin contains stats when an RPC begins.
37// FailFast is only valid if this Begin is from client side.
38type Begin struct {
39 // Client is true if this Begin is from client side.
40 Client bool
41 // BeginTime is the time when the RPC begins.
42 BeginTime time.Time
43 // FailFast indicates if this RPC is failfast.
44 FailFast bool
45}
46
47// IsClient indicates if the stats information is from client side.
48func (s *Begin) IsClient() bool { return s.Client }
49
50func (s *Begin) isRPCStats() {}
51
52// InPayload contains the information for an incoming payload.
53type InPayload struct {
54 // Client is true if this InPayload is from client side.
55 Client bool
56 // Payload is the payload with original type.
57 Payload interface{}
58 // Data is the serialized message payload.
59 Data []byte
60 // Length is the length of uncompressed data.
61 Length int
62 // WireLength is the length of data on wire (compressed, signed, encrypted).
63 WireLength int
64 // RecvTime is the time when the payload is received.
65 RecvTime time.Time
66}
67
68// IsClient indicates if the stats information is from client side.
69func (s *InPayload) IsClient() bool { return s.Client }
70
71func (s *InPayload) isRPCStats() {}
72
73// InHeader contains stats when a header is received.
74type InHeader struct {
75 // Client is true if this InHeader is from client side.
76 Client bool
77 // WireLength is the wire length of header.
78 WireLength int
79
80 // The following fields are valid only if Client is false.
81 // FullMethod is the full RPC method string, i.e., /package.service/method.
82 FullMethod string
83 // RemoteAddr is the remote address of the corresponding connection.
84 RemoteAddr net.Addr
85 // LocalAddr is the local address of the corresponding connection.
86 LocalAddr net.Addr
87 // Compression is the compression algorithm used for the RPC.
88 Compression string
89}
90
91// IsClient indicates if the stats information is from client side.
92func (s *InHeader) IsClient() bool { return s.Client }
93
94func (s *InHeader) isRPCStats() {}
95
96// InTrailer contains stats when a trailer is received.
97type InTrailer struct {
98 // Client is true if this InTrailer is from client side.
99 Client bool
100 // WireLength is the wire length of trailer.
101 WireLength int
102}
103
104// IsClient indicates if the stats information is from client side.
105func (s *InTrailer) IsClient() bool { return s.Client }
106
107func (s *InTrailer) isRPCStats() {}
108
109// OutPayload contains the information for an outgoing payload.
110type OutPayload struct {
111 // Client is true if this OutPayload is from client side.
112 Client bool
113 // Payload is the payload with original type.
114 Payload interface{}
115 // Data is the serialized message payload.
116 Data []byte
117 // Length is the length of uncompressed data.
118 Length int
119 // WireLength is the length of data on wire (compressed, signed, encrypted).
120 WireLength int
121 // SentTime is the time when the payload is sent.
122 SentTime time.Time
123}
124
125// IsClient indicates if this stats information is from client side.
126func (s *OutPayload) IsClient() bool { return s.Client }
127
128func (s *OutPayload) isRPCStats() {}
129
130// OutHeader contains stats when a header is sent.
131type OutHeader struct {
132 // Client is true if this OutHeader is from client side.
133 Client bool
134 // WireLength is the wire length of header.
135 WireLength int
136
137 // The following fields are valid only if Client is true.
138 // FullMethod is the full RPC method string, i.e., /package.service/method.
139 FullMethod string
140 // RemoteAddr is the remote address of the corresponding connection.
141 RemoteAddr net.Addr
142 // LocalAddr is the local address of the corresponding connection.
143 LocalAddr net.Addr
144 // Compression is the compression algorithm used for the RPC.
145 Compression string
146}
147
148// IsClient indicates if this stats information is from client side.
149func (s *OutHeader) IsClient() bool { return s.Client }
150
151func (s *OutHeader) isRPCStats() {}
152
153// OutTrailer contains stats when a trailer is sent.
154type OutTrailer struct {
155 // Client is true if this OutTrailer is from client side.
156 Client bool
157 // WireLength is the wire length of trailer.
158 WireLength int
159}
160
161// IsClient indicates if this stats information is from client side.
162func (s *OutTrailer) IsClient() bool { return s.Client }
163
164func (s *OutTrailer) isRPCStats() {}
165
166// End contains stats when an RPC ends.
167type End struct {
168 // Client is true if this End is from client side.
169 Client bool
170 // EndTime is the time when the RPC ends.
171 EndTime time.Time
172 // Error is the error the RPC ended with. It is an error generated from
173 // status.Status and can be converted back to status.Status using
174 // status.FromError if non-nil.
175 Error error
176}
177
178// IsClient indicates if this is from client side.
179func (s *End) IsClient() bool { return s.Client }
180
181func (s *End) isRPCStats() {}
182
183// ConnStats contains stats information about connections.
184type ConnStats interface {
185 isConnStats()
186 // IsClient returns true if this ConnStats is from client side.
187 IsClient() bool
188}
189
190// ConnBegin contains the stats of a connection when it is established.
191type ConnBegin struct {
192 // Client is true if this ConnBegin is from client side.
193 Client bool
194}
195
196// IsClient indicates if this is from client side.
197func (s *ConnBegin) IsClient() bool { return s.Client }
198
199func (s *ConnBegin) isConnStats() {}
200
201// ConnEnd contains the stats of a connection when it ends.
202type ConnEnd struct {
203 // Client is true if this ConnEnd is from client side.
204 Client bool
205}
206
207// IsClient indicates if this is from client side.
208func (s *ConnEnd) IsClient() bool { return s.Client }
209
210func (s *ConnEnd) isConnStats() {}