google-cloud-logging-v2 0.11.0 → 0.12.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/logging/v2/config_service/client.rb +32 -8
- data/lib/google/cloud/logging/v2/config_service/operations.rb +28 -6
- data/lib/google/cloud/logging/v2/logging_service/client.rb +31 -8
- data/lib/google/cloud/logging/v2/metrics_service/client.rb +31 -8
- data/lib/google/cloud/logging/v2/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/metric.rb +1 -0
- data/proto_docs/google/logging/v2/logging_config.rb +1 -0
- data/proto_docs/google/logging/v2/logging_metrics.rb +1 -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: ed985114dc58fc981fb12a3f08d4b2ae57c42fb3ec8575556f5ecb8dd2f787a3
|
|
4
|
+
data.tar.gz: fa0f61b43ceed83b9e030ea0c13ff6d7e367b27354bbd12ad007cda6a6272917
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7a1ab23723c3e4a1a5d3a97dd6ac82272f72497ccb14389c08f4a57ff21046e95f173c34a4b028c6592a34088226778e6d6360fe50323e72bf3515f7cbe1ae62
|
|
7
|
+
data.tar.gz: 0d829c27b194c402d247fe82d6303fba79fc901f2a769c82bbc4a72345e203cd735d33572c422d9e0ff93679ae433e093c71430d0d8ab1304b51fd5cfee15a30
|
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-logging-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-logging-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-logging-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::Logging::V2::LoggingService::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/logging/v2"
|
|
77
|
-
|
|
78
|
-
ENV["LOGGING_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/logging/v2"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Logging::V2::LoggingService::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/logging/v2"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Logging::V2::LoggingService::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::Logging::V2::LoggingService::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-logging-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/logging/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-logging-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::Logging::V2::LoggingService::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).
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Service for configuring sinks used to route log entries.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "logging.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -131,6 +134,15 @@ module Google
|
|
|
131
134
|
@config
|
|
132
135
|
end
|
|
133
136
|
|
|
137
|
+
##
|
|
138
|
+
# The effective universe domain
|
|
139
|
+
#
|
|
140
|
+
# @return [String]
|
|
141
|
+
#
|
|
142
|
+
def universe_domain
|
|
143
|
+
@config_service_stub.universe_domain
|
|
144
|
+
end
|
|
145
|
+
|
|
134
146
|
##
|
|
135
147
|
# Create a new ConfigService client object.
|
|
136
148
|
#
|
|
@@ -164,8 +176,9 @@ module Google
|
|
|
164
176
|
credentials = @config.credentials
|
|
165
177
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
166
178
|
# but only if the default endpoint does not have a region prefix.
|
|
167
|
-
enable_self_signed_jwt = @config.endpoint
|
|
168
|
-
|
|
179
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
180
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
181
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
169
182
|
credentials ||= Credentials.default scope: @config.scope,
|
|
170
183
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
171
184
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -178,12 +191,15 @@ module Google
|
|
|
178
191
|
config.credentials = credentials
|
|
179
192
|
config.quota_project = @quota_project_id
|
|
180
193
|
config.endpoint = @config.endpoint
|
|
194
|
+
config.universe_domain = @config.universe_domain
|
|
181
195
|
end
|
|
182
196
|
|
|
183
197
|
@config_service_stub = ::Gapic::ServiceStub.new(
|
|
184
198
|
::Google::Cloud::Logging::V2::ConfigServiceV2::Stub,
|
|
185
|
-
credentials:
|
|
186
|
-
endpoint:
|
|
199
|
+
credentials: credentials,
|
|
200
|
+
endpoint: @config.endpoint,
|
|
201
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
202
|
+
universe_domain: @config.universe_domain,
|
|
187
203
|
channel_args: @config.channel_args,
|
|
188
204
|
interceptors: @config.interceptors,
|
|
189
205
|
channel_pool_config: @config.channel_pool
|
|
@@ -3546,9 +3562,9 @@ module Google
|
|
|
3546
3562
|
# end
|
|
3547
3563
|
#
|
|
3548
3564
|
# @!attribute [rw] endpoint
|
|
3549
|
-
#
|
|
3550
|
-
#
|
|
3551
|
-
# @return [::String]
|
|
3565
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
3566
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
3567
|
+
# @return [::String,nil]
|
|
3552
3568
|
# @!attribute [rw] credentials
|
|
3553
3569
|
# Credentials to send with calls. You may provide any of the following types:
|
|
3554
3570
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -3594,13 +3610,20 @@ module Google
|
|
|
3594
3610
|
# @!attribute [rw] quota_project
|
|
3595
3611
|
# A separate project against which to charge quota.
|
|
3596
3612
|
# @return [::String]
|
|
3613
|
+
# @!attribute [rw] universe_domain
|
|
3614
|
+
# The universe domain within which to make requests. This determines the
|
|
3615
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
3616
|
+
# universe (usually the default "googleapis.com" universe).
|
|
3617
|
+
# @return [::String,nil]
|
|
3597
3618
|
#
|
|
3598
3619
|
class Configuration
|
|
3599
3620
|
extend ::Gapic::Config
|
|
3600
3621
|
|
|
3622
|
+
# @private
|
|
3623
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
3601
3624
|
DEFAULT_ENDPOINT = "logging.googleapis.com"
|
|
3602
3625
|
|
|
3603
|
-
config_attr :endpoint,
|
|
3626
|
+
config_attr :endpoint, nil, ::String, nil
|
|
3604
3627
|
config_attr :credentials, nil do |value|
|
|
3605
3628
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
3606
3629
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -3615,6 +3638,7 @@ module Google
|
|
|
3615
3638
|
config_attr :metadata, nil, ::Hash, nil
|
|
3616
3639
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
3617
3640
|
config_attr :quota_project, nil, ::String, nil
|
|
3641
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
3618
3642
|
|
|
3619
3643
|
# @private
|
|
3620
3644
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module ConfigService
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "logging.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -90,8 +102,10 @@ module Google
|
|
|
90
102
|
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
|
93
|
-
credentials:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
110
|
interceptors: @config.interceptors,
|
|
97
111
|
channel_pool_config: @config.channel_pool
|
|
@@ -613,9 +627,9 @@ module Google
|
|
|
613
627
|
# end
|
|
614
628
|
#
|
|
615
629
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @return [::String]
|
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
632
|
+
# @return [::String,nil]
|
|
619
633
|
# @!attribute [rw] credentials
|
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +675,20 @@ module Google
|
|
|
661
675
|
# @!attribute [rw] quota_project
|
|
662
676
|
# A separate project against which to charge quota.
|
|
663
677
|
# @return [::String]
|
|
678
|
+
# @!attribute [rw] universe_domain
|
|
679
|
+
# The universe domain within which to make requests. This determines the
|
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
|
682
|
+
# @return [::String,nil]
|
|
664
683
|
#
|
|
665
684
|
class Configuration
|
|
666
685
|
extend ::Gapic::Config
|
|
667
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
689
|
DEFAULT_ENDPOINT = "logging.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
692
|
config_attr :credentials, nil do |value|
|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +703,7 @@ module Google
|
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
707
|
|
|
686
708
|
# @private
|
|
687
709
|
def initialize parent_config = nil
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Service for ingesting and querying logs.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "logging.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -120,6 +123,15 @@ module Google
|
|
|
120
123
|
@config
|
|
121
124
|
end
|
|
122
125
|
|
|
126
|
+
##
|
|
127
|
+
# The effective universe domain
|
|
128
|
+
#
|
|
129
|
+
# @return [String]
|
|
130
|
+
#
|
|
131
|
+
def universe_domain
|
|
132
|
+
@logging_service_stub.universe_domain
|
|
133
|
+
end
|
|
134
|
+
|
|
123
135
|
##
|
|
124
136
|
# Create a new LoggingService client object.
|
|
125
137
|
#
|
|
@@ -153,8 +165,9 @@ module Google
|
|
|
153
165
|
credentials = @config.credentials
|
|
154
166
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
155
167
|
# but only if the default endpoint does not have a region prefix.
|
|
156
|
-
enable_self_signed_jwt = @config.endpoint
|
|
157
|
-
|
|
168
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
169
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
170
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
158
171
|
credentials ||= Credentials.default scope: @config.scope,
|
|
159
172
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
160
173
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -165,8 +178,10 @@ module Google
|
|
|
165
178
|
|
|
166
179
|
@logging_service_stub = ::Gapic::ServiceStub.new(
|
|
167
180
|
::Google::Cloud::Logging::V2::LoggingServiceV2::Stub,
|
|
168
|
-
credentials:
|
|
169
|
-
endpoint:
|
|
181
|
+
credentials: credentials,
|
|
182
|
+
endpoint: @config.endpoint,
|
|
183
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
184
|
+
universe_domain: @config.universe_domain,
|
|
170
185
|
channel_args: @config.channel_args,
|
|
171
186
|
interceptors: @config.interceptors,
|
|
172
187
|
channel_pool_config: @config.channel_pool
|
|
@@ -863,9 +878,9 @@ module Google
|
|
|
863
878
|
# end
|
|
864
879
|
#
|
|
865
880
|
# @!attribute [rw] endpoint
|
|
866
|
-
#
|
|
867
|
-
#
|
|
868
|
-
# @return [::String]
|
|
881
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
882
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
883
|
+
# @return [::String,nil]
|
|
869
884
|
# @!attribute [rw] credentials
|
|
870
885
|
# Credentials to send with calls. You may provide any of the following types:
|
|
871
886
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -911,13 +926,20 @@ module Google
|
|
|
911
926
|
# @!attribute [rw] quota_project
|
|
912
927
|
# A separate project against which to charge quota.
|
|
913
928
|
# @return [::String]
|
|
929
|
+
# @!attribute [rw] universe_domain
|
|
930
|
+
# The universe domain within which to make requests. This determines the
|
|
931
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
932
|
+
# universe (usually the default "googleapis.com" universe).
|
|
933
|
+
# @return [::String,nil]
|
|
914
934
|
#
|
|
915
935
|
class Configuration
|
|
916
936
|
extend ::Gapic::Config
|
|
917
937
|
|
|
938
|
+
# @private
|
|
939
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
918
940
|
DEFAULT_ENDPOINT = "logging.googleapis.com"
|
|
919
941
|
|
|
920
|
-
config_attr :endpoint,
|
|
942
|
+
config_attr :endpoint, nil, ::String, nil
|
|
921
943
|
config_attr :credentials, nil do |value|
|
|
922
944
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
923
945
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -932,6 +954,7 @@ module Google
|
|
|
932
954
|
config_attr :metadata, nil, ::Hash, nil
|
|
933
955
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
934
956
|
config_attr :quota_project, nil, ::String, nil
|
|
957
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
935
958
|
|
|
936
959
|
# @private
|
|
937
960
|
def initialize parent_config = nil
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Service for configuring logs-based metrics.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "logging.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -112,6 +115,15 @@ module Google
|
|
|
112
115
|
@config
|
|
113
116
|
end
|
|
114
117
|
|
|
118
|
+
##
|
|
119
|
+
# The effective universe domain
|
|
120
|
+
#
|
|
121
|
+
# @return [String]
|
|
122
|
+
#
|
|
123
|
+
def universe_domain
|
|
124
|
+
@metrics_service_stub.universe_domain
|
|
125
|
+
end
|
|
126
|
+
|
|
115
127
|
##
|
|
116
128
|
# Create a new MetricsService client object.
|
|
117
129
|
#
|
|
@@ -145,8 +157,9 @@ module Google
|
|
|
145
157
|
credentials = @config.credentials
|
|
146
158
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
147
159
|
# but only if the default endpoint does not have a region prefix.
|
|
148
|
-
enable_self_signed_jwt = @config.endpoint
|
|
149
|
-
|
|
160
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
161
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
162
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
150
163
|
credentials ||= Credentials.default scope: @config.scope,
|
|
151
164
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
152
165
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -157,8 +170,10 @@ module Google
|
|
|
157
170
|
|
|
158
171
|
@metrics_service_stub = ::Gapic::ServiceStub.new(
|
|
159
172
|
::Google::Cloud::Logging::V2::MetricsServiceV2::Stub,
|
|
160
|
-
credentials:
|
|
161
|
-
endpoint:
|
|
173
|
+
credentials: credentials,
|
|
174
|
+
endpoint: @config.endpoint,
|
|
175
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
176
|
+
universe_domain: @config.universe_domain,
|
|
162
177
|
channel_args: @config.channel_args,
|
|
163
178
|
interceptors: @config.interceptors,
|
|
164
179
|
channel_pool_config: @config.channel_pool
|
|
@@ -657,9 +672,9 @@ module Google
|
|
|
657
672
|
# end
|
|
658
673
|
#
|
|
659
674
|
# @!attribute [rw] endpoint
|
|
660
|
-
#
|
|
661
|
-
#
|
|
662
|
-
# @return [::String]
|
|
675
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
676
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
677
|
+
# @return [::String,nil]
|
|
663
678
|
# @!attribute [rw] credentials
|
|
664
679
|
# Credentials to send with calls. You may provide any of the following types:
|
|
665
680
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -705,13 +720,20 @@ module Google
|
|
|
705
720
|
# @!attribute [rw] quota_project
|
|
706
721
|
# A separate project against which to charge quota.
|
|
707
722
|
# @return [::String]
|
|
723
|
+
# @!attribute [rw] universe_domain
|
|
724
|
+
# The universe domain within which to make requests. This determines the
|
|
725
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
726
|
+
# universe (usually the default "googleapis.com" universe).
|
|
727
|
+
# @return [::String,nil]
|
|
708
728
|
#
|
|
709
729
|
class Configuration
|
|
710
730
|
extend ::Gapic::Config
|
|
711
731
|
|
|
732
|
+
# @private
|
|
733
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
712
734
|
DEFAULT_ENDPOINT = "logging.googleapis.com"
|
|
713
735
|
|
|
714
|
-
config_attr :endpoint,
|
|
736
|
+
config_attr :endpoint, nil, ::String, nil
|
|
715
737
|
config_attr :credentials, nil do |value|
|
|
716
738
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
717
739
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -726,6 +748,7 @@ module Google
|
|
|
726
748
|
config_attr :metadata, nil, ::Hash, nil
|
|
727
749
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
728
750
|
config_attr :quota_project, nil, ::String, nil
|
|
751
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
729
752
|
|
|
730
753
|
# @private
|
|
731
754
|
def initialize parent_config = nil
|
|
@@ -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
|
|
@@ -184,6 +184,7 @@ module Google
|
|
|
184
184
|
|
|
185
185
|
# Additional annotations that can be used to guide the usage of a metric.
|
|
186
186
|
# @!attribute [rw] launch_stage
|
|
187
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
187
188
|
# @return [::Google::Api::LaunchStage]
|
|
188
189
|
# Deprecated. Must use the
|
|
189
190
|
# {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage}
|
|
@@ -207,6 +207,7 @@ module Google
|
|
|
207
207
|
# If a log entry is matched by both `filter` and one of `exclusion_filters`
|
|
208
208
|
# it will not be exported.
|
|
209
209
|
# @!attribute [rw] output_version_format
|
|
210
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
210
211
|
# @return [::Google::Cloud::Logging::V2::LogSink::VersionFormat]
|
|
211
212
|
# Deprecated. This field is unused.
|
|
212
213
|
# @!attribute [r] writer_identity
|
|
@@ -148,6 +148,7 @@ module Google
|
|
|
148
148
|
#
|
|
149
149
|
# This field may not be present for older metrics.
|
|
150
150
|
# @!attribute [rw] version
|
|
151
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
151
152
|
# @return [::Google::Cloud::Logging::V2::LogMetric::ApiVersion]
|
|
152
153
|
# Deprecated. The API version that created or updated this metric.
|
|
153
154
|
# The v2 format is used by default and cannot be changed.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-logging-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.12.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
|
|
@@ -235,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
235
235
|
- !ruby/object:Gem::Version
|
|
236
236
|
version: '0'
|
|
237
237
|
requirements: []
|
|
238
|
-
rubygems_version: 3.
|
|
238
|
+
rubygems_version: 3.5.3
|
|
239
239
|
signing_key:
|
|
240
240
|
specification_version: 4
|
|
241
241
|
summary: Writes log entries and manages your Cloud Logging configuration.
|