From ec9ca8991cf6cd2f82fa1aa8f4f40d1a07accbc6 Mon Sep 17 00:00:00 2001 From: Hector Mendoza Jacobo Date: Tue, 26 Nov 2024 22:24:02 +0000 Subject: [PATCH 1/7] Add a DEBUG.md --- DEBUG.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 DEBUG.md diff --git a/DEBUG.md b/DEBUG.md new file mode 100644 index 00000000000..82ed1f74d5e --- /dev/null +++ b/DEBUG.md @@ -0,0 +1,84 @@ +# Debugging logs + +We have support for simple debugging in our libraries. This debugging support logs the requests that +the Client Libraries are performing internally and provides a quick glance of what the request and +response contains. + +> :warning: +> +> These logs are not intended to be used in production and is meant to be used for quickly +> debugging a project. The logs consists on basic logging into the STDOUT of your system which may +> or may not include sensitive information. Make sure that once you are done debugging to disable +> the debugging flag or configuration used to avoid leaking sensitive user data, This may also +> include authentication tokens. + +## Debugging usage + +There are multiple ways to configure the debugging logs which we will go through in this document. + +### The `GOOGLE_SDK_PHP_LOGGING` environment variable + +You can enable logging on all the different clients on your code by using this environment variable +to `true`. Once this environment variable is set, all the clients used on your code will start +logging the requests into `STDOUT`. + +```php +putenv('GOOGLE_SDK_PHP_LOGGING=true'); + +$client = new TranslationServiceClient([]); + +$request = new TranslateTextRequest(); +$request->setTargetLanguageCode('en-US'); +$request->setContents(['こんにちは']); +$request->setParent('projects/php-docs-samples-kokoro'); + +// This will be logged to STDOUT +$response = $client->translateText($request); +``` + +### Passing a PSR-3 compliant logger + +The debugging code has been made to comply with the PSR-3 logging interface. With in mind we can +pass a compatible logger to the client configuration. +```php +use Monolog\Handler\StreamHandler; +use Monolog\Level; +use Monolog\Logger; + +$monologLogger = new Logger('sdk client'); +$monologLogger->pushHandler(new StreamHandler('php://stdout', Level::Debug)); + +$client = new TranslationServiceClient([ + 'logger' => $monologLogger +]); +``` + +With this you now you will be using Monolog's logger instead of the internal one. This also opens +the opportunity to extend the capabilities of logging in case that you have specific needs, a PSR-3 +logger implementation can be passed to manage the logs in any way that are needed. + +### Passing `false` to the configuration + +The `logger` option on the client configuration options disables any logging for that specific +client. + +```php +$client = new TranslationServiceClient([ + 'logger' => false +]); +``` + +With this you can have different clients and either log in only one or disable individual clients +from logging to avoid excessive noise. + +```php +putenv('GOOGLE_SDK_PHP_LOGGING=true'); + +// The Big Table client will log all the requests +$client = new BigtableClient([]); + +// The TranslationServiceClient will not log any requests +$client = new TranslationServiceClient([ + 'logger' => false +]); +``` From bf9ec50224469b0957bd9c7857a2d813ac3a4371 Mon Sep 17 00:00:00 2001 From: Hector Mendoza Jacobo Date: Tue, 26 Nov 2024 23:01:53 +0000 Subject: [PATCH 2/7] Add a reference to the DEBUG.md to the README template --- dev/templates/README.md.twig | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/dev/templates/README.md.twig b/dev/templates/README.md.twig index 7d8b30f2d40..7047c035638 100644 --- a/dev/templates/README.md.twig +++ b/dev/templates/README.md.twig @@ -36,6 +36,10 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/{{github_repo}}/tree/main/samples) for a canonical list of samples. +### Debugging +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. From add4f487f14e01929ed7cd9ac7fd9311aa7fb181 Mon Sep 17 00:00:00 2001 From: Hector Mendoza Jacobo Date: Tue, 3 Dec 2024 16:43:45 +0000 Subject: [PATCH 3/7] Update all README to include the Debuggin reference --- AccessApproval/README.md | 5 +++++ AccessContextManager/README.md | 5 +++++ AdsAdManager/README.md | 5 +++++ AdsMarketingPlatformAdmin/README.md | 5 +++++ AdvisoryNotifications/README.md | 5 +++++ AiPlatform/README.md | 5 +++++ AlloyDb/README.md | 5 +++++ AnalyticsAdmin/README.md | 5 +++++ AnalyticsData/README.md | 5 +++++ ApiGateway/README.md | 5 +++++ ApiHub/README.md | 5 +++++ ApiKeys/README.md | 5 +++++ ApigeeConnect/README.md | 5 +++++ ApigeeRegistry/README.md | 5 +++++ AppEngineAdmin/README.md | 5 +++++ AppHub/README.md | 5 +++++ AppsChat/README.md | 5 +++++ AppsEventsSubscriptions/README.md | 5 +++++ AppsMeet/README.md | 5 +++++ ArtifactRegistry/README.md | 5 +++++ Asset/README.md | 5 +++++ AssuredWorkloads/README.md | 5 +++++ AutoMl/README.md | 5 +++++ BackupDr/README.md | 5 +++++ BareMetalSolution/README.md | 5 +++++ Batch/README.md | 5 +++++ BeyondCorpAppConnections/README.md | 5 +++++ BeyondCorpAppConnectors/README.md | 5 +++++ BeyondCorpAppGateways/README.md | 5 +++++ BeyondCorpClientConnectorServices/README.md | 5 +++++ BeyondCorpClientGateways/README.md | 5 +++++ BigQuery/README.md | 5 +++++ BigQueryAnalyticsHub/README.md | 5 +++++ BigQueryConnection/README.md | 5 +++++ BigQueryDataExchange/README.md | 5 +++++ BigQueryDataPolicies/README.md | 5 +++++ BigQueryDataTransfer/README.md | 5 +++++ BigQueryMigration/README.md | 5 +++++ BigQueryReservation/README.md | 5 +++++ BigQueryStorage/README.md | 5 +++++ Bigtable/README.md | 5 +++++ Billing/README.md | 5 +++++ BillingBudgets/README.md | 5 +++++ BinaryAuthorization/README.md | 5 +++++ Build/README.md | 5 +++++ CertificateManager/README.md | 5 +++++ Channel/README.md | 5 +++++ CommerceConsumerProcurement/README.md | 5 +++++ Compute/README.md | 5 +++++ ConfidentialComputing/README.md | 5 +++++ Config/README.md | 5 +++++ ContactCenterInsights/README.md | 5 +++++ Container/README.md | 5 +++++ ContainerAnalysis/README.md | 5 +++++ ControlsPartner/README.md | 5 +++++ Core/README.md | 5 +++++ DataCatalog/README.md | 5 +++++ DataCatalogLineage/README.md | 5 +++++ DataFusion/README.md | 5 +++++ DataLabeling/README.md | 5 +++++ Dataflow/README.md | 5 +++++ Dataform/README.md | 5 +++++ Dataplex/README.md | 5 +++++ Dataproc/README.md | 5 +++++ DataprocMetastore/README.md | 5 +++++ Datastore/README.md | 5 +++++ DatastoreAdmin/README.md | 5 +++++ Datastream/README.md | 5 +++++ Debugger/README.md | 5 +++++ Deploy/README.md | 5 +++++ DeveloperConnect/README.md | 5 +++++ Dialogflow/README.md | 5 +++++ DialogflowCx/README.md | 5 +++++ DiscoveryEngine/README.md | 5 +++++ Dlp/README.md | 5 +++++ Dms/README.md | 5 +++++ DocumentAi/README.md | 5 +++++ Domains/README.md | 5 +++++ EdgeNetwork/README.md | 5 +++++ ErrorReporting/README.md | 5 +++++ EssentialContacts/README.md | 5 +++++ Eventarc/README.md | 5 +++++ EventarcPublishing/README.md | 5 +++++ Filestore/README.md | 5 +++++ Firestore/README.md | 5 +++++ Functions/README.md | 5 +++++ GSuiteAddOns/README.md | 5 +++++ GkeBackup/README.md | 5 +++++ GkeConnectGateway/README.md | 5 +++++ GkeHub/README.md | 5 +++++ GkeMultiCloud/README.md | 5 +++++ Grafeas/README.md | 5 +++++ Iam/README.md | 5 +++++ IamCredentials/README.md | 5 +++++ Iap/README.md | 5 +++++ Ids/README.md | 5 +++++ Kms/README.md | 5 +++++ KmsInventory/README.md | 5 +++++ Language/README.md | 5 +++++ LifeSciences/README.md | 5 +++++ Logging/README.md | 5 +++++ LongRunning/README.md | 5 +++++ ManagedIdentities/README.md | 5 +++++ ManagedKafka/README.md | 5 +++++ MapsFleetEngine/README.md | 5 +++++ MapsFleetEngineDelivery/README.md | 5 +++++ MapsRouteOptimization/README.md | 5 +++++ MediaTranslation/README.md | 5 +++++ Memcache/README.md | 5 +++++ MigrationCenter/README.md | 5 +++++ Monitoring/README.md | 6 +++++- NetApp/README.md | 5 +++++ NetworkConnectivity/README.md | 5 +++++ NetworkManagement/README.md | 5 +++++ NetworkSecurity/README.md | 5 +++++ NetworkServices/README.md | 5 +++++ Notebooks/README.md | 5 +++++ Optimization/README.md | 5 +++++ OracleDatabase/README.md | 5 +++++ OrchestrationAirflow/README.md | 5 +++++ OrgPolicy/README.md | 5 +++++ OsConfig/README.md | 5 +++++ OsLogin/README.md | 5 +++++ Parallelstore/README.md | 5 +++++ PolicySimulator/README.md | 5 +++++ PolicyTroubleshooter/README.md | 5 +++++ PolicyTroubleshooterIam/README.md | 5 +++++ PrivateCatalog/README.md | 5 +++++ PrivilegedAccessManager/README.md | 5 +++++ Profiler/README.md | 5 +++++ PubSub/README.md | 5 +++++ Quotas/README.md | 5 +++++ README.md | 5 +++++ RapidMigrationAssessment/README.md | 5 +++++ RecaptchaEnterprise/README.md | 5 +++++ RecommendationEngine/README.md | 5 +++++ Recommender/README.md | 5 +++++ Redis/README.md | 5 +++++ RedisCluster/README.md | 5 +++++ ResourceManager/README.md | 5 +++++ ResourceSettings/README.md | 5 +++++ Retail/README.md | 5 +++++ Run/README.md | 5 +++++ Scheduler/README.md | 5 +++++ SecretManager/README.md | 5 +++++ SecureSourceManager/README.md | 5 +++++ SecurityCenter/README.md | 5 +++++ SecurityCenterManagement/README.md | 5 +++++ SecurityPrivateCa/README.md | 5 +++++ SecurityPublicCA/README.md | 5 +++++ ServiceControl/README.md | 5 +++++ ServiceDirectory/README.md | 5 +++++ ServiceHealth/README.md | 5 +++++ ServiceManagement/README.md | 5 +++++ ServiceUsage/README.md | 5 +++++ Shell/README.md | 5 +++++ ShoppingCss/README.md | 5 +++++ ShoppingMerchantAccounts/README.md | 5 +++++ ShoppingMerchantConversions/README.md | 5 +++++ ShoppingMerchantDataSources/README.md | 5 +++++ ShoppingMerchantInventories/README.md | 5 +++++ ShoppingMerchantLfp/README.md | 5 +++++ ShoppingMerchantNotifications/README.md | 5 +++++ ShoppingMerchantProducts/README.md | 5 +++++ ShoppingMerchantPromotions/README.md | 5 +++++ ShoppingMerchantQuota/README.md | 5 +++++ ShoppingMerchantReports/README.md | 5 +++++ Spanner/README.md | 5 +++++ Speech/README.md | 6 +++++- SqlAdmin/README.md | 5 +++++ Storage/README.md | 5 +++++ StorageControl/README.md | 5 +++++ StorageInsights/README.md | 5 +++++ StorageTransfer/README.md | 5 +++++ Support/README.md | 5 +++++ Talent/README.md | 5 +++++ Tasks/README.md | 5 +++++ TelcoAutomation/README.md | 5 +++++ TextToSpeech/README.md | 5 +++++ Tpu/README.md | 5 +++++ Trace/README.md | 5 +++++ Translate/README.md | 5 +++++ VideoIntelligence/README.md | 6 +++++- VideoLiveStream/README.md | 5 +++++ VideoStitcher/README.md | 5 +++++ VideoTranscoder/README.md | 5 +++++ Vision/README.md | 6 +++++- VmMigration/README.md | 5 +++++ VmwareEngine/README.md | 5 +++++ VpcAccess/README.md | 5 +++++ WebRisk/README.md | 5 +++++ WebSecurityScanner/README.md | 5 +++++ Workflows/README.md | 5 +++++ dev/tests/fixtures/component/CustomInput/README.md | 5 +++++ dev/tests/fixtures/component/SecretManager/README.md | 5 +++++ dev/tests/fixtures/component/Vision/README.md | 6 +++++- 196 files changed, 980 insertions(+), 5 deletions(-) diff --git a/AccessApproval/README.md b/AccessApproval/README.md index 683d36b280d..42df1f57d4d 100644 --- a/AccessApproval/README.md +++ b/AccessApproval/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AccessContextManager/README.md b/AccessContextManager/README.md index e7739a0b0eb..fbb10e2cd33 100644 --- a/AccessContextManager/README.md +++ b/AccessContextManager/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AdsAdManager/README.md b/AdsAdManager/README.md index 1840ee564ef..57cd9b17250 100644 --- a/AdsAdManager/README.md +++ b/AdsAdManager/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-ads-ad-manager/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/AdsMarketingPlatformAdmin/README.md b/AdsMarketingPlatformAdmin/README.md index 0e291996dff..4e0da390b14 100644 --- a/AdsMarketingPlatformAdmin/README.md +++ b/AdsMarketingPlatformAdmin/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-ads-marketingplatform-admin/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/AdvisoryNotifications/README.md b/AdvisoryNotifications/README.md index 52b5d108756..130e86a0859 100644 --- a/AdvisoryNotifications/README.md +++ b/AdvisoryNotifications/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-advisorynotifications/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AiPlatform/README.md b/AiPlatform/README.md index 42d54798d22..6305082eb34 100644 --- a/AiPlatform/README.md +++ b/AiPlatform/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AlloyDb/README.md b/AlloyDb/README.md index fc1170ef76d..a3fa4b07c30 100644 --- a/AlloyDb/README.md +++ b/AlloyDb/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-alloydb/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AnalyticsAdmin/README.md b/AnalyticsAdmin/README.md index 3cf5c8604b2..0715aaca04b 100644 --- a/AnalyticsAdmin/README.md +++ b/AnalyticsAdmin/README.md @@ -44,6 +44,11 @@ foreach ($accounts as $account) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/AnalyticsData/README.md b/AnalyticsData/README.md index 3f425379a9c..cb584c43a2b 100644 --- a/AnalyticsData/README.md +++ b/AnalyticsData/README.md @@ -48,6 +48,11 @@ foreach ($response->getRows() as $row) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/ApiGateway/README.md b/ApiGateway/README.md index dca1501c36e..a158f856302 100644 --- a/ApiGateway/README.md +++ b/ApiGateway/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ApiHub/README.md b/ApiHub/README.md index f48435aa9e5..fa6d935da32 100644 --- a/ApiHub/README.md +++ b/ApiHub/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-apihub/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ApiKeys/README.md b/ApiKeys/README.md index 6b0c2a2dbd5..758693b8cf4 100644 --- a/ApiKeys/README.md +++ b/ApiKeys/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ApigeeConnect/README.md b/ApigeeConnect/README.md index 9ec59ac3b83..3768301516d 100644 --- a/ApigeeConnect/README.md +++ b/ApigeeConnect/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ApigeeRegistry/README.md b/ApigeeRegistry/README.md index 84aede91ab1..8454de7c128 100644 --- a/ApigeeRegistry/README.md +++ b/ApigeeRegistry/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AppEngineAdmin/README.md b/AppEngineAdmin/README.md index 59a14d88e2d..f194dea379f 100644 --- a/AppEngineAdmin/README.md +++ b/AppEngineAdmin/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AppHub/README.md b/AppHub/README.md index 5d6484ed004..91c160a6df9 100644 --- a/AppHub/README.md +++ b/AppHub/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-apphub/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/AppsChat/README.md b/AppsChat/README.md index ccc2d238681..33c1abfcdc8 100644 --- a/AppsChat/README.md +++ b/AppsChat/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-chat/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/AppsEventsSubscriptions/README.md b/AppsEventsSubscriptions/README.md index 20c20c9b220..e3abf240e36 100644 --- a/AppsEventsSubscriptions/README.md +++ b/AppsEventsSubscriptions/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-apps-events-subscriptions/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/AppsMeet/README.md b/AppsMeet/README.md index bd80c0d0a28..0e7ccf2ef1a 100644 --- a/AppsMeet/README.md +++ b/AppsMeet/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-apps-meet/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ArtifactRegistry/README.md b/ArtifactRegistry/README.md index 7ebf410cf34..e263267b279 100644 --- a/ArtifactRegistry/README.md +++ b/ArtifactRegistry/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Asset/README.md b/Asset/README.md index 6546ce4075e..52294481143 100644 --- a/Asset/README.md +++ b/Asset/README.md @@ -58,6 +58,11 @@ if ($resp->operationSucceeded()) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AssuredWorkloads/README.md b/AssuredWorkloads/README.md index 2ba6957ef36..93dd127e264 100644 --- a/AssuredWorkloads/README.md +++ b/AssuredWorkloads/README.md @@ -46,6 +46,11 @@ foreach ($workloads as $workload) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/AutoMl/README.md b/AutoMl/README.md index 4e2c515df26..d065dc5cbba 100644 --- a/AutoMl/README.md +++ b/AutoMl/README.md @@ -49,6 +49,11 @@ $dataset = new Dataset([ $response = $autoMlClient->createDataset($formattedParent, $dataset); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BackupDr/README.md b/BackupDr/README.md index c931baed414..a2ad73851c3 100644 --- a/BackupDr/README.md +++ b/BackupDr/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-backupdr/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/BareMetalSolution/README.md b/BareMetalSolution/README.md index 943e6cad96d..dbeb1a4ac91 100644 --- a/BareMetalSolution/README.md +++ b/BareMetalSolution/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Batch/README.md b/Batch/README.md index bd155cc876a..800af6c4b02 100644 --- a/Batch/README.md +++ b/Batch/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BeyondCorpAppConnections/README.md b/BeyondCorpAppConnections/README.md index ff58526cde5..92dc5ed4563 100644 --- a/BeyondCorpAppConnections/README.md +++ b/BeyondCorpAppConnections/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BeyondCorpAppConnectors/README.md b/BeyondCorpAppConnectors/README.md index ebbce1f78c5..ddc507ef512 100644 --- a/BeyondCorpAppConnectors/README.md +++ b/BeyondCorpAppConnectors/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BeyondCorpAppGateways/README.md b/BeyondCorpAppGateways/README.md index f3a2174d603..d7b8f56dd63 100644 --- a/BeyondCorpAppGateways/README.md +++ b/BeyondCorpAppGateways/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BeyondCorpClientConnectorServices/README.md b/BeyondCorpClientConnectorServices/README.md index ef858addf4c..d6d5852324a 100644 --- a/BeyondCorpClientConnectorServices/README.md +++ b/BeyondCorpClientConnectorServices/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BeyondCorpClientGateways/README.md b/BeyondCorpClientGateways/README.md index de0f9708c32..b3c3b51dfa6 100644 --- a/BeyondCorpClientGateways/README.md +++ b/BeyondCorpClientGateways/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQuery/README.md b/BigQuery/README.md index 2a6f4fae02f..46ddd197c41 100644 --- a/BigQuery/README.md +++ b/BigQuery/README.md @@ -57,6 +57,11 @@ foreach ($queryResults as $row) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQueryAnalyticsHub/README.md b/BigQueryAnalyticsHub/README.md index 3acb7cbe9f3..2e65732bb00 100644 --- a/BigQueryAnalyticsHub/README.md +++ b/BigQueryAnalyticsHub/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQueryConnection/README.md b/BigQueryConnection/README.md index e38e64e3738..92084602fb1 100644 --- a/BigQueryConnection/README.md +++ b/BigQueryConnection/README.md @@ -50,6 +50,11 @@ $connection = new Connection([ $connection = $client->createConnection($parent, $connection); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQueryDataExchange/README.md b/BigQueryDataExchange/README.md index c67321aeb6a..4c4046ca278 100644 --- a/BigQueryDataExchange/README.md +++ b/BigQueryDataExchange/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/BigQueryDataPolicies/README.md b/BigQueryDataPolicies/README.md index e7326720196..2ca36efc93f 100644 --- a/BigQueryDataPolicies/README.md +++ b/BigQueryDataPolicies/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQueryDataTransfer/README.md b/BigQueryDataTransfer/README.md index bd1a497084f..b673d37eb29 100644 --- a/BigQueryDataTransfer/README.md +++ b/BigQueryDataTransfer/README.md @@ -44,6 +44,11 @@ $formattedLocation = $dataTransferServiceClient->locationName($projectId, $locat $dataSources = $dataTransferServiceClient->listDataSources($formattedLocation); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQueryMigration/README.md b/BigQueryMigration/README.md index 7d109742bdb..fb2e85511e6 100644 --- a/BigQueryMigration/README.md +++ b/BigQueryMigration/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQueryReservation/README.md b/BigQueryReservation/README.md index 437601801ae..119c1f78f84 100644 --- a/BigQueryReservation/README.md +++ b/BigQueryReservation/README.md @@ -47,6 +47,11 @@ $reservation = $client->createReservation($parent, [ ]) ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BigQueryStorage/README.md b/BigQueryStorage/README.md index 6f6dcddea31..ca3c3a6f2b3 100644 --- a/BigQueryStorage/README.md +++ b/BigQueryStorage/README.md @@ -74,6 +74,11 @@ foreach ($stream->readAll() as $response) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Bigtable/README.md b/Bigtable/README.md index c8b4acaccb4..59f915b6d64 100644 --- a/Bigtable/README.md +++ b/Bigtable/README.md @@ -61,6 +61,11 @@ foreach ($rows as $row) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Billing/README.md b/Billing/README.md index 1680e47bf72..cd360d2114e 100644 --- a/Billing/README.md +++ b/Billing/README.md @@ -43,6 +43,11 @@ foreach ($accounts as $account) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BillingBudgets/README.md b/BillingBudgets/README.md index 021b4da789c..355ffcbe7ec 100644 --- a/BillingBudgets/README.md +++ b/BillingBudgets/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/BinaryAuthorization/README.md b/BinaryAuthorization/README.md index 8ec74bae233..c0cf60c3729 100644 --- a/BinaryAuthorization/README.md +++ b/BinaryAuthorization/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Build/README.md b/Build/README.md index 4388a0c81f1..9b6c85f9671 100644 --- a/Build/README.md +++ b/Build/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/CertificateManager/README.md b/CertificateManager/README.md index 4c95bd3fa96..cec62ab50aa 100644 --- a/CertificateManager/README.md +++ b/CertificateManager/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Channel/README.md b/Channel/README.md index ed8ccacb15a..dcf0ff72a27 100644 --- a/Channel/README.md +++ b/Channel/README.md @@ -44,6 +44,11 @@ foreach ($customers as $customer) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/CommerceConsumerProcurement/README.md b/CommerceConsumerProcurement/README.md index 60bb6c00355..7ffc22294d2 100644 --- a/CommerceConsumerProcurement/README.md +++ b/CommerceConsumerProcurement/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-commerce-consumer-procurement/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Compute/README.md b/Compute/README.md index 9e1567fc9df..3665c519acc 100644 --- a/Compute/README.md +++ b/Compute/README.md @@ -40,6 +40,11 @@ foreach ($instances->list('[MY_PROJECT_ID]', 'us-west1') as $instance) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ConfidentialComputing/README.md b/ConfidentialComputing/README.md index 5f1e7499735..beeabdc2769 100644 --- a/ConfidentialComputing/README.md +++ b/ConfidentialComputing/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-confidentialcomputing/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Config/README.md b/Config/README.md index 9771c177c3d..86dcaaa7b9c 100644 --- a/Config/README.md +++ b/Config/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-config/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ContactCenterInsights/README.md b/ContactCenterInsights/README.md index 104cdce2405..417645e8a16 100644 --- a/ContactCenterInsights/README.md +++ b/ContactCenterInsights/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Container/README.md b/Container/README.md index 60ea0219951..e8bbfd5de47 100644 --- a/Container/README.md +++ b/Container/README.md @@ -54,6 +54,11 @@ try { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ContainerAnalysis/README.md b/ContainerAnalysis/README.md index c13724306a0..65f29500715 100644 --- a/ContainerAnalysis/README.md +++ b/ContainerAnalysis/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ControlsPartner/README.md b/ControlsPartner/README.md index 8968c492849..69fa709d73c 100644 --- a/ControlsPartner/README.md +++ b/ControlsPartner/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-cloudcontrolspartner/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/Core/README.md b/Core/README.md index 8c5e4b332af..0f9dde29ced 100644 --- a/Core/README.md +++ b/Core/README.md @@ -17,6 +17,11 @@ to the rest of the Google Cloud PHP components. $ composer require google/cloud-core ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DataCatalog/README.md b/DataCatalog/README.md index d4af5573713..d066f7729cf 100644 --- a/DataCatalog/README.md +++ b/DataCatalog/README.md @@ -43,6 +43,11 @@ $entryGroup = $client->createEntryGroup($location, 'sample_entry_group'); printf('Created entry group: %s' . PHP_EOL, $entryGroup->getName()); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DataCatalogLineage/README.md b/DataCatalogLineage/README.md index 1ac99dafb72..3e0a267327c 100644 --- a/DataCatalogLineage/README.md +++ b/DataCatalogLineage/README.md @@ -32,6 +32,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](samples/) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DataFusion/README.md b/DataFusion/README.md index 450c83b2a85..02df22bcc18 100644 --- a/DataFusion/README.md +++ b/DataFusion/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DataLabeling/README.md b/DataLabeling/README.md index 40d72389b73..dcbf2660683 100644 --- a/DataLabeling/README.md +++ b/DataLabeling/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/Dataflow/README.md b/Dataflow/README.md index a23d657a875..9896c2cd676 100644 --- a/Dataflow/README.md +++ b/Dataflow/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/Dataform/README.md b/Dataform/README.md index f18337c47f2..b3dad4ac225 100644 --- a/Dataform/README.md +++ b/Dataform/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. diff --git a/Dataplex/README.md b/Dataplex/README.md index 5aa7ef97753..8f733c0a2cc 100644 --- a/Dataplex/README.md +++ b/Dataplex/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Dataproc/README.md b/Dataproc/README.md index ef7e35ee7c9..90b8c46592c 100644 --- a/Dataproc/README.md +++ b/Dataproc/README.md @@ -61,6 +61,11 @@ $jobControllerClient = new JobControllerClient(); $submittedJob = $jobControllerClient->submitJob($projectId, $region, $job); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DataprocMetastore/README.md b/DataprocMetastore/README.md index 21262c935be..864a92eadfc 100644 --- a/DataprocMetastore/README.md +++ b/DataprocMetastore/README.md @@ -29,6 +29,11 @@ Please see our [Authentication guide](https://github.com/googleapis/google-cloud on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Datastore/README.md b/Datastore/README.md index f15f9cc1a80..ac413a65cff 100644 --- a/Datastore/README.md +++ b/Datastore/README.md @@ -54,6 +54,11 @@ $key = $datastore->key('Person', '12345328897844'); $entity = $datastore->lookup($key); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DatastoreAdmin/README.md b/DatastoreAdmin/README.md index ce5240dbcf3..96764fb0735 100644 --- a/DatastoreAdmin/README.md +++ b/DatastoreAdmin/README.md @@ -41,6 +41,11 @@ foreach ($indexes as $index) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Datastream/README.md b/Datastream/README.md index e17d53eca05..7f9700f3b42 100644 --- a/Datastream/README.md +++ b/Datastream/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Debugger/README.md b/Debugger/README.md index 05b0aba7d8d..663069f6651 100644 --- a/Debugger/README.md +++ b/Debugger/README.md @@ -131,6 +131,11 @@ $agent = new Google\Cloud\Debugger\Agent([ See [Using Debug Logpoints][using-debug-logpoints] for more information on logpoints. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Deploy/README.md b/Deploy/README.md index 4d855f34016..8b8b711bea0 100644 --- a/Deploy/README.md +++ b/Deploy/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DeveloperConnect/README.md b/DeveloperConnect/README.md index 60fe21d00c0..6d3e2078165 100644 --- a/DeveloperConnect/README.md +++ b/DeveloperConnect/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-developerconnect/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/Dialogflow/README.md b/Dialogflow/README.md index f57f2e27537..3be307e0f38 100644 --- a/Dialogflow/README.md +++ b/Dialogflow/README.md @@ -57,6 +57,11 @@ foreach ($entityType->getEntities() as $entity) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DialogflowCx/README.md b/DialogflowCx/README.md index a4d07a59723..e4e8df0c0f1 100644 --- a/DialogflowCx/README.md +++ b/DialogflowCx/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-dialogflow-cx/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/DiscoveryEngine/README.md b/DiscoveryEngine/README.md index cce0e8ba04d..85dac5c2f78 100644 --- a/DiscoveryEngine/README.md +++ b/DiscoveryEngine/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-discoveryengine/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Dlp/README.md b/Dlp/README.md index 48b9b252654..e0b08fe3094 100644 --- a/Dlp/README.md +++ b/Dlp/README.md @@ -64,6 +64,11 @@ foreach ($findings as $finding) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Dms/README.md b/Dms/README.md index 319bc137ac1..aeab6cd119f 100644 --- a/Dms/README.md +++ b/Dms/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/DocumentAi/README.md b/DocumentAi/README.md index 6a3ea4beac7..886b2250282 100644 --- a/DocumentAi/README.md +++ b/DocumentAi/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Domains/README.md b/Domains/README.md index 1d96b963b45..22f60448be1 100644 --- a/Domains/README.md +++ b/Domains/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/EdgeNetwork/README.md b/EdgeNetwork/README.md index 02ef688c137..356c1089b0c 100644 --- a/EdgeNetwork/README.md +++ b/EdgeNetwork/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-edgenetwork/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ErrorReporting/README.md b/ErrorReporting/README.md index 35e54d9866d..2e83f860970 100644 --- a/ErrorReporting/README.md +++ b/ErrorReporting/README.md @@ -77,6 +77,11 @@ try { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/EssentialContacts/README.md b/EssentialContacts/README.md index c992cdebfaf..6364e330066 100644 --- a/EssentialContacts/README.md +++ b/EssentialContacts/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Eventarc/README.md b/Eventarc/README.md index 837f2c2de06..b58e41f1ab1 100644 --- a/Eventarc/README.md +++ b/Eventarc/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/EventarcPublishing/README.md b/EventarcPublishing/README.md index da89b94bf08..9d790583c6e 100644 --- a/EventarcPublishing/README.md +++ b/EventarcPublishing/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Filestore/README.md b/Filestore/README.md index c3c06a8bcf8..6b031d29f98 100644 --- a/Filestore/README.md +++ b/Filestore/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Firestore/README.md b/Firestore/README.md index d45e13822d2..62dc866de05 100644 --- a/Firestore/README.md +++ b/Firestore/README.md @@ -49,6 +49,11 @@ $snapshot = $documentReference->snapshot(); echo "Hello " . $snapshot['firstName']; ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Functions/README.md b/Functions/README.md index fa152f21d7e..605f5908b33 100644 --- a/Functions/README.md +++ b/Functions/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/GSuiteAddOns/README.md b/GSuiteAddOns/README.md index 7defc0ed524..81b2dd013b5 100644 --- a/GSuiteAddOns/README.md +++ b/GSuiteAddOns/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/GkeBackup/README.md b/GkeBackup/README.md index e58cd1368cb..02c0ecd6ef7 100644 --- a/GkeBackup/README.md +++ b/GkeBackup/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/GkeConnectGateway/README.md b/GkeConnectGateway/README.md index 56a2963ee5f..dd6a1af7018 100644 --- a/GkeConnectGateway/README.md +++ b/GkeConnectGateway/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/GkeHub/README.md b/GkeHub/README.md index 4a33d50d227..79012a541f1 100644 --- a/GkeHub/README.md +++ b/GkeHub/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/GkeMultiCloud/README.md b/GkeMultiCloud/README.md index 86453b203ed..a5a3295d5ba 100644 --- a/GkeMultiCloud/README.md +++ b/GkeMultiCloud/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Grafeas/README.md b/Grafeas/README.md index cefdfa0d360..34b58b95758 100644 --- a/Grafeas/README.md +++ b/Grafeas/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Iam/README.md b/Iam/README.md index 2aceb82fc15..4ef60657128 100644 --- a/Iam/README.md +++ b/Iam/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/IamCredentials/README.md b/IamCredentials/README.md index 2f9a60a3868..4030d96c873 100644 --- a/IamCredentials/README.md +++ b/IamCredentials/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Iap/README.md b/Iap/README.md index 54e06ae8a64..244814048fc 100644 --- a/Iap/README.md +++ b/Iap/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Ids/README.md b/Ids/README.md index 09440faf5b8..85bcf5b15be 100644 --- a/Ids/README.md +++ b/Ids/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Kms/README.md b/Kms/README.md index 44318d01100..1c706f389d1 100644 --- a/Kms/README.md +++ b/Kms/README.md @@ -85,6 +85,11 @@ $plainText = $response->getPlaintext(); assert($secret === $plainText); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/KmsInventory/README.md b/KmsInventory/README.md index bc346a4eae8..b69fd4f497f 100644 --- a/KmsInventory/README.md +++ b/KmsInventory/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-kms-inventory/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Language/README.md b/Language/README.md index 2e8488ad081..5d451c210b7 100644 --- a/Language/README.md +++ b/Language/README.md @@ -60,6 +60,11 @@ foreach ($tokens as $token) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/LifeSciences/README.md b/LifeSciences/README.md index 5f60644a1af..059f4070e86 100644 --- a/LifeSciences/README.md +++ b/LifeSciences/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/Logging/README.md b/Logging/README.md index af9e72998bd..24fe5fdd8ef 100644 --- a/Logging/README.md +++ b/Logging/README.md @@ -56,6 +56,11 @@ foreach ($entries as $entry) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/LongRunning/README.md b/LongRunning/README.md index 47c49d30226..2b34d4f2982 100644 --- a/LongRunning/README.md +++ b/LongRunning/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/ManagedIdentities/README.md b/ManagedIdentities/README.md index c6323549bf3..fa008437087 100644 --- a/ManagedIdentities/README.md +++ b/ManagedIdentities/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ManagedKafka/README.md b/ManagedKafka/README.md index 51252e388f1..67a729e81c7 100644 --- a/ManagedKafka/README.md +++ b/ManagedKafka/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-managedkafka/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/MapsFleetEngine/README.md b/MapsFleetEngine/README.md index e5751c6ee43..c161ce42453 100644 --- a/MapsFleetEngine/README.md +++ b/MapsFleetEngine/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-maps-fleetengine/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/MapsFleetEngineDelivery/README.md b/MapsFleetEngineDelivery/README.md index e588ebf83fd..204d2b57714 100644 --- a/MapsFleetEngineDelivery/README.md +++ b/MapsFleetEngineDelivery/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-maps-fleetengine-delivery/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/MapsRouteOptimization/README.md b/MapsRouteOptimization/README.md index af28ca68434..df18f080e37 100644 --- a/MapsRouteOptimization/README.md +++ b/MapsRouteOptimization/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-maps-routeoptimization/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/MediaTranslation/README.md b/MediaTranslation/README.md index 0525cef15af..2831caff3f8 100644 --- a/MediaTranslation/README.md +++ b/MediaTranslation/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/Memcache/README.md b/Memcache/README.md index 6dd463302e0..e4695f07c79 100644 --- a/Memcache/README.md +++ b/Memcache/README.md @@ -45,6 +45,11 @@ foreach ($client->listInstances($location) as $response) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/MigrationCenter/README.md b/MigrationCenter/README.md index e328ec5523a..0573b970bb1 100644 --- a/MigrationCenter/README.md +++ b/MigrationCenter/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-migrationcenter/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Monitoring/README.md b/Monitoring/README.md index 7883496c56d..3b59cce93ac 100644 --- a/Monitoring/README.md +++ b/Monitoring/README.md @@ -82,6 +82,11 @@ try { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in @@ -91,4 +96,3 @@ any minor or patch releases. We will address issues and requests with the highes 1. Understand the [official documentation](https://cloud.google.com/monitoring/docs/). 2. Take a look at [in-depth usage samples](https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/monitoring/). - diff --git a/NetApp/README.md b/NetApp/README.md index b02cc3c4faf..85ac11fa76f 100644 --- a/NetApp/README.md +++ b/NetApp/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-netapp/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/NetworkConnectivity/README.md b/NetworkConnectivity/README.md index 12c933ace43..3bf0f520808 100644 --- a/NetworkConnectivity/README.md +++ b/NetworkConnectivity/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/NetworkManagement/README.md b/NetworkManagement/README.md index ffa1dfbaf87..62a8c3a6c58 100644 --- a/NetworkManagement/README.md +++ b/NetworkManagement/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/NetworkSecurity/README.md b/NetworkSecurity/README.md index c9dc0ac30cf..4729e0227c1 100644 --- a/NetworkSecurity/README.md +++ b/NetworkSecurity/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/NetworkServices/README.md b/NetworkServices/README.md index 688292532f5..832a6b5951d 100644 --- a/NetworkServices/README.md +++ b/NetworkServices/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-networkservices/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/Notebooks/README.md b/Notebooks/README.md index 6439f55bb67..07d437581f4 100644 --- a/Notebooks/README.md +++ b/Notebooks/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Optimization/README.md b/Optimization/README.md index 143a597dce5..badd51f6252 100644 --- a/Optimization/README.md +++ b/Optimization/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/OracleDatabase/README.md b/OracleDatabase/README.md index e6e431b4cef..492d174a60c 100644 --- a/OracleDatabase/README.md +++ b/OracleDatabase/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-oracledatabase/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/OrchestrationAirflow/README.md b/OrchestrationAirflow/README.md index 00e2a9e1a1b..e8ac627aed1 100644 --- a/OrchestrationAirflow/README.md +++ b/OrchestrationAirflow/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/OrgPolicy/README.md b/OrgPolicy/README.md index c5642d44ebb..c86c21c1fd3 100644 --- a/OrgPolicy/README.md +++ b/OrgPolicy/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/OsConfig/README.md b/OsConfig/README.md index c25108217e4..b940e2e857f 100644 --- a/OsConfig/README.md +++ b/OsConfig/README.md @@ -46,6 +46,11 @@ foreach ($jobs as $job) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/OsLogin/README.md b/OsLogin/README.md index 96c7019e4c4..34999794690 100644 --- a/OsLogin/README.md +++ b/OsLogin/README.md @@ -44,6 +44,11 @@ $formattedName = $osLoginServiceClient->userName($userId); $loginProfile = $osLoginServiceClient->getLoginProfile($formattedName); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Parallelstore/README.md b/Parallelstore/README.md index 7f7570b4f78..9999deb52b0 100644 --- a/Parallelstore/README.md +++ b/Parallelstore/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-parallelstore/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/PolicySimulator/README.md b/PolicySimulator/README.md index d72681119a5..54dbe57c16b 100644 --- a/PolicySimulator/README.md +++ b/PolicySimulator/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-policysimulator/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/PolicyTroubleshooter/README.md b/PolicyTroubleshooter/README.md index 507c8006c0b..03d040b1834 100644 --- a/PolicyTroubleshooter/README.md +++ b/PolicyTroubleshooter/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/PolicyTroubleshooterIam/README.md b/PolicyTroubleshooterIam/README.md index 46b60041fad..1651af75c3a 100644 --- a/PolicyTroubleshooterIam/README.md +++ b/PolicyTroubleshooterIam/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-policytroubleshooter-iam/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/PrivateCatalog/README.md b/PrivateCatalog/README.md index d3000bb6715..61be005f9d4 100644 --- a/PrivateCatalog/README.md +++ b/PrivateCatalog/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly diff --git a/PrivilegedAccessManager/README.md b/PrivilegedAccessManager/README.md index 4236f2abd42..9ff1c90482e 100644 --- a/PrivilegedAccessManager/README.md +++ b/PrivilegedAccessManager/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-privilegedaccessmanager/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/Profiler/README.md b/Profiler/README.md index 7c156e981c6..6a9a1cafb08 100644 --- a/Profiler/README.md +++ b/Profiler/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/PubSub/README.md b/PubSub/README.md index 4f56c826990..4e3ed2afb87 100644 --- a/PubSub/README.md +++ b/PubSub/README.md @@ -62,6 +62,11 @@ foreach ($messages as $message) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Quotas/README.md b/Quotas/README.md index b8a730c0379..b8411a7fb54 100644 --- a/Quotas/README.md +++ b/Quotas/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-quotas/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/README.md b/README.md index 09402859dc2..00813d4287a 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,11 @@ $cloud = new StorageClient(); The `GOOGLE_APPLICATION_CREDENTIALS` environment variable may be set in your server configuration. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### gRPC and Protobuf Many clients in Google Cloud PHP offer support for gRPC, either as an option or a requirement. gRPC is a high-performance RPC framework created by Google. To use gRPC in PHP, you must install the gRPC PHP extension on your server. While not required, it is also recommended that you install the protobuf extension whenever using gRPC in production. diff --git a/RapidMigrationAssessment/README.md b/RapidMigrationAssessment/README.md index a97d37506ea..ff4d5700af8 100644 --- a/RapidMigrationAssessment/README.md +++ b/RapidMigrationAssessment/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-rapidmigrationassessment/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/RecaptchaEnterprise/README.md b/RecaptchaEnterprise/README.md index 9522c608fb4..3cef165023f 100644 --- a/RecaptchaEnterprise/README.md +++ b/RecaptchaEnterprise/README.md @@ -55,6 +55,11 @@ $response = $client->createKey($project, $key); printf('Created key: %s' . PHP_EOL, $response->getName()); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/RecommendationEngine/README.md b/RecommendationEngine/README.md index e7957470576..c856e3758c5 100644 --- a/RecommendationEngine/README.md +++ b/RecommendationEngine/README.md @@ -47,6 +47,11 @@ $userEvent = new UserEvent(); $predictions = $predictionServiceClient->predict($formattedName, $userEvent); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered beta. As such, it should be expected to be mostly stable and we're working towards a release candidate. We will address issues and requests with a higher priority. diff --git a/Recommender/README.md b/Recommender/README.md index 17edc51cdcb..b79fbe20bcc 100644 --- a/Recommender/README.md +++ b/Recommender/README.md @@ -53,6 +53,11 @@ foreach ($recommendations as $recommendation) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Redis/README.md b/Redis/README.md index bb934175293..68d1b6673bb 100644 --- a/Redis/README.md +++ b/Redis/README.md @@ -52,6 +52,11 @@ foreach ($response->iterateAllElements() as $instance) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/RedisCluster/README.md b/RedisCluster/README.md index f79bb2d6ddc..4c15cacf7b5 100644 --- a/RedisCluster/README.md +++ b/RedisCluster/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-redis-cluster/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ResourceManager/README.md b/ResourceManager/README.md index cfa1af32f22..719c2df3655 100644 --- a/ResourceManager/README.md +++ b/ResourceManager/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ResourceSettings/README.md b/ResourceSettings/README.md index 3aec27c5f79..40ca6099fcc 100644 --- a/ResourceSettings/README.md +++ b/ResourceSettings/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Retail/README.md b/Retail/README.md index 712efd6496c..31f6d37c9ef 100644 --- a/Retail/README.md +++ b/Retail/README.md @@ -46,6 +46,11 @@ foreach ($catalogs as $catalog) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Run/README.md b/Run/README.md index 9c669e5a211..0fea7de3029 100644 --- a/Run/README.md +++ b/Run/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Scheduler/README.md b/Scheduler/README.md index b8c929d32a0..2c80b09a0d9 100644 --- a/Scheduler/README.md +++ b/Scheduler/README.md @@ -64,6 +64,11 @@ foreach ($client->listJobs($parent) as $job) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/SecretManager/README.md b/SecretManager/README.md index 031eddb815f..dab5f064a50 100644 --- a/SecretManager/README.md +++ b/SecretManager/README.md @@ -56,6 +56,11 @@ printf( ); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/SecureSourceManager/README.md b/SecureSourceManager/README.md index cf77ada2abe..06fd1cc1980 100644 --- a/SecureSourceManager/README.md +++ b/SecureSourceManager/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-securesourcemanager/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/SecurityCenter/README.md b/SecurityCenter/README.md index 91f487e16ed..332c3f5c217 100644 --- a/SecurityCenter/README.md +++ b/SecurityCenter/README.md @@ -41,6 +41,11 @@ $source = new Source([ $res = $security->createSource($parent, $source); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/SecurityCenterManagement/README.md b/SecurityCenterManagement/README.md index bb2492b4936..705013af5a4 100644 --- a/SecurityCenterManagement/README.md +++ b/SecurityCenterManagement/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-securitycentermanagement/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/SecurityPrivateCa/README.md b/SecurityPrivateCa/README.md index d24ae606c93..8f31a6b69ca 100644 --- a/SecurityPrivateCa/README.md +++ b/SecurityPrivateCa/README.md @@ -50,6 +50,11 @@ foreach ($authorities as $authority) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/SecurityPublicCA/README.md b/SecurityPublicCA/README.md index 311cf9f5fb7..c7b82072c1a 100644 --- a/SecurityPublicCA/README.md +++ b/SecurityPublicCA/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ServiceControl/README.md b/ServiceControl/README.md index cecdc03bbc5..5b75fc9c488 100644 --- a/ServiceControl/README.md +++ b/ServiceControl/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ServiceDirectory/README.md b/ServiceDirectory/README.md index e606c3e04c7..a03d7345203 100644 --- a/ServiceDirectory/README.md +++ b/ServiceDirectory/README.md @@ -59,6 +59,11 @@ printf( ); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ServiceHealth/README.md b/ServiceHealth/README.md index e83b1f3e235..039f2470c18 100644 --- a/ServiceHealth/README.md +++ b/ServiceHealth/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-servicehealth/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ServiceManagement/README.md b/ServiceManagement/README.md index 9a91ca5d90d..5ad80d34b62 100644 --- a/ServiceManagement/README.md +++ b/ServiceManagement/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ServiceUsage/README.md b/ServiceUsage/README.md index dce1d304b80..9253fefd9a8 100644 --- a/ServiceUsage/README.md +++ b/ServiceUsage/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Shell/README.md b/Shell/README.md index df42e9d6375..6e05370f32a 100644 --- a/Shell/README.md +++ b/Shell/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/ShoppingCss/README.md b/ShoppingCss/README.md index 61a237c6665..3b9c85ea879 100644 --- a/ShoppingCss/README.md +++ b/ShoppingCss/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-css/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantAccounts/README.md b/ShoppingMerchantAccounts/README.md index 0a7324131e5..a3db5be269d 100644 --- a/ShoppingMerchantAccounts/README.md +++ b/ShoppingMerchantAccounts/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-accounts/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantConversions/README.md b/ShoppingMerchantConversions/README.md index 197c1365dde..9155bc92571 100644 --- a/ShoppingMerchantConversions/README.md +++ b/ShoppingMerchantConversions/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-conversions/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantDataSources/README.md b/ShoppingMerchantDataSources/README.md index 56dfac0a1fe..4c48eb9cd8f 100644 --- a/ShoppingMerchantDataSources/README.md +++ b/ShoppingMerchantDataSources/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-datasources/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantInventories/README.md b/ShoppingMerchantInventories/README.md index 2c2071b6c9b..4de91a4b3bd 100644 --- a/ShoppingMerchantInventories/README.md +++ b/ShoppingMerchantInventories/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-inventories/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantLfp/README.md b/ShoppingMerchantLfp/README.md index 48e6065a8dd..2efae3e3d91 100644 --- a/ShoppingMerchantLfp/README.md +++ b/ShoppingMerchantLfp/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-lfp/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantNotifications/README.md b/ShoppingMerchantNotifications/README.md index 9c0bb8642f3..3f4c0443a21 100644 --- a/ShoppingMerchantNotifications/README.md +++ b/ShoppingMerchantNotifications/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-notifications/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantProducts/README.md b/ShoppingMerchantProducts/README.md index 7bf028ac3bb..2c14a905ca1 100644 --- a/ShoppingMerchantProducts/README.md +++ b/ShoppingMerchantProducts/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-products/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantPromotions/README.md b/ShoppingMerchantPromotions/README.md index 359f6f1f5fe..a19cbc418af 100644 --- a/ShoppingMerchantPromotions/README.md +++ b/ShoppingMerchantPromotions/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-promotions/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantQuota/README.md b/ShoppingMerchantQuota/README.md index 50f4e9ab379..4137cd85f15 100644 --- a/ShoppingMerchantQuota/README.md +++ b/ShoppingMerchantQuota/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-quota/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/ShoppingMerchantReports/README.md b/ShoppingMerchantReports/README.md index d32a14b060b..87407fd84ba 100644 --- a/ShoppingMerchantReports/README.md +++ b/ShoppingMerchantReports/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/php-shopping-merchant-reports/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/Spanner/README.md b/Spanner/README.md index e8d108f1432..7bafed0715e 100644 --- a/Spanner/README.md +++ b/Spanner/README.md @@ -104,6 +104,11 @@ $sessionPool->warmup(); By using a cache implementation like `SysVCacheItemPool`, you can share the cached sessions among multiple processes, so that for example, you can warmup the session upon the server startup, then all the other PHP processes will benefit from the warmed up sessions. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Speech/README.md b/Speech/README.md index 056d49c409a..36060b56aae 100644 --- a/Speech/README.md +++ b/Speech/README.md @@ -58,6 +58,11 @@ foreach ($responses as $element) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in @@ -67,4 +72,3 @@ any minor or patch releases. We will address issues and requests with the highes 1. Understand the [official documentation](https://cloud.google.com/speech/docs/). 2. Take a look at [in-depth usage samples](https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/speech/). - diff --git a/SqlAdmin/README.md b/SqlAdmin/README.md index 2f3b0b175e5..c154d0cd8d8 100644 --- a/SqlAdmin/README.md +++ b/SqlAdmin/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Storage/README.md b/Storage/README.md index 9837283d05a..6c3afffe7a8 100644 --- a/Storage/README.md +++ b/Storage/README.md @@ -71,6 +71,11 @@ $storage->registerStreamWrapper(); $contents = file_get_contents('gs://my_bucket/file_backup.txt'); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/StorageControl/README.md b/StorageControl/README.md index 7c7bf9f6266..d9647a3d786 100644 --- a/StorageControl/README.md +++ b/StorageControl/README.md @@ -35,6 +35,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-storage-control/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/StorageInsights/README.md b/StorageInsights/README.md index 68f40d673e1..add3086aa4d 100644 --- a/StorageInsights/README.md +++ b/StorageInsights/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](samples/) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/StorageTransfer/README.md b/StorageTransfer/README.md index aaeafda129a..5a01d4942ca 100644 --- a/StorageTransfer/README.md +++ b/StorageTransfer/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Support/README.md b/Support/README.md index 8f4828f57ce..b4155265e1c 100644 --- a/Support/README.md +++ b/Support/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](samples/) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Talent/README.md b/Talent/README.md index 3aae1095420..d441caa6133 100644 --- a/Talent/README.md +++ b/Talent/README.md @@ -47,6 +47,11 @@ $response = $client->createCompany( ); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Tasks/README.md b/Tasks/README.md index 3e5dcf62a7a..1c4b45742dc 100644 --- a/Tasks/README.md +++ b/Tasks/README.md @@ -65,6 +65,11 @@ foreach ($resp->iterateAllElements() as $q) { $client->deleteQueue($queueName); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/TelcoAutomation/README.md b/TelcoAutomation/README.md index 0357ad7ae7d..b8597f38739 100644 --- a/TelcoAutomation/README.md +++ b/TelcoAutomation/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-telcoautomation/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/TextToSpeech/README.md b/TextToSpeech/README.md index 5db48766993..bef9bdb1c8f 100644 --- a/TextToSpeech/README.md +++ b/TextToSpeech/README.md @@ -49,6 +49,11 @@ $resp = $textToSpeechClient->synthesizeSpeech($input, $voice, $audioConfig); file_put_contents('test.mp3', $resp->getAudioContent()); ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Tpu/README.md b/Tpu/README.md index 38c43d662ed..0332c8a3ae6 100644 --- a/Tpu/README.md +++ b/Tpu/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Trace/README.md b/Trace/README.md index 2f60213079e..538cc7abbce 100644 --- a/Trace/README.md +++ b/Trace/README.md @@ -104,6 +104,11 @@ Tracer::start(new StackdriverExporter()); See the [OpenCensus documentation][opencensus-php] for more configuration options and features. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Translate/README.md b/Translate/README.md index 70d2ae3d278..711483f4bfb 100644 --- a/Translate/README.md +++ b/Translate/README.md @@ -106,6 +106,11 @@ REST & HTTP/1.1 only. The handwritten client can be found under `Google\Cloud\Translate\TranslateClient`, whereas the generated client is found under `Google\Cloud\Translate\V3\TranslationServiceClient`. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/VideoIntelligence/README.md b/VideoIntelligence/README.md index 5d2b8087dbb..c332fdefe48 100644 --- a/VideoIntelligence/README.md +++ b/VideoIntelligence/README.md @@ -83,6 +83,11 @@ if ($operationResponse->operationSucceeded()) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in @@ -92,4 +97,3 @@ any minor or patch releases. We will address issues and requests with the highes 1. Understand the [official documentation](https://cloud.google.com/video-intelligence/docs/). 2. Take a look at [in-depth usage samples](https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/video/). - diff --git a/VideoLiveStream/README.md b/VideoLiveStream/README.md index 621ec25d4bd..97b01021d7d 100644 --- a/VideoLiveStream/README.md +++ b/VideoLiveStream/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/VideoStitcher/README.md b/VideoStitcher/README.md index ab08dae7670..ddf14f202bb 100644 --- a/VideoStitcher/README.md +++ b/VideoStitcher/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/VideoTranscoder/README.md b/VideoTranscoder/README.md index e4fbc0de146..9c08f9cd302 100644 --- a/VideoTranscoder/README.md +++ b/VideoTranscoder/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Vision/README.md b/Vision/README.md index bafc0b220a8..f79aeeefdab 100644 --- a/Vision/README.md +++ b/Vision/README.md @@ -52,6 +52,11 @@ foreach ($annotation->getFaceAnnotations() as $faceAnnotation) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in @@ -61,4 +66,3 @@ any minor or patch releases. We will address issues and requests with the highes 1. Understand the [official documentation](https://cloud.google.com/vision/docs/). 2. Take a look at [in-depth usage samples](https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/vision/). - diff --git a/VmMigration/README.md b/VmMigration/README.md index 076f6871164..34bc9aba17b 100644 --- a/VmMigration/README.md +++ b/VmMigration/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/VmwareEngine/README.md b/VmwareEngine/README.md index c70ff514794..712daa70d67 100644 --- a/VmwareEngine/README.md +++ b/VmwareEngine/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/VpcAccess/README.md b/VpcAccess/README.md index a3875026990..238fd25e685 100644 --- a/VpcAccess/README.md +++ b/VpcAccess/README.md @@ -28,6 +28,11 @@ please see our [gRPC installation guide](https://cloud.google.com/php/grpc). Please see our [Authentication guide](https://github.com/googleapis/google-cloud-php/blob/main/AUTHENTICATION.md) for more information on authenticating your client. Once authenticated, you'll be ready to start making requests. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/WebRisk/README.md b/WebRisk/README.md index 73e3c8c2567..e8a03b6da13 100644 --- a/WebRisk/README.md +++ b/WebRisk/README.md @@ -51,6 +51,11 @@ if ($threats) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/WebSecurityScanner/README.md b/WebSecurityScanner/README.md index 744b1b8bd24..9c8fb6cc120 100644 --- a/WebSecurityScanner/README.md +++ b/WebSecurityScanner/README.md @@ -52,6 +52,11 @@ $scanRun = $client->startScanRun($scanConfig->getName()); echo 'Scan execution state: ' . ExecutionState::name($scanRun->getExecutionState()) . PHP_EOL; ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/Workflows/README.md b/Workflows/README.md index 5eef1037f67..018008d9656 100644 --- a/Workflows/README.md +++ b/Workflows/README.md @@ -46,6 +46,11 @@ foreach ($workflows as $workflow) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in diff --git a/dev/tests/fixtures/component/CustomInput/README.md b/dev/tests/fixtures/component/CustomInput/README.md index 6a39f21936c..13542608f9a 100644 --- a/dev/tests/fixtures/component/CustomInput/README.md +++ b/dev/tests/fixtures/component/CustomInput/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-custom-repo/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/dev/tests/fixtures/component/SecretManager/README.md b/dev/tests/fixtures/component/SecretManager/README.md index 2c92f6419dd..62c96f9ec9f 100644 --- a/dev/tests/fixtures/component/SecretManager/README.md +++ b/dev/tests/fixtures/component/SecretManager/README.md @@ -36,6 +36,11 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/googleapis/google-cloud-php-secretmanager/tree/main/samples) for a canonical list of samples. +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered alpha. As such, it is still a work-in-progress and is more likely to get backwards-incompatible updates. diff --git a/dev/tests/fixtures/component/Vision/README.md b/dev/tests/fixtures/component/Vision/README.md index bafc0b220a8..f79aeeefdab 100644 --- a/dev/tests/fixtures/component/Vision/README.md +++ b/dev/tests/fixtures/component/Vision/README.md @@ -52,6 +52,11 @@ foreach ($annotation->getFaceAnnotations() as $faceAnnotation) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in @@ -61,4 +66,3 @@ any minor or patch releases. We will address issues and requests with the highes 1. Understand the [official documentation](https://cloud.google.com/vision/docs/). 2. Take a look at [in-depth usage samples](https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/vision/). - From 3528513c935134efb9bac6affc28da6ef8449047 Mon Sep 17 00:00:00 2001 From: Hector Mendoza Jacobo Date: Tue, 3 Dec 2024 22:40:40 +0000 Subject: [PATCH 4/7] Edit DEBUG.md and add some example logs --- DEBUG.md | 108 +++++++++++++++++++++-- dev/tests/fixtures/docfx/Vision/index.md | 6 +- 2 files changed, 106 insertions(+), 8 deletions(-) diff --git a/DEBUG.md b/DEBUG.md index 82ed1f74d5e..cda1fda95bd 100644 --- a/DEBUG.md +++ b/DEBUG.md @@ -1,18 +1,18 @@ -# Debugging logs +# Debugging -We have support for simple debugging in our libraries. This debugging support logs the requests that -the Client Libraries are performing internally and provides a quick glance of what the request and -response contains. +There are a few features built into the Google Cloud PHP client libraries which can help you debug +your application. This guide will show you how to enable logging the requests and responses the +client libraries are performing internally. > :warning: > > These logs are not intended to be used in production and is meant to be used for quickly -> debugging a project. The logs consists on basic logging into the STDOUT of your system which may +> debugging a project. The logs consists of basic logging into the STDOUT of your system which may > or may not include sensitive information. Make sure that once you are done debugging to disable -> the debugging flag or configuration used to avoid leaking sensitive user data, This may also +> the debugging flag or configuration used to avoid leaking sensitive user data. This may also > include authentication tokens. -## Debugging usage +## Configuration There are multiple ways to configure the debugging logs which we will go through in this document. @@ -36,6 +36,100 @@ $request->setParent('projects/php-docs-samples-kokoro'); $response = $client->translateText($request); ``` +Logs usually come with a request log and a response log the exception being streaming requests +where depending on the type of streaming it logs each stream packet. This means that if the client performs a request to the auth server it will also log that request-response pair before the main request. + +
+Log examples + +### Request example log +```json +{ + "timestamp": "2024-12-03T15:21:47-05:00", + "severity": "DEBUG", + "clientId": 83, + "requestId": 2435, + "jsonPayload": { + "request.method": "POST", + "request.url": "https://translate.googleapis.com/v3/projects/" + ], + "x-goog-request-params": [ + "parent=projects%2F" + ], + "authorization": [ + "Bearer " + ] + }, + "request.payload": "{\"contents\":[\"こんにちは\"],\"targetLanguageCode\":\"en-US\",\"parent\":\"projects\\/\"}" + } +} +``` + +### Response example log +```json +{ + "timestamp": "2024-12-03T15:21:47-05:00", + "severity": "DEBUG", + "clientId": 83, + "requestId": 2435, + "jsonPayload": { + "response.headers": { + "Content-Type": [ + "application/json; charset=UTF-8" + ], + "Vary": [ + "X-Origin", + "Referer", + "Origin,Accept-Encoding" + ], + "Date": [ + "Tue, 03 Dec 2024 20:21:47 GMT" + ], + "Server": [ + "ESF" + ], + "Cache-Control": [ + "private" + ], + "X-XSS-Protection": [ + "0" + ], + "X-Frame-Options": [ + "SAMEORIGIN" + ], + "X-Content-Type-Options": [ + "nosniff" + ], + "Accept-Ranges": [ + "none" + ], + "Transfer-Encoding": [ + "chunked" + ] + }, + "response.payload": "{\n \"translations\": [\n {\n \"translatedText\": \"Hello\",\n \"detectedLanguageCode\": \"ja\"\n }\n ]\n}\n", + "latencyMillis": 152 + } +} +``` + +
+ ### Passing a PSR-3 compliant logger The debugging code has been made to comply with the PSR-3 logging interface. With in mind we can diff --git a/dev/tests/fixtures/docfx/Vision/index.md b/dev/tests/fixtures/docfx/Vision/index.md index 8ab0adf85fd..0370f0f6816 100644 --- a/dev/tests/fixtures/docfx/Vision/index.md +++ b/dev/tests/fixtures/docfx/Vision/index.md @@ -50,6 +50,11 @@ foreach ($annotation->getFaceAnnotations() as $faceAnnotation) { } ``` +### Debugging + +Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) +for more information about the debugging tools. + ### Version This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in @@ -59,4 +64,3 @@ any minor or patch releases. We will address issues and requests with the highes 1. Understand the [official documentation](https://cloud.google.com/vision/docs/). 2. Take a look at [in-depth usage samples](https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/vision/). - From e2b5f7a5573a136ae178a9f213795630e3639e91 Mon Sep 17 00:00:00 2001 From: Hector Mendoza Jacobo Date: Tue, 3 Dec 2024 22:44:18 +0000 Subject: [PATCH 5/7] Fix the README.md.twig fixture --- dev/templates/README.md.twig | 1 + 1 file changed, 1 insertion(+) diff --git a/dev/templates/README.md.twig b/dev/templates/README.md.twig index 7047c035638..eb716fdc9ad 100644 --- a/dev/templates/README.md.twig +++ b/dev/templates/README.md.twig @@ -37,6 +37,7 @@ on authenticating your client. Once authenticated, you'll be ready to start maki See the [samples directory](https://github.com/{{github_repo}}/tree/main/samples) for a canonical list of samples. ### Debugging + Please see our [Debugging guide](https://github.com/googleapis/google-cloud-php/blob/main/DEBUG.md) for more information about the debugging tools. From a1bb4b137a8e465ef7e584cb4854fb87d6c031fe Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Wed, 4 Dec 2024 08:15:57 -0800 Subject: [PATCH 6/7] review comments --- DEBUG.md | 68 +++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 47 insertions(+), 21 deletions(-) diff --git a/DEBUG.md b/DEBUG.md index cda1fda95bd..f2246c9f96e 100644 --- a/DEBUG.md +++ b/DEBUG.md @@ -1,8 +1,7 @@ # Debugging There are a few features built into the Google Cloud PHP client libraries which can help you debug -your application. This guide will show you how to enable logging the requests and responses the -client libraries are performing internally. +your application. This guide will show you how to log client library requests and responses. > :warning: > @@ -12,37 +11,38 @@ client libraries are performing internally. > the debugging flag or configuration used to avoid leaking sensitive user data. This may also > include authentication tokens. -## Configuration - -There are multiple ways to configure the debugging logs which we will go through in this document. - -### The `GOOGLE_SDK_PHP_LOGGING` environment variable - -You can enable logging on all the different clients on your code by using this environment variable -to `true`. Once this environment variable is set, all the clients used on your code will start -logging the requests into `STDOUT`. +## Log examples ```php -putenv('GOOGLE_SDK_PHP_LOGGING=true'); +// debug-logging-example.php +use Google\Cloud\Translate\V3\Client\TranslationServiceClient; +use Google\Cloud\Translate\V3\TranslateTextRequest; -$client = new TranslationServiceClient([]); +$client = new TranslationServiceClient(); $request = new TranslateTextRequest(); $request->setTargetLanguageCode('en-US'); $request->setContents(['こんにちは']); $request->setParent('projects/php-docs-samples-kokoro'); -// This will be logged to STDOUT +// The request and response will be logged to STDOUT when the environment +// variable GOOGLE_SDK_PHP_LOGGING=true $response = $client->translateText($request); ``` -Logs usually come with a request log and a response log the exception being streaming requests -where depending on the type of streaming it logs each stream packet. This means that if the client performs a request to the auth server it will also log that request-response pair before the main request. +```sh +$ GOOGLE_SDK_PHP_LOGGING=true php debug-logging-example.php +{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":73,"requestId":2427,"jsonPayload":{"request.headers":{"x-goog-api-client":["gl-php/8.3.14 gapic/1.20.0 gax/1.35.0 grpc/1.59.1 rest/1.35.0 pb/+n"],"User-Agent":["gcloud-php-new/1.20.0"],"X-Goog-User-Project":[""],"x-goog-request-params":["parent=projects%2F"]},"request.payload":"{\"contents\":[\"こんにちは\"],\"targetLanguageCode\":\"en-US\",\"parent\":\"projects\/\"}"}} +{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":21,"requestId":2421,"jsonPayload":{"request.method":"POST","request.url":"https://oauth2.googleapis.com/token","request.headers":{"Host":["oauth2.googleapis.com"],"Cache-Control":["no-store"],"Content-Type":["application/x-www-form-urlencoded"],"x-goog-api-client":["gl-php/8.3.14 auth/1.43.0 auth-request-type/at cred-type/u"]},"request.payload":"grant_type=refresh_token&refresh_token=&client_id=&client_secret="}} +{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":21,"requestId":2421,"jsonPayload":{"response.headers":{"Expires":["Mon, 01 Jan 1990 00:00:00 GMT"],"Pragma":["no-cache"],"Cache-Control":["no-cache, no-store, max-age=0, must-revalidate"],"Date":["Wed, 04 Dec 2024 16:33:55 GMT"],"Content-Type":["application/json; charset=utf-8"],"Vary":["X-Origin","Referer","Origin,Accept-Encoding"],"Server":["scaffolding on HTTPServer2"],"X-XSS-Protection":["0"],"X-Frame-Options":["SAMEORIGIN"],"X-Content-Type-Options":["nosniff"],"Alt-Svc":["h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"],"Accept-Ranges":["none"],"Transfer-Encoding":["chunked"]},"response.payload":"{\"access_token\":\"",\"expires_in\": 3599,\"scope\": \"https://www.googleapis.com/auth/sqlservice.login https://www.googleapis.com/auth/cloud-platform openid https://www.googleapis.com/auth/userinfo.email\",\"token_type\": \"Bearer\",\"id_token\": \"","latencyMillis":150}} +{"timestamp":"2024-12-04T16:33:55+00:00","severity":"info","clientId":21,"requestId":2421,"jsonPayload":{"response.status":200}} +{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":73,"requestId":73,"jsonPayload":{"response.headers":{"pc-high-bwd-bin":["KgIYIA"]},"response.payload":"{\"translations\":[{\"translatedText\":\"Hello\",\"detectedLanguageCode\":\"ja\"}]}","latencyMillis":390}} +{"timestamp":"2024-12-04T16:33:55+00:00","severity":"info","clientId":73,"requestId":73,"jsonPayload":{"response.status":0}} +```
-Log examples +Request example log (expanded) -### Request example log ```json { "timestamp": "2024-12-03T15:21:47-05:00", @@ -80,7 +80,10 @@ where depending on the type of streaming it logs each stream packet. This means } ``` -### Response example log +
+
+Response example log (expanded) + ```json { "timestamp": "2024-12-03T15:21:47-05:00", @@ -122,7 +125,7 @@ where depending on the type of streaming it logs each stream packet. This means "chunked" ] }, - "response.payload": "{\n \"translations\": [\n {\n \"translatedText\": \"Hello\",\n \"detectedLanguageCode\": \"ja\"\n }\n ]\n}\n", + "response.payload": "{\"translations\":[{\"translatedText\": \"Hello\",\"detectedLanguageCode\":\"ja\"}]}", "latencyMillis": 152 } } @@ -130,10 +133,33 @@ where depending on the type of streaming it logs each stream packet. This means
+## Configuration + +There are a few ways to configure debug logging which we will go through in this document. + +### The `GOOGLE_SDK_PHP_LOGGING` environment variable + +You can enable logging on all the different clients on your code by using this environment variable +to `true`. Once this environment variable is set, all the clients used on your code will start +logging the requests into `STDOUT`. + +```php +putenv('GOOGLE_SDK_PHP_LOGGING=true'); + +$client = new TranslationServiceClient(); +``` + +Logs usually come with a request log and a response log the exception being streaming requests +where depending on the type of streaming it logs each stream packet. This means that if the client +performs a request to the auth server it will also log that request-response pair before the main +request. + + ### Passing a PSR-3 compliant logger The debugging code has been made to comply with the PSR-3 logging interface. With in mind we can pass a compatible logger to the client configuration. + ```php use Monolog\Handler\StreamHandler; use Monolog\Level; @@ -169,7 +195,7 @@ from logging to avoid excessive noise. putenv('GOOGLE_SDK_PHP_LOGGING=true'); // The Big Table client will log all the requests -$client = new BigtableClient([]); +$client = new BigtableClient(); // The TranslationServiceClient will not log any requests $client = new TranslationServiceClient([ From 220253edfebe35faf83327314bcbb12822e69111 Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Wed, 11 Dec 2024 11:47:08 -0800 Subject: [PATCH 7/7] update output example with changes --- DEBUG.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/DEBUG.md b/DEBUG.md index f2246c9f96e..962e8779da2 100644 --- a/DEBUG.md +++ b/DEBUG.md @@ -5,11 +5,11 @@ your application. This guide will show you how to log client library requests an > :warning: > -> These logs are not intended to be used in production and is meant to be used for quickly -> debugging a project. The logs consists of basic logging into the STDOUT of your system which may -> or may not include sensitive information. Make sure that once you are done debugging to disable -> the debugging flag or configuration used to avoid leaking sensitive user data. This may also -> include authentication tokens. +> These logs are not intended to be used in production and are meant to be used only for quickly +> debugging a project. The logs consists of basic logging to STDOUT, which may or may not include +> sensitive information. Make sure that once you are done debugging to disable the debugging flag or +> configuration used to avoid leaking sensitive user data. This may also include authentication +> tokens. ## Log examples @@ -32,12 +32,11 @@ $response = $client->translateText($request); ```sh $ GOOGLE_SDK_PHP_LOGGING=true php debug-logging-example.php -{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":73,"requestId":2427,"jsonPayload":{"request.headers":{"x-goog-api-client":["gl-php/8.3.14 gapic/1.20.0 gax/1.35.0 grpc/1.59.1 rest/1.35.0 pb/+n"],"User-Agent":["gcloud-php-new/1.20.0"],"X-Goog-User-Project":[""],"x-goog-request-params":["parent=projects%2F"]},"request.payload":"{\"contents\":[\"こんにちは\"],\"targetLanguageCode\":\"en-US\",\"parent\":\"projects\/\"}"}} -{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":21,"requestId":2421,"jsonPayload":{"request.method":"POST","request.url":"https://oauth2.googleapis.com/token","request.headers":{"Host":["oauth2.googleapis.com"],"Cache-Control":["no-store"],"Content-Type":["application/x-www-form-urlencoded"],"x-goog-api-client":["gl-php/8.3.14 auth/1.43.0 auth-request-type/at cred-type/u"]},"request.payload":"grant_type=refresh_token&refresh_token=&client_id=&client_secret="}} -{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":21,"requestId":2421,"jsonPayload":{"response.headers":{"Expires":["Mon, 01 Jan 1990 00:00:00 GMT"],"Pragma":["no-cache"],"Cache-Control":["no-cache, no-store, max-age=0, must-revalidate"],"Date":["Wed, 04 Dec 2024 16:33:55 GMT"],"Content-Type":["application/json; charset=utf-8"],"Vary":["X-Origin","Referer","Origin,Accept-Encoding"],"Server":["scaffolding on HTTPServer2"],"X-XSS-Protection":["0"],"X-Frame-Options":["SAMEORIGIN"],"X-Content-Type-Options":["nosniff"],"Alt-Svc":["h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"],"Accept-Ranges":["none"],"Transfer-Encoding":["chunked"]},"response.payload":"{\"access_token\":\"",\"expires_in\": 3599,\"scope\": \"https://www.googleapis.com/auth/sqlservice.login https://www.googleapis.com/auth/cloud-platform openid https://www.googleapis.com/auth/userinfo.email\",\"token_type\": \"Bearer\",\"id_token\": \"","latencyMillis":150}} -{"timestamp":"2024-12-04T16:33:55+00:00","severity":"info","clientId":21,"requestId":2421,"jsonPayload":{"response.status":200}} -{"timestamp":"2024-12-04T16:33:55+00:00","severity":"DEBUG","clientId":73,"requestId":73,"jsonPayload":{"response.headers":{"pc-high-bwd-bin":["KgIYIA"]},"response.payload":"{\"translations\":[{\"translatedText\":\"Hello\",\"detectedLanguageCode\":\"ja\"}]}","latencyMillis":390}} -{"timestamp":"2024-12-04T16:33:55+00:00","severity":"info","clientId":73,"requestId":73,"jsonPayload":{"response.status":0}} +{"timestamp":"2024-12-11T19:40:00+00:00","severity":"DEBUG","processId":44180,"jsonPayload":{"serviceName":"google.cloud.translation.v3.TranslationService","clientConfiguration":[]}} +{"timestamp":"2024-12-11T19:40:00+00:00","severity":"DEBUG","processId":44180,"requestId":3821560043,"jsonPayload":{"request.method":"POST","request.url":"https://oauth2.googleapis.com/token","request.headers":{"Host":["oauth2.googleapis.com"],"Cache-Control":["no-store"],"Content-Type":["application/x-www-form-urlencoded"],"x-goog-api-client":["gl-php/8.3.14 auth/1.45.0 auth-request-type/at cred-type/u"]},"request.payload":"grant_type=refresh_token&refresh_token=&client_id=&client_secret="}} +{"timestamp":"2024-12-11T19:40:00+00:00","severity":"DEBUG","processId":44180,"requestId":3821560043,"jsonPayload":{"response.status":200,"response.headers":{"x-google-esf-cloud-client-params":["backend_service_name: \"oauth2.googleapis.com\" backend_fully_qualified_method: \"google.identity.oauth2.OAuth2Service.GetToken\""],"X-Google-Session-Info":[""],"Date":["Wed, 11 Dec 2024 19:40:00 GMT"],"Pragma":["no-cache"],"Expires":["Mon, 01 Jan 1990 00:00:00 GMT"],"Cache-Control":["no-cache, no-store, max-age=0, must-revalidate"],"Content-Type":["application/json; charset=utf-8"],"X-Google-Security-Signals":["FRAMEWORK=ONE_PLATFORM,ENV=borg,ENV_DEBUG=borg_user:identity-oauth2-proxy;borg_job:prod.identity-oauth2-proxy","FRAMEWORK=HTTPSERVER2,BUILD=GOOGLE3,BUILD_DEBUG=cl:694072944,ENV=borg,ENV_DEBUG=borg_user:identity-oauth2-proxy;borg_job:prod.identity-oauth2-proxy"],"Vary":["X-Origin","Referer","Origin,Accept-Encoding"],"Server":["scaffolding on HTTPServer2"],"X-Google-Netmon-Label":["/bns/dz/borg/dz/bns/identity-oauth2-proxy/prod.identity-oauth2-proxy/4"],"X-XSS-Protection":["0"],"X-Frame-Options":["SAMEORIGIN"],"X-Content-Type-Options":["nosniff"],"X-Google-GFE-Service-Trace":["google-identity-oauth2-oauth2proxyservice-prod"],"X-Google-Backends":["unix:/tmp/esfbackend.1733439890.116447.177528,/bns/dz/borg/dz/bns/identity-oauth2-proxy/prod.identity-oauth2-proxy/4,/bns/ncsfoa/borg/ncsfoa/bns/blue-layer1-gfe-prod-edge/prod.blue-layer1-gfe.sfo03s27/15"],"X-Google-GFE-Request-Trace":["acsfon13:443,/bns/dz/borg/dz/bns/identity-oauth2-proxy/prod.identity-oauth2-proxy/4,acsfon13:443"],"X-Google-DOS-Service-Trace":["main:google-identity-oauth2-oauth2proxyservice-prod,main:GLOBAL_all_non_cloud"],"X-Google-GFE-Handshake-Trace":["GFE: /bns/ncsfoa/borg/ncsfoa/bns/blue-layer1-gfe-prod-edge/prod.blue-layer1-gfe.sfo03s27/15,Mentat oracle: [2002:a05:635e:38e:b0:178:f5eb:ee40]:9801"],"X-Google-Service":["google-identity-oauth2-oauth2proxyservice-prod"],"X-Google-GFE-Response-Code-Details-Trace":["response_code_set_by_backend"],"X-Google-GFE-Response-Body-Transformations":["gunzipped,chunked"],"X-Google-Shellfish-Status":["CA0gBEBG"],"X-Google-GFE-Version":["2.903.2"],"Alt-Svc":["h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"],"Accept-Ranges":["none"],"Transfer-Encoding":["chunked"]},"response.payload":"{\n \"access_token\": \"\",\n \"expires_in\": 3599,\n \"scope\": \"https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/sqlservice.login https://www.googleapis.com/auth/cloud-platform openid\",\n \"token_type\": \"Bearer\",\n \"id_token\": \"","latencyMillis":114}} +{"timestamp":"2024-12-11T19:40:00+00:00","severity":"DEBUG","processId":44180,"requestId":4274868307,"jsonPayload":{"request.headers":{"x-goog-api-client":["gl-php/8.3.14 gapic/1.20.0 gax/1.36.0 grpc/1.59.1 rest/1.36.0 pb/+n"],"User-Agent":["gcloud-php-new/1.20.0"],"X-Goog-User-Project":[""],"x-goog-request-params":["parent=projects%2F"]},"request.payload":"{\"contents\":[\"こんにちは\"],\"targetLanguageCode\":\"en-US\",\"parent\":\"projects\\/\"}"}} +{"timestamp":"2024-12-11T19:40:00+00:00","severity":"DEBUG","processId":44180,"requestId":4274868307,"jsonPayload":{"response.status":0,"response.headers":{"pc-high-bwd-bin":["KgIYJQ"]},"response.payload":"{\"translations\":[{\"translatedText\":\"Hello\",\"detectedLanguageCode\":\"ja\"}]}","latencyMillis":242}} ```
@@ -47,8 +46,8 @@ $ GOOGLE_SDK_PHP_LOGGING=true php debug-logging-example.php { "timestamp": "2024-12-03T15:21:47-05:00", "severity": "DEBUG", - "clientId": 83, - "requestId": 2435, + "processId": 44180, + "requestId": 3821560043, "jsonPayload": { "request.method": "POST", "request.url": "https://translate.googleapis.com/v3/projects/