google-cloud-trace-v2 0.6.1 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/trace/v2/trace_service/client.rb +41 -9
- data/lib/google/cloud/trace/v2/trace_service/rest/client.rb +65 -7
- data/lib/google/cloud/trace/v2/trace_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/trace/v2/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fc317bb0e4787df6963cd556bbe545dae395ea39ea4f7bc8a803159f500e8e33
|
|
4
|
+
data.tar.gz: ba7578d49cb5d497ba1a1604467fe73ffd50c62ec89a8583d4b6b33f4790ec4a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d127733d24da50435320d366ab6b6a6f50a64fced176bb99c1772c2df422f5c74bec062f9afa00553dc5ce59bfd39a024632901cbb79d01b2629b52051afa708
|
|
7
|
+
data.tar.gz: 84c07ea954afd7adfe5daf4bbd3377c5838101b55b514686eed89880817693a21495f5265d8973f174b74a712aabba4741de3f207c02c52fefcdebd49a95e9c7
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
-
credentials will be discovered automatically. When running on other
|
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
|
9
|
-
path to the
|
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
-
for the account (or the JSON itself) in
|
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
|
14
|
-
during development.
|
|
3
|
+
The recommended way to authenticate to the google-cloud-trace-v2 library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
3. Initialize the client.
|
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
|
13
|
+
should be used only during development.
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
|
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
|
29
17
|
|
|
30
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-trace-v2 library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
-
Code should be written as if already authenticated.
|
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
|
63
|
-
containers where writing files is difficult or not encouraged.
|
|
29
|
+
The google-cloud-trace-v2 library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Trace::V2::TraceService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/trace/v2"
|
|
77
|
-
|
|
78
|
-
ENV["TRACE_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/trace/v2"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/trace/v2"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Trace::V2::TraceService::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::Trace::V2::TraceService::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
90
|
+
whenever possible.
|
|
91
|
+
|
|
92
|
+
The environment variables that google-cloud-trace-v2
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/trace/v2"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-trace-v2.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Trace::V2::TraceService::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -36,6 +36,9 @@ module Google
|
|
|
36
36
|
# A single trace can contain spans from multiple services.
|
|
37
37
|
#
|
|
38
38
|
class Client
|
|
39
|
+
# @private
|
|
40
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudtrace.$UNIVERSE_DOMAIN$"
|
|
41
|
+
|
|
39
42
|
include Paths
|
|
40
43
|
|
|
41
44
|
# @private
|
|
@@ -106,6 +109,15 @@ module Google
|
|
|
106
109
|
@config
|
|
107
110
|
end
|
|
108
111
|
|
|
112
|
+
##
|
|
113
|
+
# The effective universe domain
|
|
114
|
+
#
|
|
115
|
+
# @return [String]
|
|
116
|
+
#
|
|
117
|
+
def universe_domain
|
|
118
|
+
@trace_service_stub.universe_domain
|
|
119
|
+
end
|
|
120
|
+
|
|
109
121
|
##
|
|
110
122
|
# Create a new TraceService client object.
|
|
111
123
|
#
|
|
@@ -139,8 +151,9 @@ module Google
|
|
|
139
151
|
credentials = @config.credentials
|
|
140
152
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
141
153
|
# but only if the default endpoint does not have a region prefix.
|
|
142
|
-
enable_self_signed_jwt = @config.endpoint
|
|
143
|
-
|
|
154
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
155
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
156
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
144
157
|
credentials ||= Credentials.default scope: @config.scope,
|
|
145
158
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
146
159
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -151,10 +164,13 @@ module Google
|
|
|
151
164
|
|
|
152
165
|
@trace_service_stub = ::Gapic::ServiceStub.new(
|
|
153
166
|
::Google::Cloud::Trace::V2::TraceService::Stub,
|
|
154
|
-
credentials:
|
|
155
|
-
endpoint:
|
|
167
|
+
credentials: credentials,
|
|
168
|
+
endpoint: @config.endpoint,
|
|
169
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
170
|
+
universe_domain: @config.universe_domain,
|
|
156
171
|
channel_args: @config.channel_args,
|
|
157
|
-
interceptors: @config.interceptors
|
|
172
|
+
interceptors: @config.interceptors,
|
|
173
|
+
channel_pool_config: @config.channel_pool
|
|
158
174
|
)
|
|
159
175
|
end
|
|
160
176
|
|
|
@@ -421,9 +437,9 @@ module Google
|
|
|
421
437
|
# end
|
|
422
438
|
#
|
|
423
439
|
# @!attribute [rw] endpoint
|
|
424
|
-
#
|
|
425
|
-
#
|
|
426
|
-
# @return [::String]
|
|
440
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
441
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
442
|
+
# @return [::String,nil]
|
|
427
443
|
# @!attribute [rw] credentials
|
|
428
444
|
# Credentials to send with calls. You may provide any of the following types:
|
|
429
445
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -469,13 +485,20 @@ module Google
|
|
|
469
485
|
# @!attribute [rw] quota_project
|
|
470
486
|
# A separate project against which to charge quota.
|
|
471
487
|
# @return [::String]
|
|
488
|
+
# @!attribute [rw] universe_domain
|
|
489
|
+
# The universe domain within which to make requests. This determines the
|
|
490
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
491
|
+
# universe (usually the default "googleapis.com" universe).
|
|
492
|
+
# @return [::String,nil]
|
|
472
493
|
#
|
|
473
494
|
class Configuration
|
|
474
495
|
extend ::Gapic::Config
|
|
475
496
|
|
|
497
|
+
# @private
|
|
498
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
476
499
|
DEFAULT_ENDPOINT = "cloudtrace.googleapis.com"
|
|
477
500
|
|
|
478
|
-
config_attr :endpoint,
|
|
501
|
+
config_attr :endpoint, nil, ::String, nil
|
|
479
502
|
config_attr :credentials, nil do |value|
|
|
480
503
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
481
504
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -490,6 +513,7 @@ module Google
|
|
|
490
513
|
config_attr :metadata, nil, ::Hash, nil
|
|
491
514
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
492
515
|
config_attr :quota_project, nil, ::String, nil
|
|
516
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
493
517
|
|
|
494
518
|
# @private
|
|
495
519
|
def initialize parent_config = nil
|
|
@@ -510,6 +534,14 @@ module Google
|
|
|
510
534
|
end
|
|
511
535
|
end
|
|
512
536
|
|
|
537
|
+
##
|
|
538
|
+
# Configuration for the channel pool
|
|
539
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
540
|
+
#
|
|
541
|
+
def channel_pool
|
|
542
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
543
|
+
end
|
|
544
|
+
|
|
513
545
|
##
|
|
514
546
|
# Configuration RPC class for the TraceService API.
|
|
515
547
|
#
|
|
@@ -38,6 +38,9 @@ module Google
|
|
|
38
38
|
# A single trace can contain spans from multiple services.
|
|
39
39
|
#
|
|
40
40
|
class Client
|
|
41
|
+
# @private
|
|
42
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudtrace.$UNIVERSE_DOMAIN$"
|
|
43
|
+
|
|
41
44
|
include Paths
|
|
42
45
|
|
|
43
46
|
# @private
|
|
@@ -108,6 +111,15 @@ module Google
|
|
|
108
111
|
@config
|
|
109
112
|
end
|
|
110
113
|
|
|
114
|
+
##
|
|
115
|
+
# The effective universe domain
|
|
116
|
+
#
|
|
117
|
+
# @return [String]
|
|
118
|
+
#
|
|
119
|
+
def universe_domain
|
|
120
|
+
@trace_service_stub.universe_domain
|
|
121
|
+
end
|
|
122
|
+
|
|
111
123
|
##
|
|
112
124
|
# Create a new TraceService REST client object.
|
|
113
125
|
#
|
|
@@ -135,8 +147,9 @@ module Google
|
|
|
135
147
|
credentials = @config.credentials
|
|
136
148
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
137
149
|
# but only if the default endpoint does not have a region prefix.
|
|
138
|
-
enable_self_signed_jwt = @config.endpoint
|
|
139
|
-
|
|
150
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
151
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
152
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
140
153
|
credentials ||= Credentials.default scope: @config.scope,
|
|
141
154
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
142
155
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -146,7 +159,12 @@ module Google
|
|
|
146
159
|
@quota_project_id = @config.quota_project
|
|
147
160
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
148
161
|
|
|
149
|
-
@trace_service_stub = ::Google::Cloud::Trace::V2::TraceService::Rest::ServiceStub.new
|
|
162
|
+
@trace_service_stub = ::Google::Cloud::Trace::V2::TraceService::Rest::ServiceStub.new(
|
|
163
|
+
endpoint: @config.endpoint,
|
|
164
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
165
|
+
universe_domain: @config.universe_domain,
|
|
166
|
+
credentials: credentials
|
|
167
|
+
)
|
|
150
168
|
end
|
|
151
169
|
|
|
152
170
|
# Service calls
|
|
@@ -183,6 +201,22 @@ module Google
|
|
|
183
201
|
# @return [::Google::Protobuf::Empty]
|
|
184
202
|
#
|
|
185
203
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
204
|
+
#
|
|
205
|
+
# @example Basic example
|
|
206
|
+
# require "google/cloud/trace/v2"
|
|
207
|
+
#
|
|
208
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
209
|
+
# client = Google::Cloud::Trace::V2::TraceService::Rest::Client.new
|
|
210
|
+
#
|
|
211
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
212
|
+
# request = Google::Cloud::Trace::V2::BatchWriteSpansRequest.new
|
|
213
|
+
#
|
|
214
|
+
# # Call the batch_write_spans method.
|
|
215
|
+
# result = client.batch_write_spans request
|
|
216
|
+
#
|
|
217
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
218
|
+
# p result
|
|
219
|
+
#
|
|
186
220
|
def batch_write_spans request, options = nil
|
|
187
221
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
188
222
|
|
|
@@ -301,6 +335,22 @@ module Google
|
|
|
301
335
|
# @return [::Google::Cloud::Trace::V2::Span]
|
|
302
336
|
#
|
|
303
337
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
338
|
+
#
|
|
339
|
+
# @example Basic example
|
|
340
|
+
# require "google/cloud/trace/v2"
|
|
341
|
+
#
|
|
342
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
343
|
+
# client = Google::Cloud::Trace::V2::TraceService::Rest::Client.new
|
|
344
|
+
#
|
|
345
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
346
|
+
# request = Google::Cloud::Trace::V2::Span.new
|
|
347
|
+
#
|
|
348
|
+
# # Call the create_span method.
|
|
349
|
+
# result = client.create_span request
|
|
350
|
+
#
|
|
351
|
+
# # The returned object is of type Google::Cloud::Trace::V2::Span.
|
|
352
|
+
# p result
|
|
353
|
+
#
|
|
304
354
|
def create_span request, options = nil
|
|
305
355
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
306
356
|
|
|
@@ -366,9 +416,9 @@ module Google
|
|
|
366
416
|
# end
|
|
367
417
|
#
|
|
368
418
|
# @!attribute [rw] endpoint
|
|
369
|
-
#
|
|
370
|
-
#
|
|
371
|
-
# @return [::String]
|
|
419
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
420
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
421
|
+
# @return [::String,nil]
|
|
372
422
|
# @!attribute [rw] credentials
|
|
373
423
|
# Credentials to send with calls. You may provide any of the following types:
|
|
374
424
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -405,13 +455,20 @@ module Google
|
|
|
405
455
|
# @!attribute [rw] quota_project
|
|
406
456
|
# A separate project against which to charge quota.
|
|
407
457
|
# @return [::String]
|
|
458
|
+
# @!attribute [rw] universe_domain
|
|
459
|
+
# The universe domain within which to make requests. This determines the
|
|
460
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
461
|
+
# universe (usually the default "googleapis.com" universe).
|
|
462
|
+
# @return [::String,nil]
|
|
408
463
|
#
|
|
409
464
|
class Configuration
|
|
410
465
|
extend ::Gapic::Config
|
|
411
466
|
|
|
467
|
+
# @private
|
|
468
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
412
469
|
DEFAULT_ENDPOINT = "cloudtrace.googleapis.com"
|
|
413
470
|
|
|
414
|
-
config_attr :endpoint,
|
|
471
|
+
config_attr :endpoint, nil, ::String, nil
|
|
415
472
|
config_attr :credentials, nil do |value|
|
|
416
473
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
417
474
|
allowed.any? { |klass| klass === value }
|
|
@@ -423,6 +480,7 @@ module Google
|
|
|
423
480
|
config_attr :metadata, nil, ::Hash, nil
|
|
424
481
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
425
482
|
config_attr :quota_project, nil, ::String, nil
|
|
483
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
426
484
|
|
|
427
485
|
# @private
|
|
428
486
|
def initialize parent_config = nil
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the batch_write_spans REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -66,6 +66,20 @@ module Google
|
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
|
67
67
|
# non-empty value to expect.
|
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
|
69
|
+
|
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
|
73
|
+
# `name` field on the resource.
|
|
74
|
+
#
|
|
75
|
+
# This behavior should not be applied to references to other resources within
|
|
76
|
+
# the message.
|
|
77
|
+
#
|
|
78
|
+
# The identifier field of resources often have different field behavior
|
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
|
82
|
+
IDENTIFIER = 8
|
|
69
83
|
end
|
|
70
84
|
end
|
|
71
85
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-trace-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.8.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
218
218
|
- !ruby/object:Gem::Version
|
|
219
219
|
version: '0'
|
|
220
220
|
requirements: []
|
|
221
|
-
rubygems_version: 3.
|
|
221
|
+
rubygems_version: 3.5.3
|
|
222
222
|
signing_key:
|
|
223
223
|
specification_version: 4
|
|
224
224
|
summary: Sends application trace data to Stackdriver Trace for viewing. Trace data
|