1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
# Copyright The OpenTelemetry Authors
#
# Licensed 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.
from typing import Final
from opentelemetry.metrics import Histogram, Meter
RPC_CLIENT_DURATION: Final = "rpc.client.duration"
"""
Measures the duration of outbound RPC
Instrument: histogram
Unit: ms
Note: While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.
**Streaming**: N/A.
"""
def create_rpc_client_duration(meter: Meter) -> Histogram:
"""Measures the duration of outbound RPC"""
return meter.create_histogram(
name=RPC_CLIENT_DURATION,
description="Measures the duration of outbound RPC.",
unit="ms",
)
RPC_CLIENT_REQUEST_SIZE: Final = "rpc.client.request.size"
"""
Measures the size of RPC request messages (uncompressed)
Instrument: histogram
Unit: By
Note: **Streaming**: Recorded per message in a streaming batch.
"""
def create_rpc_client_request_size(meter: Meter) -> Histogram:
"""Measures the size of RPC request messages (uncompressed)"""
return meter.create_histogram(
name=RPC_CLIENT_REQUEST_SIZE,
description="Measures the size of RPC request messages (uncompressed).",
unit="By",
)
RPC_CLIENT_REQUESTS_PER_RPC: Final = "rpc.client.requests_per_rpc"
"""
Measures the number of messages received per RPC
Instrument: histogram
Unit: {count}
Note: Should be 1 for all non-streaming RPCs.
**Streaming**: This metric is required for server and client streaming RPCs.
"""
def create_rpc_client_requests_per_rpc(meter: Meter) -> Histogram:
"""Measures the number of messages received per RPC"""
return meter.create_histogram(
name=RPC_CLIENT_REQUESTS_PER_RPC,
description="Measures the number of messages received per RPC.",
unit="{count}",
)
RPC_CLIENT_RESPONSE_SIZE: Final = "rpc.client.response.size"
"""
Measures the size of RPC response messages (uncompressed)
Instrument: histogram
Unit: By
Note: **Streaming**: Recorded per response in a streaming batch.
"""
def create_rpc_client_response_size(meter: Meter) -> Histogram:
"""Measures the size of RPC response messages (uncompressed)"""
return meter.create_histogram(
name=RPC_CLIENT_RESPONSE_SIZE,
description="Measures the size of RPC response messages (uncompressed).",
unit="By",
)
RPC_CLIENT_RESPONSES_PER_RPC: Final = "rpc.client.responses_per_rpc"
"""
Measures the number of messages sent per RPC
Instrument: histogram
Unit: {count}
Note: Should be 1 for all non-streaming RPCs.
**Streaming**: This metric is required for server and client streaming RPCs.
"""
def create_rpc_client_responses_per_rpc(meter: Meter) -> Histogram:
"""Measures the number of messages sent per RPC"""
return meter.create_histogram(
name=RPC_CLIENT_RESPONSES_PER_RPC,
description="Measures the number of messages sent per RPC.",
unit="{count}",
)
RPC_SERVER_DURATION: Final = "rpc.server.duration"
"""
Measures the duration of inbound RPC
Instrument: histogram
Unit: ms
Note: While streaming RPCs may record this metric as start-of-batch
to end-of-batch, it's hard to interpret in practice.
**Streaming**: N/A.
"""
def create_rpc_server_duration(meter: Meter) -> Histogram:
"""Measures the duration of inbound RPC"""
return meter.create_histogram(
name=RPC_SERVER_DURATION,
description="Measures the duration of inbound RPC.",
unit="ms",
)
RPC_SERVER_REQUEST_SIZE: Final = "rpc.server.request.size"
"""
Measures the size of RPC request messages (uncompressed)
Instrument: histogram
Unit: By
Note: **Streaming**: Recorded per message in a streaming batch.
"""
def create_rpc_server_request_size(meter: Meter) -> Histogram:
"""Measures the size of RPC request messages (uncompressed)"""
return meter.create_histogram(
name=RPC_SERVER_REQUEST_SIZE,
description="Measures the size of RPC request messages (uncompressed).",
unit="By",
)
RPC_SERVER_REQUESTS_PER_RPC: Final = "rpc.server.requests_per_rpc"
"""
Measures the number of messages received per RPC
Instrument: histogram
Unit: {count}
Note: Should be 1 for all non-streaming RPCs.
**Streaming** : This metric is required for server and client streaming RPCs.
"""
def create_rpc_server_requests_per_rpc(meter: Meter) -> Histogram:
"""Measures the number of messages received per RPC"""
return meter.create_histogram(
name=RPC_SERVER_REQUESTS_PER_RPC,
description="Measures the number of messages received per RPC.",
unit="{count}",
)
RPC_SERVER_RESPONSE_SIZE: Final = "rpc.server.response.size"
"""
Measures the size of RPC response messages (uncompressed)
Instrument: histogram
Unit: By
Note: **Streaming**: Recorded per response in a streaming batch.
"""
def create_rpc_server_response_size(meter: Meter) -> Histogram:
"""Measures the size of RPC response messages (uncompressed)"""
return meter.create_histogram(
name=RPC_SERVER_RESPONSE_SIZE,
description="Measures the size of RPC response messages (uncompressed).",
unit="By",
)
RPC_SERVER_RESPONSES_PER_RPC: Final = "rpc.server.responses_per_rpc"
"""
Measures the number of messages sent per RPC
Instrument: histogram
Unit: {count}
Note: Should be 1 for all non-streaming RPCs.
**Streaming**: This metric is required for server and client streaming RPCs.
"""
def create_rpc_server_responses_per_rpc(meter: Meter) -> Histogram:
"""Measures the number of messages sent per RPC"""
return meter.create_histogram(
name=RPC_SERVER_RESPONSES_PER_RPC,
description="Measures the number of messages sent per RPC.",
unit="{count}",
)
|
