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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="logging_v2.html">Stackdriver Logging API</a> . <a href="logging_v2.projects.html">projects</a> . <a href="logging_v2.projects.metrics.html">metrics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a logs-based metric.</p>
<p class="toc_element">
<code><a href="#delete">delete(metricName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a logs-based metric.</p>
<p class="toc_element">
<code><a href="#get">get(metricName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a logs-based metric.</p>
<p class="toc_element">
<code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists logs-based metrics.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(metricName=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates a logs-based metric.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
<pre>Creates a logs-based metric.
Args:
parent: string, The resource name of the project in which to create the metric.
Example: `"projects/my-project-id"`.
The new metric must be provided in the request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes a logs-based metric. The value of the metric is the
# number of log entries that match a logs filter.
"filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Example: `"resource.type=gae_app AND severity>=ERROR"`.
"version": "A String", # Output only. The API version that created or updated this metric.
# The version also dictates the syntax of the filter expression. When a value
# for this field is missing, the default value of V2 should be assumed.
"description": "A String", # Optional. A description of this metric, which is used in documentation.
"name": "A String", # Required. The client-assigned metric identifier. Example:
# `"severe_errors"`. Metric identifiers are limited to 100
# characters and can include only the following characters: `A-Z`,
# `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
# forward-slash character (`/`) denotes a hierarchy of name pieces,
# and it cannot be the first character of the name. The '%' character
# is used to URL encode unsafe and reserved characters and must be
# followed by two hexadecimal digits according to RFC 1738.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes a logs-based metric. The value of the metric is the
# number of log entries that match a logs filter.
"filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Example: `"resource.type=gae_app AND severity>=ERROR"`.
"version": "A String", # Output only. The API version that created or updated this metric.
# The version also dictates the syntax of the filter expression. When a value
# for this field is missing, the default value of V2 should be assumed.
"description": "A String", # Optional. A description of this metric, which is used in documentation.
"name": "A String", # Required. The client-assigned metric identifier. Example:
# `"severe_errors"`. Metric identifiers are limited to 100
# characters and can include only the following characters: `A-Z`,
# `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
# forward-slash character (`/`) denotes a hierarchy of name pieces,
# and it cannot be the first character of the name. The '%' character
# is used to URL encode unsafe and reserved characters and must be
# followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(metricName=None, x__xgafv=None)</code>
<pre>Deletes a logs-based metric.
Args:
metricName: string, The resource name of the metric to delete.
Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(metricName=None, x__xgafv=None)</code>
<pre>Gets a logs-based metric.
Args:
metricName: string, The resource name of the desired metric.
Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes a logs-based metric. The value of the metric is the
# number of log entries that match a logs filter.
"filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Example: `"resource.type=gae_app AND severity>=ERROR"`.
"version": "A String", # Output only. The API version that created or updated this metric.
# The version also dictates the syntax of the filter expression. When a value
# for this field is missing, the default value of V2 should be assumed.
"description": "A String", # Optional. A description of this metric, which is used in documentation.
"name": "A String", # Required. The client-assigned metric identifier. Example:
# `"severe_errors"`. Metric identifiers are limited to 100
# characters and can include only the following characters: `A-Z`,
# `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
# forward-slash character (`/`) denotes a hierarchy of name pieces,
# and it cannot be the first character of the name. The '%' character
# is used to URL encode unsafe and reserved characters and must be
# followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists logs-based metrics.
Args:
parent: string, Required. The resource name containing the metrics.
Example: `"projects/my-project-id"`. (required)
pageToken: string, Optional. If present, then retrieve the next batch of results from the
preceding call to this method. `pageToken` must be the value of
`nextPageToken` from the previous response. The values of other method
parameters should be identical to those in the previous call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
pageSize: integer, Optional. The maximum number of results to return from this request.
Non-positive values are ignored. The presence of `nextPageToken` in the
response indicates that more results might be available.
Returns:
An object of the form:
{ # Result returned from ListLogMetrics.
"metrics": [ # A list of logs-based metrics.
{ # Describes a logs-based metric. The value of the metric is the
# number of log entries that match a logs filter.
"filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Example: `"resource.type=gae_app AND severity>=ERROR"`.
"version": "A String", # Output only. The API version that created or updated this metric.
# The version also dictates the syntax of the filter expression. When a value
# for this field is missing, the default value of V2 should be assumed.
"description": "A String", # Optional. A description of this metric, which is used in documentation.
"name": "A String", # Required. The client-assigned metric identifier. Example:
# `"severe_errors"`. Metric identifiers are limited to 100
# characters and can include only the following characters: `A-Z`,
# `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
# forward-slash character (`/`) denotes a hierarchy of name pieces,
# and it cannot be the first character of the name. The '%' character
# is used to URL encode unsafe and reserved characters and must be
# followed by two hexadecimal digits according to RFC 1738.
},
],
"nextPageToken": "A String", # If there might be more results than appear in this response, then
# `nextPageToken` is included. To get the next set of results, call this
# method again using the value of `nextPageToken` as `pageToken`.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(metricName=None, body, x__xgafv=None)</code>
<pre>Creates or updates a logs-based metric.
Args:
metricName: string, The resource name of the metric to update.
Example: `"projects/my-project-id/metrics/my-metric-id"`.
The updated metric must be provided in the request and have the
same identifier that is specified in `metricName`.
If the metric does not exist, it is created. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes a logs-based metric. The value of the metric is the
# number of log entries that match a logs filter.
"filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Example: `"resource.type=gae_app AND severity>=ERROR"`.
"version": "A String", # Output only. The API version that created or updated this metric.
# The version also dictates the syntax of the filter expression. When a value
# for this field is missing, the default value of V2 should be assumed.
"description": "A String", # Optional. A description of this metric, which is used in documentation.
"name": "A String", # Required. The client-assigned metric identifier. Example:
# `"severe_errors"`. Metric identifiers are limited to 100
# characters and can include only the following characters: `A-Z`,
# `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
# forward-slash character (`/`) denotes a hierarchy of name pieces,
# and it cannot be the first character of the name. The '%' character
# is used to URL encode unsafe and reserved characters and must be
# followed by two hexadecimal digits according to RFC 1738.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes a logs-based metric. The value of the metric is the
# number of log entries that match a logs filter.
"filter": "A String", # Required. An [advanced logs filter](/logging/docs/view/advanced_filters).
# Example: `"resource.type=gae_app AND severity>=ERROR"`.
"version": "A String", # Output only. The API version that created or updated this metric.
# The version also dictates the syntax of the filter expression. When a value
# for this field is missing, the default value of V2 should be assumed.
"description": "A String", # Optional. A description of this metric, which is used in documentation.
"name": "A String", # Required. The client-assigned metric identifier. Example:
# `"severe_errors"`. Metric identifiers are limited to 100
# characters and can include only the following characters: `A-Z`,
# `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`. The
# forward-slash character (`/`) denotes a hierarchy of name pieces,
# and it cannot be the first character of the name. The '%' character
# is used to URL encode unsafe and reserved characters and must be
# followed by two hexadecimal digits according to RFC 1738.
}</pre>
</div>
</body></html>
|
