google-cloud-trace 0.33.4 → 0.33.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/INSTRUMENTATION.md +2 -2
- data/LOGGING.md +1 -1
- data/lib/google-cloud-trace.rb +1 -1
- data/lib/google/cloud/trace/middleware.rb +1 -1
- data/lib/google/cloud/trace/rails.rb +1 -1
- data/lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb +61 -61
- data/lib/google/cloud/trace/v1/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/trace/v1/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/trace/v1/trace_service_client.rb +31 -31
- data/lib/google/cloud/trace/v2.rb +3 -3
- data/lib/google/cloud/trace/v2/doc/google/devtools/cloudtrace/v2/trace.rb +11 -11
- data/lib/google/cloud/trace/v2/doc/google/devtools/cloudtrace/v2/tracing.rb +2 -2
- data/lib/google/cloud/trace/v2/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/trace/v2/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/trace/v2/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/trace/v2/doc/google/protobuf/wrappers.rb +18 -18
- data/lib/google/cloud/trace/v2/doc/google/rpc/status.rb +11 -11
- data/lib/google/cloud/trace/v2/trace_service_client.rb +6 -6
- data/lib/google/cloud/trace/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a053023315b4308b58d7f98e844ba3d5d5c76c96e5f2b0c24ee40377f10dc7f7
|
|
4
|
+
data.tar.gz: 6b4d460e51fdd5dc64557e7d5c7e61eed24f5263ee9232e3008038648d5d593f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 968cd17f9ead63a8ab8793fb5f6b4ae937853d0b5ecb0d1957496f7f6f29ff4acd54f993c47e43a77e8de2825ab3aa113e14eb5c74feb339988632177171a132
|
|
7
|
+
data.tar.gz: 558f0b31880051ea70e1b778dabc206d04770bc8641fefeb70a41de15fc42129f76b4e4b0a9a8850e072f05f1931c430a642eaf5e5f778dec192186148e48f28
|
data/CHANGELOG.md
CHANGED
data/INSTRUMENTATION.md
CHANGED
|
@@ -16,7 +16,7 @@ you want to run on a non Google Cloud environment or you want to customize the
|
|
|
16
16
|
default behavior.
|
|
17
17
|
|
|
18
18
|
See the [Configuration
|
|
19
|
-
Guide](https://
|
|
19
|
+
Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
|
|
20
20
|
for full configuration parameters.
|
|
21
21
|
|
|
22
22
|
## Rails Integration
|
|
@@ -29,7 +29,7 @@ require "google/cloud/trace/rails"
|
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
Alternatively, check out the
|
|
32
|
-
[stackdriver](https://
|
|
32
|
+
[stackdriver](https://googleapis.github.io/google-cloud-ruby/#/docs/stackdriver)
|
|
33
33
|
gem, which enables this Railtie by default.
|
|
34
34
|
|
|
35
35
|
## Rack Integration
|
data/LOGGING.md
CHANGED
|
@@ -5,7 +5,7 @@ To enable logging for this library, set the logger for the underlying
|
|
|
5
5
|
that you set may be a Ruby stdlib
|
|
6
6
|
[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
|
|
7
7
|
shown below, or a
|
|
8
|
-
[`Google::Cloud::Logging::Logger`](https://
|
|
8
|
+
[`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
|
|
9
9
|
that will write logs to [Stackdriver
|
|
10
10
|
Logging](https://cloud.google.com/logging/). See
|
|
11
11
|
[grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
data/lib/google-cloud-trace.rb
CHANGED
|
@@ -118,7 +118,7 @@ module Google
|
|
|
118
118
|
# @param [Hash] kwargs Hash of configuration settings. Used for backward
|
|
119
119
|
# API compatibility. See the {file:INSTRUMENTATION.md Instrumentation
|
|
120
120
|
# Guide} and [Configuration
|
|
121
|
-
# Guide](https://
|
|
121
|
+
# Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
|
|
122
122
|
# for the prefered way to set configuration parameters.
|
|
123
123
|
#
|
|
124
124
|
def initialize app, service: nil, **kwargs
|
|
@@ -46,7 +46,7 @@ module Google
|
|
|
46
46
|
#
|
|
47
47
|
# See the {file:INSTRUMENTATION.md Instrumentation Guide} and
|
|
48
48
|
# [Configuration
|
|
49
|
-
# Guide](https://
|
|
49
|
+
# Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
|
|
50
50
|
# on how to configure the Railtie and Middleware.
|
|
51
51
|
#
|
|
52
52
|
# ## Measuring custom functionality
|
|
@@ -50,8 +50,8 @@ module Google
|
|
|
50
50
|
# @!attribute [rw] kind
|
|
51
51
|
# @return [Google::Devtools::Cloudtrace::V1::TraceSpan::SpanKind]
|
|
52
52
|
# Distinguishes between spans generated in a particular context. For example,
|
|
53
|
-
# two spans with the same name may be distinguished using
|
|
54
|
-
# and
|
|
53
|
+
# two spans with the same name may be distinguished using `RPC_CLIENT`
|
|
54
|
+
# and `RPC_SERVER` to identify queueing latency associated with the span.
|
|
55
55
|
# @!attribute [rw] name
|
|
56
56
|
# @return [String]
|
|
57
57
|
# Name of the span. Must be less than 128 bytes. The span name is sanitized
|
|
@@ -74,39 +74,39 @@ module Google
|
|
|
74
74
|
# @return [Hash{String => String}]
|
|
75
75
|
# Collection of labels associated with the span. Label keys must be less than
|
|
76
76
|
# 128 bytes. Label values must be less than 16 kilobytes (10MB for
|
|
77
|
-
#
|
|
77
|
+
# `/stacktrace` values).
|
|
78
78
|
#
|
|
79
79
|
# Some predefined label keys exist, or you may create your own. When creating
|
|
80
80
|
# your own, we recommend the following formats:
|
|
81
81
|
#
|
|
82
|
-
# *
|
|
83
|
-
#
|
|
84
|
-
# *
|
|
85
|
-
#
|
|
82
|
+
# * `/category/product/key` for agents of well-known products (e.g.
|
|
83
|
+
# `/db/mongodb/read_size`).
|
|
84
|
+
# * `short_host/path/key` for domain-specific keys (e.g.
|
|
85
|
+
# `foo.com/myproduct/bar`)
|
|
86
86
|
#
|
|
87
87
|
# Predefined labels include:
|
|
88
88
|
#
|
|
89
|
-
# *
|
|
90
|
-
# *
|
|
91
|
-
# *
|
|
92
|
-
# *
|
|
93
|
-
# *
|
|
94
|
-
# *
|
|
95
|
-
# *
|
|
96
|
-
# *
|
|
97
|
-
# *
|
|
98
|
-
# *
|
|
99
|
-
# *
|
|
100
|
-
# *
|
|
101
|
-
# *
|
|
102
|
-
# *
|
|
103
|
-
# *
|
|
104
|
-
# *
|
|
105
|
-
# *
|
|
106
|
-
# *
|
|
107
|
-
# *
|
|
108
|
-
# *
|
|
109
|
-
# *
|
|
89
|
+
# * `/agent`
|
|
90
|
+
# * `/component`
|
|
91
|
+
# * `/error/message`
|
|
92
|
+
# * `/error/name`
|
|
93
|
+
# * `/http/client_city`
|
|
94
|
+
# * `/http/client_country`
|
|
95
|
+
# * `/http/client_protocol`
|
|
96
|
+
# * `/http/client_region`
|
|
97
|
+
# * `/http/host`
|
|
98
|
+
# * `/http/method`
|
|
99
|
+
# * `/http/path`
|
|
100
|
+
# * `/http/redirected_url`
|
|
101
|
+
# * `/http/request/size`
|
|
102
|
+
# * `/http/response/size`
|
|
103
|
+
# * `/http/route`
|
|
104
|
+
# * `/http/status_code`
|
|
105
|
+
# * `/http/url`
|
|
106
|
+
# * `/http/user_agent`
|
|
107
|
+
# * `/pid`
|
|
108
|
+
# * `/stacktrace`
|
|
109
|
+
# * `/tid`
|
|
110
110
|
class TraceSpan
|
|
111
111
|
# Type of span. Can be used to specify additional relationships between spans
|
|
112
112
|
# in addition to a parent/child relationship.
|
|
@@ -124,7 +124,7 @@ module Google
|
|
|
124
124
|
end
|
|
125
125
|
end
|
|
126
126
|
|
|
127
|
-
# The request message for the
|
|
127
|
+
# The request message for the `ListTraces` method. All fields are required
|
|
128
128
|
# unless specified.
|
|
129
129
|
# @!attribute [rw] project_id
|
|
130
130
|
# @return [String]
|
|
@@ -132,7 +132,7 @@ module Google
|
|
|
132
132
|
# @!attribute [rw] view
|
|
133
133
|
# @return [Google::Devtools::Cloudtrace::V1::ListTracesRequest::ViewType]
|
|
134
134
|
# Type of data returned for traces in the list. Optional. Default is
|
|
135
|
-
#
|
|
135
|
+
# `MINIMAL`.
|
|
136
136
|
# @!attribute [rw] page_size
|
|
137
137
|
# @return [Integer]
|
|
138
138
|
# Maximum number of traces to return. If not specified or <= 0, the
|
|
@@ -141,7 +141,7 @@ module Google
|
|
|
141
141
|
# @!attribute [rw] page_token
|
|
142
142
|
# @return [String]
|
|
143
143
|
# Token identifying the page of results to return. If provided, use the
|
|
144
|
-
# value of the
|
|
144
|
+
# value of the `next_page_token` field from a previous request. Optional.
|
|
145
145
|
# @!attribute [rw] start_time
|
|
146
146
|
# @return [Google::Protobuf::Timestamp]
|
|
147
147
|
# Start of the time interval (inclusive) during which the trace data was
|
|
@@ -155,52 +155,52 @@ module Google
|
|
|
155
155
|
# An optional filter against labels for the request.
|
|
156
156
|
#
|
|
157
157
|
# By default, searches use prefix matching. To specify exact match, prepend
|
|
158
|
-
# a plus symbol (
|
|
158
|
+
# a plus symbol (`+`) to the search term.
|
|
159
159
|
# Multiple terms are ANDed. Syntax:
|
|
160
160
|
#
|
|
161
|
-
# *
|
|
162
|
-
# span starts with
|
|
163
|
-
# *
|
|
164
|
-
# exactly
|
|
165
|
-
# *
|
|
166
|
-
#
|
|
167
|
-
# *
|
|
168
|
-
#
|
|
169
|
-
# *
|
|
170
|
-
# greater or equal to than
|
|
171
|
-
# (
|
|
172
|
-
# example,
|
|
161
|
+
# * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root
|
|
162
|
+
# span starts with `NAME_PREFIX`.
|
|
163
|
+
# * `+root:NAME` or `+NAME`: Return traces where any root span's name is
|
|
164
|
+
# exactly `NAME`.
|
|
165
|
+
# * `span:NAME_PREFIX`: Return traces where any span starts with
|
|
166
|
+
# `NAME_PREFIX`.
|
|
167
|
+
# * `+span:NAME`: Return traces where any span's name is exactly
|
|
168
|
+
# `NAME`.
|
|
169
|
+
# * `latency:DURATION`: Return traces whose overall latency is
|
|
170
|
+
# greater or equal to than `DURATION`. Accepted units are nanoseconds
|
|
171
|
+
# (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For
|
|
172
|
+
# example, `latency:24ms` returns traces whose overall latency
|
|
173
173
|
# is greater than or equal to 24 milliseconds.
|
|
174
|
-
# *
|
|
174
|
+
# * `label:LABEL_KEY`: Return all traces containing the specified
|
|
175
175
|
# label key (exact match, case-sensitive) regardless of the key:value
|
|
176
176
|
# pair's value (including empty values).
|
|
177
|
-
# *
|
|
177
|
+
# * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified
|
|
178
178
|
# label key (exact match, case-sensitive) whose value starts with
|
|
179
|
-
#
|
|
180
|
-
# *
|
|
179
|
+
# `VALUE_PREFIX`. Both a key and a value must be specified.
|
|
180
|
+
# * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair
|
|
181
181
|
# exactly matching the specified text. Both a key and a value must be
|
|
182
182
|
# specified.
|
|
183
|
-
# *
|
|
184
|
-
# *
|
|
183
|
+
# * `method:VALUE`: Equivalent to `/http/method:VALUE`.
|
|
184
|
+
# * `url:VALUE`: Equivalent to `/http/url:VALUE`.
|
|
185
185
|
# @!attribute [rw] order_by
|
|
186
186
|
# @return [String]
|
|
187
187
|
# Field used to sort the returned traces. Optional.
|
|
188
188
|
# Can be one of the following:
|
|
189
189
|
#
|
|
190
|
-
# *
|
|
191
|
-
# *
|
|
192
|
-
# *
|
|
190
|
+
# * `trace_id`
|
|
191
|
+
# * `name` (`name` field of root span in the trace)
|
|
192
|
+
# * `duration` (difference between `end_time` and `start_time` fields of
|
|
193
193
|
# the root span)
|
|
194
|
-
# *
|
|
194
|
+
# * `start` (`start_time` field of the root span)
|
|
195
195
|
#
|
|
196
|
-
# Descending order can be specified by appending
|
|
197
|
-
# (for example,
|
|
196
|
+
# Descending order can be specified by appending `desc` to the sort field
|
|
197
|
+
# (for example, `name desc`).
|
|
198
198
|
#
|
|
199
199
|
# Only one sort field is permitted.
|
|
200
200
|
class ListTracesRequest
|
|
201
201
|
# Type of data returned for traces in the list.
|
|
202
202
|
module ViewType
|
|
203
|
-
# Default is
|
|
203
|
+
# Default is `MINIMAL` if unspecified.
|
|
204
204
|
VIEW_TYPE_UNSPECIFIED = 0
|
|
205
205
|
|
|
206
206
|
# Minimal view of the trace record that contains only the project
|
|
@@ -212,13 +212,13 @@ module Google
|
|
|
212
212
|
ROOTSPAN = 2
|
|
213
213
|
|
|
214
214
|
# Complete view of the trace record that contains the actual trace data.
|
|
215
|
-
# This is equivalent to calling the REST
|
|
215
|
+
# This is equivalent to calling the REST `get` or RPC `GetTrace` method
|
|
216
216
|
# using the ID of each listed trace.
|
|
217
217
|
COMPLETE = 3
|
|
218
218
|
end
|
|
219
219
|
end
|
|
220
220
|
|
|
221
|
-
# The response message for the
|
|
221
|
+
# The response message for the `ListTraces` method.
|
|
222
222
|
# @!attribute [rw] traces
|
|
223
223
|
# @return [Array<Google::Devtools::Cloudtrace::V1::Trace>]
|
|
224
224
|
# List of trace records returned.
|
|
@@ -229,7 +229,7 @@ module Google
|
|
|
229
229
|
# retrieving additional traces.
|
|
230
230
|
class ListTracesResponse; end
|
|
231
231
|
|
|
232
|
-
# The request message for the
|
|
232
|
+
# The request message for the `GetTrace` method.
|
|
233
233
|
# @!attribute [rw] project_id
|
|
234
234
|
# @return [String]
|
|
235
235
|
# ID of the Cloud project where the trace data is stored.
|
|
@@ -238,7 +238,7 @@ module Google
|
|
|
238
238
|
# ID of the trace to return.
|
|
239
239
|
class GetTraceRequest; end
|
|
240
240
|
|
|
241
|
-
# The request message for the
|
|
241
|
+
# The request message for the `PatchTraces` method.
|
|
242
242
|
# @!attribute [rw] project_id
|
|
243
243
|
# @return [String]
|
|
244
244
|
# ID of the Cloud project where the trace data is stored.
|
|
@@ -23,7 +23,7 @@ module Google
|
|
|
23
23
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
|
24
24
|
# }
|
|
25
25
|
#
|
|
26
|
-
# The JSON representation for
|
|
26
|
+
# The JSON representation for `Empty` is empty JSON object `{}`.
|
|
27
27
|
class Empty; end
|
|
28
28
|
end
|
|
29
29
|
end
|
|
@@ -29,13 +29,13 @@ module Google
|
|
|
29
29
|
#
|
|
30
30
|
# = Examples
|
|
31
31
|
#
|
|
32
|
-
# Example 1: Compute Timestamp from POSIX
|
|
32
|
+
# Example 1: Compute Timestamp from POSIX `time()`.
|
|
33
33
|
#
|
|
34
34
|
# Timestamp timestamp;
|
|
35
35
|
# timestamp.set_seconds(time(NULL));
|
|
36
36
|
# timestamp.set_nanos(0);
|
|
37
37
|
#
|
|
38
|
-
# Example 2: Compute Timestamp from POSIX
|
|
38
|
+
# Example 2: Compute Timestamp from POSIX `gettimeofday()`.
|
|
39
39
|
#
|
|
40
40
|
# struct timeval tv;
|
|
41
41
|
# gettimeofday(&tv, NULL);
|
|
@@ -44,7 +44,7 @@ module Google
|
|
|
44
44
|
# timestamp.set_seconds(tv.tv_sec);
|
|
45
45
|
# timestamp.set_nanos(tv.tv_usec * 1000);
|
|
46
46
|
#
|
|
47
|
-
# Example 3: Compute Timestamp from Win32
|
|
47
|
+
# Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
|
|
48
48
|
#
|
|
49
49
|
# FILETIME ft;
|
|
50
50
|
# GetSystemTimeAsFileTime(&ft);
|
|
@@ -56,7 +56,7 @@ module Google
|
|
|
56
56
|
# timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
|
|
57
57
|
# timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
|
|
58
58
|
#
|
|
59
|
-
# Example 4: Compute Timestamp from Java
|
|
59
|
+
# Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
|
|
60
60
|
#
|
|
61
61
|
# long millis = System.currentTimeMillis();
|
|
62
62
|
#
|
|
@@ -87,10 +87,10 @@ module Google
|
|
|
87
87
|
#
|
|
88
88
|
# In JavaScript, one can convert a Date object to this format using the
|
|
89
89
|
# standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
|
|
90
|
-
# method. In Python, a standard
|
|
91
|
-
# to this format using [
|
|
90
|
+
# method. In Python, a standard `datetime.datetime` object can be converted
|
|
91
|
+
# to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
|
|
92
92
|
# with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
|
|
93
|
-
# can use the Joda Time's [
|
|
93
|
+
# can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
|
94
94
|
# http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
|
|
95
95
|
# ) to obtain a formatter capable of generating timestamps in this format.
|
|
96
96
|
# @!attribute [rw] seconds
|
|
@@ -219,10 +219,10 @@ module Google
|
|
|
219
219
|
#
|
|
220
220
|
# trace_service_client = Google::Cloud::Trace.new(version: :v1)
|
|
221
221
|
#
|
|
222
|
-
# # TODO: Initialize
|
|
222
|
+
# # TODO: Initialize `project_id`:
|
|
223
223
|
# project_id = ''
|
|
224
224
|
#
|
|
225
|
-
# # TODO: Initialize
|
|
225
|
+
# # TODO: Initialize `traces`:
|
|
226
226
|
# traces = {}
|
|
227
227
|
# trace_service_client.patch_traces(project_id, traces)
|
|
228
228
|
|
|
@@ -259,10 +259,10 @@ module Google
|
|
|
259
259
|
#
|
|
260
260
|
# trace_service_client = Google::Cloud::Trace.new(version: :v1)
|
|
261
261
|
#
|
|
262
|
-
# # TODO: Initialize
|
|
262
|
+
# # TODO: Initialize `project_id`:
|
|
263
263
|
# project_id = ''
|
|
264
264
|
#
|
|
265
|
-
# # TODO: Initialize
|
|
265
|
+
# # TODO: Initialize `trace_id`:
|
|
266
266
|
# trace_id = ''
|
|
267
267
|
# response = trace_service_client.get_trace(project_id, trace_id)
|
|
268
268
|
|
|
@@ -285,7 +285,7 @@ module Google
|
|
|
285
285
|
# ID of the Cloud project where the trace data is stored.
|
|
286
286
|
# @param view [Google::Devtools::Cloudtrace::V1::ListTracesRequest::ViewType]
|
|
287
287
|
# Type of data returned for traces in the list. Optional. Default is
|
|
288
|
-
#
|
|
288
|
+
# `MINIMAL`.
|
|
289
289
|
# @param page_size [Integer]
|
|
290
290
|
# Maximum number of traces to return. If not specified or <= 0, the
|
|
291
291
|
# implementation selects a reasonable value. The implementation may
|
|
@@ -304,45 +304,45 @@ module Google
|
|
|
304
304
|
# An optional filter against labels for the request.
|
|
305
305
|
#
|
|
306
306
|
# By default, searches use prefix matching. To specify exact match, prepend
|
|
307
|
-
# a plus symbol (
|
|
307
|
+
# a plus symbol (`+`) to the search term.
|
|
308
308
|
# Multiple terms are ANDed. Syntax:
|
|
309
309
|
#
|
|
310
|
-
# *
|
|
311
|
-
# span starts with
|
|
312
|
-
# *
|
|
313
|
-
# exactly
|
|
314
|
-
# *
|
|
315
|
-
#
|
|
316
|
-
# *
|
|
317
|
-
#
|
|
318
|
-
# *
|
|
319
|
-
# greater or equal to than
|
|
320
|
-
# (
|
|
321
|
-
# example,
|
|
310
|
+
# * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root
|
|
311
|
+
# span starts with `NAME_PREFIX`.
|
|
312
|
+
# * `+root:NAME` or `+NAME`: Return traces where any root span's name is
|
|
313
|
+
# exactly `NAME`.
|
|
314
|
+
# * `span:NAME_PREFIX`: Return traces where any span starts with
|
|
315
|
+
# `NAME_PREFIX`.
|
|
316
|
+
# * `+span:NAME`: Return traces where any span's name is exactly
|
|
317
|
+
# `NAME`.
|
|
318
|
+
# * `latency:DURATION`: Return traces whose overall latency is
|
|
319
|
+
# greater or equal to than `DURATION`. Accepted units are nanoseconds
|
|
320
|
+
# (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For
|
|
321
|
+
# example, `latency:24ms` returns traces whose overall latency
|
|
322
322
|
# is greater than or equal to 24 milliseconds.
|
|
323
|
-
# *
|
|
323
|
+
# * `label:LABEL_KEY`: Return all traces containing the specified
|
|
324
324
|
# label key (exact match, case-sensitive) regardless of the key:value
|
|
325
325
|
# pair's value (including empty values).
|
|
326
|
-
# *
|
|
326
|
+
# * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified
|
|
327
327
|
# label key (exact match, case-sensitive) whose value starts with
|
|
328
|
-
#
|
|
329
|
-
# *
|
|
328
|
+
# `VALUE_PREFIX`. Both a key and a value must be specified.
|
|
329
|
+
# * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair
|
|
330
330
|
# exactly matching the specified text. Both a key and a value must be
|
|
331
331
|
# specified.
|
|
332
|
-
# *
|
|
333
|
-
# *
|
|
332
|
+
# * `method:VALUE`: Equivalent to `/http/method:VALUE`.
|
|
333
|
+
# * `url:VALUE`: Equivalent to `/http/url:VALUE`.
|
|
334
334
|
# @param order_by [String]
|
|
335
335
|
# Field used to sort the returned traces. Optional.
|
|
336
336
|
# Can be one of the following:
|
|
337
337
|
#
|
|
338
|
-
# *
|
|
339
|
-
# *
|
|
340
|
-
# *
|
|
338
|
+
# * `trace_id`
|
|
339
|
+
# * `name` (`name` field of root span in the trace)
|
|
340
|
+
# * `duration` (difference between `end_time` and `start_time` fields of
|
|
341
341
|
# the root span)
|
|
342
|
-
# *
|
|
342
|
+
# * `start` (`start_time` field of the root span)
|
|
343
343
|
#
|
|
344
|
-
# Descending order can be specified by appending
|
|
345
|
-
# (for example,
|
|
344
|
+
# Descending order can be specified by appending `desc` to the sort field
|
|
345
|
+
# (for example, `name desc`).
|
|
346
346
|
#
|
|
347
347
|
# Only one sort field is permitted.
|
|
348
348
|
# @param options [Google::Gax::CallOptions]
|
|
@@ -362,7 +362,7 @@ module Google
|
|
|
362
362
|
#
|
|
363
363
|
# trace_service_client = Google::Cloud::Trace.new(version: :v1)
|
|
364
364
|
#
|
|
365
|
-
# # TODO: Initialize
|
|
365
|
+
# # TODO: Initialize `project_id`:
|
|
366
366
|
# project_id = ''
|
|
367
367
|
#
|
|
368
368
|
# # Iterate over all results.
|
|
@@ -20,7 +20,7 @@ module Google
|
|
|
20
20
|
# rubocop:disable LineLength
|
|
21
21
|
|
|
22
22
|
##
|
|
23
|
-
# # Ruby Client for Stackdriver Trace API ([Alpha](https://github.com/
|
|
23
|
+
# # Ruby Client for Stackdriver Trace API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
|
24
24
|
#
|
|
25
25
|
# [Stackdriver Trace API][Product Documentation]:
|
|
26
26
|
# Sends application trace data to Stackdriver Trace for viewing. Trace data is
|
|
@@ -35,7 +35,7 @@ module Google
|
|
|
35
35
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
|
36
36
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
|
37
37
|
# 3. [Enable the Stackdriver Trace API.](https://console.cloud.google.com/apis/api/trace)
|
|
38
|
-
# 4. [Setup Authentication.](https://
|
|
38
|
+
# 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
|
39
39
|
#
|
|
40
40
|
# ### Preview
|
|
41
41
|
# #### TraceServiceClient
|
|
@@ -51,7 +51,7 @@ module Google
|
|
|
51
51
|
# ### Next Steps
|
|
52
52
|
# - Read the [Stackdriver Trace API Product documentation][Product Documentation]
|
|
53
53
|
# to learn more about the product and see How-to Guides.
|
|
54
|
-
# - View this [repository's main README](https://github.com/
|
|
54
|
+
# - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
|
55
55
|
# to see the full list of Cloud APIs that we cover.
|
|
56
56
|
#
|
|
57
57
|
# [Product Documentation]: https://cloud.google.com/trace
|
|
@@ -88,12 +88,12 @@ module Google
|
|
|
88
88
|
# An optional number of child spans that were generated while this span
|
|
89
89
|
# was active. If set, allows implementation to detect missing child spans.
|
|
90
90
|
class Span
|
|
91
|
-
# A set of attributes, each in the format
|
|
91
|
+
# A set of attributes, each in the format `[KEY]:[VALUE]`.
|
|
92
92
|
# @!attribute [rw] attribute_map
|
|
93
93
|
# @return [Hash{String => Google::Devtools::Cloudtrace::V2::AttributeValue}]
|
|
94
94
|
# The set of attributes. Each attribute's key can be up to 128 bytes
|
|
95
95
|
# long. The value can be a string up to 256 bytes, an integer, or the
|
|
96
|
-
# Boolean values
|
|
96
|
+
# Boolean values `true` and `false`. For example:
|
|
97
97
|
#
|
|
98
98
|
# "/instance_id": "my-instance"
|
|
99
99
|
# "/http/user_agent": ""
|
|
@@ -160,12 +160,12 @@ module Google
|
|
|
160
160
|
end
|
|
161
161
|
end
|
|
162
162
|
|
|
163
|
-
# A collection of
|
|
163
|
+
# A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation
|
|
164
164
|
# on the span, consisting of either user-supplied key:value pairs, or
|
|
165
165
|
# details of a message sent/received between Spans.
|
|
166
166
|
# @!attribute [rw] time_event
|
|
167
167
|
# @return [Array<Google::Devtools::Cloudtrace::V2::Span::TimeEvent>]
|
|
168
|
-
# A collection of
|
|
168
|
+
# A collection of `TimeEvent`s.
|
|
169
169
|
# @!attribute [rw] dropped_annotations_count
|
|
170
170
|
# @return [Integer]
|
|
171
171
|
# The number of dropped annotations in all the included time events.
|
|
@@ -220,7 +220,7 @@ module Google
|
|
|
220
220
|
class Links; end
|
|
221
221
|
end
|
|
222
222
|
|
|
223
|
-
# The allowed types for [VALUE] in a
|
|
223
|
+
# The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
|
|
224
224
|
# @!attribute [rw] string_value
|
|
225
225
|
# @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
|
|
226
226
|
# A string up to 256 bytes long.
|
|
@@ -229,7 +229,7 @@ module Google
|
|
|
229
229
|
# A 64-bit signed integer.
|
|
230
230
|
# @!attribute [rw] bool_value
|
|
231
231
|
# @return [true, false]
|
|
232
|
-
# A Boolean value represented by
|
|
232
|
+
# A Boolean value represented by `true` or `false`.
|
|
233
233
|
class AttributeValue; end
|
|
234
234
|
|
|
235
235
|
# A call stack appearing in a trace.
|
|
@@ -243,10 +243,10 @@ module Google
|
|
|
243
243
|
#
|
|
244
244
|
# Often multiple spans will have identical stack traces.
|
|
245
245
|
# The first occurrence of a stack trace should contain both the
|
|
246
|
-
#
|
|
246
|
+
# `stackFrame` content and a value in `stackTraceHashId`.
|
|
247
247
|
#
|
|
248
248
|
# Subsequent spans within the same request can refer
|
|
249
|
-
# to that stack trace by only setting
|
|
249
|
+
# to that stack trace by only setting `stackTraceHashId`.
|
|
250
250
|
class StackTrace
|
|
251
251
|
# Represents a single stack frame in a stack trace.
|
|
252
252
|
# @!attribute [rw] function_name
|
|
@@ -255,7 +255,7 @@ module Google
|
|
|
255
255
|
# method that is active in this frame (up to 1024 bytes).
|
|
256
256
|
# @!attribute [rw] original_function_name
|
|
257
257
|
# @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
|
|
258
|
-
# An un-mangled function name, if
|
|
258
|
+
# An un-mangled function name, if `function_name` is
|
|
259
259
|
# [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can
|
|
260
260
|
# be fully-qualified (up to 1024 bytes).
|
|
261
261
|
# @!attribute [rw] file_name
|
|
@@ -264,7 +264,7 @@ module Google
|
|
|
264
264
|
# bytes).
|
|
265
265
|
# @!attribute [rw] line_number
|
|
266
266
|
# @return [Integer]
|
|
267
|
-
# The line number in
|
|
267
|
+
# The line number in `file_name` where the function call appears.
|
|
268
268
|
# @!attribute [rw] column_number
|
|
269
269
|
# @return [Integer]
|
|
270
270
|
# The column number where the function call appears, if available.
|
|
@@ -305,7 +305,7 @@ module Google
|
|
|
305
305
|
# @return [String]
|
|
306
306
|
# The shortened string. For example, if the original string is 500
|
|
307
307
|
# bytes long and the limit of the string is 128 bytes, then
|
|
308
|
-
#
|
|
308
|
+
# `value` contains the first 128 bytes of the 500-byte string.
|
|
309
309
|
#
|
|
310
310
|
# Truncation always happens on a UTF8 character boundary. If there
|
|
311
311
|
# are multi-byte characters in the string, then the length of the
|
|
@@ -17,11 +17,11 @@ module Google
|
|
|
17
17
|
module Devtools
|
|
18
18
|
module Cloudtrace
|
|
19
19
|
module V2
|
|
20
|
-
# The request message for the
|
|
20
|
+
# The request message for the `BatchWriteSpans` method.
|
|
21
21
|
# @!attribute [rw] name
|
|
22
22
|
# @return [String]
|
|
23
23
|
# Required. The name of the project where the spans belong. The format is
|
|
24
|
-
#
|
|
24
|
+
# `projects/[PROJECT_ID]`.
|
|
25
25
|
# @!attribute [rw] spans
|
|
26
26
|
# @return [Array<Google::Devtools::Cloudtrace::V2::Span>]
|
|
27
27
|
# A list of new spans. The span names must not match existing
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
module Google
|
|
17
17
|
module Protobuf
|
|
18
|
-
#
|
|
18
|
+
# `Any` contains an arbitrary serialized protocol buffer message along with a
|
|
19
19
|
# URL that describes the type of the serialized message.
|
|
20
20
|
#
|
|
21
21
|
# Protobuf library provides support to pack/unpack Any values in the form
|
|
@@ -69,9 +69,9 @@ module Google
|
|
|
69
69
|
#
|
|
70
70
|
# = JSON
|
|
71
71
|
#
|
|
72
|
-
# The JSON representation of an
|
|
72
|
+
# The JSON representation of an `Any` value uses the regular
|
|
73
73
|
# representation of the deserialized, embedded message, with an
|
|
74
|
-
# additional field
|
|
74
|
+
# additional field `@type` which contains the type URL. Example:
|
|
75
75
|
#
|
|
76
76
|
# package google.profile;
|
|
77
77
|
# message Person {
|
|
@@ -87,7 +87,7 @@ module Google
|
|
|
87
87
|
#
|
|
88
88
|
# If the embedded message type is well-known and has a custom JSON
|
|
89
89
|
# representation, that representation will be embedded adding a field
|
|
90
|
-
#
|
|
90
|
+
# `value` which holds the custom JSON in addition to the `@type`
|
|
91
91
|
# field. Example (for message {Google::Protobuf::Duration}):
|
|
92
92
|
#
|
|
93
93
|
# {
|
|
@@ -99,15 +99,15 @@ module Google
|
|
|
99
99
|
# A URL/resource name that uniquely identifies the type of the serialized
|
|
100
100
|
# protocol buffer message. The last segment of the URL's path must represent
|
|
101
101
|
# the fully qualified name of the type (as in
|
|
102
|
-
#
|
|
102
|
+
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
|
103
103
|
# (e.g., leading "." is not accepted).
|
|
104
104
|
#
|
|
105
105
|
# In practice, teams usually precompile into the binary all types that they
|
|
106
106
|
# expect it to use in the context of Any. However, for URLs which use the
|
|
107
|
-
# scheme
|
|
107
|
+
# scheme `http`, `https`, or no scheme, one can optionally set up a type
|
|
108
108
|
# server that maps type URLs to message definitions as follows:
|
|
109
109
|
#
|
|
110
|
-
# * If no scheme is provided,
|
|
110
|
+
# * If no scheme is provided, `https` is assumed.
|
|
111
111
|
# * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
|
|
112
112
|
# value in binary format, or produce an error.
|
|
113
113
|
# * Applications are allowed to cache lookup results based on the
|
|
@@ -120,7 +120,7 @@ module Google
|
|
|
120
120
|
# protobuf release, and it is not used for type URLs beginning with
|
|
121
121
|
# type.googleapis.com.
|
|
122
122
|
#
|
|
123
|
-
# Schemes other than
|
|
123
|
+
# Schemes other than `http`, `https` (or the empty scheme) might be
|
|
124
124
|
# used with implementation specific semantics.
|
|
125
125
|
# @!attribute [rw] value
|
|
126
126
|
# @return [String]
|
|
@@ -23,7 +23,7 @@ module Google
|
|
|
23
23
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
|
24
24
|
# }
|
|
25
25
|
#
|
|
26
|
-
# The JSON representation for
|
|
26
|
+
# The JSON representation for `Empty` is empty JSON object `{}`.
|
|
27
27
|
class Empty; end
|
|
28
28
|
end
|
|
29
29
|
end
|
|
@@ -29,13 +29,13 @@ module Google
|
|
|
29
29
|
#
|
|
30
30
|
# = Examples
|
|
31
31
|
#
|
|
32
|
-
# Example 1: Compute Timestamp from POSIX
|
|
32
|
+
# Example 1: Compute Timestamp from POSIX `time()`.
|
|
33
33
|
#
|
|
34
34
|
# Timestamp timestamp;
|
|
35
35
|
# timestamp.set_seconds(time(NULL));
|
|
36
36
|
# timestamp.set_nanos(0);
|
|
37
37
|
#
|
|
38
|
-
# Example 2: Compute Timestamp from POSIX
|
|
38
|
+
# Example 2: Compute Timestamp from POSIX `gettimeofday()`.
|
|
39
39
|
#
|
|
40
40
|
# struct timeval tv;
|
|
41
41
|
# gettimeofday(&tv, NULL);
|
|
@@ -44,7 +44,7 @@ module Google
|
|
|
44
44
|
# timestamp.set_seconds(tv.tv_sec);
|
|
45
45
|
# timestamp.set_nanos(tv.tv_usec * 1000);
|
|
46
46
|
#
|
|
47
|
-
# Example 3: Compute Timestamp from Win32
|
|
47
|
+
# Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
|
|
48
48
|
#
|
|
49
49
|
# FILETIME ft;
|
|
50
50
|
# GetSystemTimeAsFileTime(&ft);
|
|
@@ -56,7 +56,7 @@ module Google
|
|
|
56
56
|
# timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
|
|
57
57
|
# timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
|
|
58
58
|
#
|
|
59
|
-
# Example 4: Compute Timestamp from Java
|
|
59
|
+
# Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
|
|
60
60
|
#
|
|
61
61
|
# long millis = System.currentTimeMillis();
|
|
62
62
|
#
|
|
@@ -87,10 +87,10 @@ module Google
|
|
|
87
87
|
#
|
|
88
88
|
# In JavaScript, one can convert a Date object to this format using the
|
|
89
89
|
# standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
|
|
90
|
-
# method. In Python, a standard
|
|
91
|
-
# to this format using [
|
|
90
|
+
# method. In Python, a standard `datetime.datetime` object can be converted
|
|
91
|
+
# to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
|
|
92
92
|
# with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
|
|
93
|
-
# can use the Joda Time's [
|
|
93
|
+
# can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
|
94
94
|
# http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
|
|
95
95
|
# ) to obtain a formatter capable of generating timestamps in this format.
|
|
96
96
|
# @!attribute [rw] seconds
|
|
@@ -15,73 +15,73 @@
|
|
|
15
15
|
|
|
16
16
|
module Google
|
|
17
17
|
module Protobuf
|
|
18
|
-
# Wrapper message for
|
|
18
|
+
# Wrapper message for `double`.
|
|
19
19
|
#
|
|
20
|
-
# The JSON representation for
|
|
20
|
+
# The JSON representation for `DoubleValue` is JSON number.
|
|
21
21
|
# @!attribute [rw] value
|
|
22
22
|
# @return [Float]
|
|
23
23
|
# The double value.
|
|
24
24
|
class DoubleValue; end
|
|
25
25
|
|
|
26
|
-
# Wrapper message for
|
|
26
|
+
# Wrapper message for `float`.
|
|
27
27
|
#
|
|
28
|
-
# The JSON representation for
|
|
28
|
+
# The JSON representation for `FloatValue` is JSON number.
|
|
29
29
|
# @!attribute [rw] value
|
|
30
30
|
# @return [Float]
|
|
31
31
|
# The float value.
|
|
32
32
|
class FloatValue; end
|
|
33
33
|
|
|
34
|
-
# Wrapper message for
|
|
34
|
+
# Wrapper message for `int64`.
|
|
35
35
|
#
|
|
36
|
-
# The JSON representation for
|
|
36
|
+
# The JSON representation for `Int64Value` is JSON string.
|
|
37
37
|
# @!attribute [rw] value
|
|
38
38
|
# @return [Integer]
|
|
39
39
|
# The int64 value.
|
|
40
40
|
class Int64Value; end
|
|
41
41
|
|
|
42
|
-
# Wrapper message for
|
|
42
|
+
# Wrapper message for `uint64`.
|
|
43
43
|
#
|
|
44
|
-
# The JSON representation for
|
|
44
|
+
# The JSON representation for `UInt64Value` is JSON string.
|
|
45
45
|
# @!attribute [rw] value
|
|
46
46
|
# @return [Integer]
|
|
47
47
|
# The uint64 value.
|
|
48
48
|
class UInt64Value; end
|
|
49
49
|
|
|
50
|
-
# Wrapper message for
|
|
50
|
+
# Wrapper message for `int32`.
|
|
51
51
|
#
|
|
52
|
-
# The JSON representation for
|
|
52
|
+
# The JSON representation for `Int32Value` is JSON number.
|
|
53
53
|
# @!attribute [rw] value
|
|
54
54
|
# @return [Integer]
|
|
55
55
|
# The int32 value.
|
|
56
56
|
class Int32Value; end
|
|
57
57
|
|
|
58
|
-
# Wrapper message for
|
|
58
|
+
# Wrapper message for `uint32`.
|
|
59
59
|
#
|
|
60
|
-
# The JSON representation for
|
|
60
|
+
# The JSON representation for `UInt32Value` is JSON number.
|
|
61
61
|
# @!attribute [rw] value
|
|
62
62
|
# @return [Integer]
|
|
63
63
|
# The uint32 value.
|
|
64
64
|
class UInt32Value; end
|
|
65
65
|
|
|
66
|
-
# Wrapper message for
|
|
66
|
+
# Wrapper message for `bool`.
|
|
67
67
|
#
|
|
68
|
-
# The JSON representation for
|
|
68
|
+
# The JSON representation for `BoolValue` is JSON `true` and `false`.
|
|
69
69
|
# @!attribute [rw] value
|
|
70
70
|
# @return [true, false]
|
|
71
71
|
# The bool value.
|
|
72
72
|
class BoolValue; end
|
|
73
73
|
|
|
74
|
-
# Wrapper message for
|
|
74
|
+
# Wrapper message for `string`.
|
|
75
75
|
#
|
|
76
|
-
# The JSON representation for
|
|
76
|
+
# The JSON representation for `StringValue` is JSON string.
|
|
77
77
|
# @!attribute [rw] value
|
|
78
78
|
# @return [String]
|
|
79
79
|
# The string value.
|
|
80
80
|
class StringValue; end
|
|
81
81
|
|
|
82
|
-
# Wrapper message for
|
|
82
|
+
# Wrapper message for `bytes`.
|
|
83
83
|
#
|
|
84
|
-
# The JSON representation for
|
|
84
|
+
# The JSON representation for `BytesValue` is JSON string.
|
|
85
85
|
# @!attribute [rw] value
|
|
86
86
|
# @return [String]
|
|
87
87
|
# The bytes value.
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
module Google
|
|
17
17
|
module Rpc
|
|
18
|
-
# The
|
|
18
|
+
# The `Status` type defines a logical error model that is suitable for different
|
|
19
19
|
# programming environments, including REST APIs and RPC APIs. It is used by
|
|
20
20
|
# [gRPC](https://github.com/grpc). The error model is designed to be:
|
|
21
21
|
#
|
|
@@ -24,7 +24,7 @@ module Google
|
|
|
24
24
|
#
|
|
25
25
|
# = Overview
|
|
26
26
|
#
|
|
27
|
-
# The
|
|
27
|
+
# The `Status` message contains three pieces of data: error code, error message,
|
|
28
28
|
# and error details. The error code should be an enum value of
|
|
29
29
|
# {Google::Rpc::Code}, but it may accept additional error codes if needed. The
|
|
30
30
|
# error message should be a developer-facing English message that helps
|
|
@@ -32,40 +32,40 @@ module Google
|
|
|
32
32
|
# error message is needed, put the localized message in the error details or
|
|
33
33
|
# localize it in the client. The optional error details may contain arbitrary
|
|
34
34
|
# information about the error. There is a predefined set of error detail types
|
|
35
|
-
# in the package
|
|
35
|
+
# in the package `google.rpc` that can be used for common error conditions.
|
|
36
36
|
#
|
|
37
37
|
# = Language mapping
|
|
38
38
|
#
|
|
39
|
-
# The
|
|
40
|
-
# is not necessarily the actual wire format. When the
|
|
39
|
+
# The `Status` message is the logical representation of the error model, but it
|
|
40
|
+
# is not necessarily the actual wire format. When the `Status` message is
|
|
41
41
|
# exposed in different client libraries and different wire protocols, it can be
|
|
42
42
|
# mapped differently. For example, it will likely be mapped to some exceptions
|
|
43
43
|
# in Java, but more likely mapped to some error codes in C.
|
|
44
44
|
#
|
|
45
45
|
# = Other uses
|
|
46
46
|
#
|
|
47
|
-
# The error model and the
|
|
47
|
+
# The error model and the `Status` message can be used in a variety of
|
|
48
48
|
# environments, either with or without APIs, to provide a
|
|
49
49
|
# consistent developer experience across different environments.
|
|
50
50
|
#
|
|
51
51
|
# Example uses of this error model include:
|
|
52
52
|
#
|
|
53
53
|
# * Partial errors. If a service needs to return partial errors to the client,
|
|
54
|
-
# it may embed the
|
|
54
|
+
# it may embed the `Status` in the normal response to indicate the partial
|
|
55
55
|
# errors.
|
|
56
56
|
#
|
|
57
57
|
# * Workflow errors. A typical workflow has multiple steps. Each step may
|
|
58
|
-
# have a
|
|
58
|
+
# have a `Status` message for error reporting.
|
|
59
59
|
#
|
|
60
60
|
# * Batch operations. If a client uses batch request and batch response, the
|
|
61
|
-
#
|
|
61
|
+
# `Status` message should be used directly inside batch response, one for
|
|
62
62
|
# each error sub-response.
|
|
63
63
|
#
|
|
64
64
|
# * Asynchronous operations. If an API call embeds asynchronous operation
|
|
65
65
|
# results in its response, the status of those operations should be
|
|
66
|
-
# represented directly using the
|
|
66
|
+
# represented directly using the `Status` message.
|
|
67
67
|
#
|
|
68
|
-
# * Logging. If some API errors are stored in logs, the message
|
|
68
|
+
# * Logging. If some API errors are stored in logs, the message `Status` could
|
|
69
69
|
# be used directly after any stripping needed for security/privacy reasons.
|
|
70
70
|
# @!attribute [rw] code
|
|
71
71
|
# @return [Integer]
|
|
@@ -218,7 +218,7 @@ module Google
|
|
|
218
218
|
#
|
|
219
219
|
# @param name [String]
|
|
220
220
|
# Required. The name of the project where the spans belong. The format is
|
|
221
|
-
#
|
|
221
|
+
# `projects/[PROJECT_ID]`.
|
|
222
222
|
# @param spans [Array<Google::Devtools::Cloudtrace::V2::Span | Hash>]
|
|
223
223
|
# A list of new spans. The span names must not match existing
|
|
224
224
|
# spans, or the results are undefined.
|
|
@@ -237,7 +237,7 @@ module Google
|
|
|
237
237
|
# trace_service_client = Google::Cloud::Trace.new(version: :v2)
|
|
238
238
|
# formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.project_path("[PROJECT]")
|
|
239
239
|
#
|
|
240
|
-
# # TODO: Initialize
|
|
240
|
+
# # TODO: Initialize `spans`:
|
|
241
241
|
# spans = []
|
|
242
242
|
# trace_service_client.batch_write_spans(formatted_name, spans)
|
|
243
243
|
|
|
@@ -342,16 +342,16 @@ module Google
|
|
|
342
342
|
# trace_service_client = Google::Cloud::Trace.new(version: :v2)
|
|
343
343
|
# formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.span_path("[PROJECT]", "[TRACE]", "[SPAN]")
|
|
344
344
|
#
|
|
345
|
-
# # TODO: Initialize
|
|
345
|
+
# # TODO: Initialize `span_id`:
|
|
346
346
|
# span_id = ''
|
|
347
347
|
#
|
|
348
|
-
# # TODO: Initialize
|
|
348
|
+
# # TODO: Initialize `display_name`:
|
|
349
349
|
# display_name = {}
|
|
350
350
|
#
|
|
351
|
-
# # TODO: Initialize
|
|
351
|
+
# # TODO: Initialize `start_time`:
|
|
352
352
|
# start_time = {}
|
|
353
353
|
#
|
|
354
|
-
# # TODO: Initialize
|
|
354
|
+
# # TODO: Initialize `end_time`:
|
|
355
355
|
# end_time = {}
|
|
356
356
|
# response = trace_service_client.create_span(formatted_name, span_id, display_name, start_time, end_time)
|
|
357
357
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-trace
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.33.
|
|
4
|
+
version: 0.33.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Daniel Azuma
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-09-
|
|
11
|
+
date: 2018-09-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: google-cloud-core
|
|
@@ -294,7 +294,7 @@ files:
|
|
|
294
294
|
- lib/google/devtools/cloudtrace/v2/trace_pb.rb
|
|
295
295
|
- lib/google/devtools/cloudtrace/v2/tracing_pb.rb
|
|
296
296
|
- lib/google/devtools/cloudtrace/v2/tracing_services_pb.rb
|
|
297
|
-
homepage: https://github.com/
|
|
297
|
+
homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-trace
|
|
298
298
|
licenses:
|
|
299
299
|
- Apache-2.0
|
|
300
300
|
metadata: {}
|