Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Core/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"guzzlehttp/psr7": "^2.6.3||^3.0",
"monolog/monolog": "^2.9||^3.0",
"psr/http-message": "^1.0||^2.0",
"google/gax": "^1.38.0"
"google/gax": "^1.38.0",
"open-telemetry/api": "^1.0"
},
"require-dev": {
"phpunit/phpunit": "^9.0",
Expand Down
74 changes: 74 additions & 0 deletions Core/src/Telemetry/TelemetryConfiguration.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?php

/**
* Copyright 2026 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

namespace Google\Cloud\Core\Telemetry;

/**
* Parses and provides telemetry configuration from environment variables.
*
* @internal
*/
class TelemetryConfiguration
{
/**
* Determine if tracing is enabled based on the environment variables.
*
* @return bool
*/
public static function isTracingEnabled()
{
return self::resolveEnabled('GOOGLE_SDK_PHP_TRACING_ENABLED');
}

/**
* Determine if logging is enabled based on the environment variables.
*
* @return bool
*/
public static function isLoggingEnabled()
{
return self::resolveEnabled('GOOGLE_SDK_PHP_LOGGING_ENABLED');
}

/**
* Determine if metrics are enabled based on the environment variables.
*
* @return bool
*/
public static function isMetricsEnabled()
{
return self::resolveEnabled('GOOGLE_SDK_PHP_METRICS_ENABLED');
}

/**
* @param string $specificEnvVar
* @return bool
*/
private static function resolveEnabled($specificEnvVar)
{
$enabled = getenv($specificEnvVar);
if ($enabled !== false) {
return filter_var($enabled, FILTER_VALIDATE_BOOLEAN);
}
$legacyEnabled = getenv('GOOGLE_API_ENABLE_TELEMETRY');
if ($legacyEnabled !== false) {
return filter_var($legacyEnabled, FILTER_VALIDATE_BOOLEAN);
}
return false;
}
}
118 changes: 118 additions & 0 deletions Core/tests/Unit/Telemetry/TelemetryConfigurationTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<?php
/**
* Copyright 2026 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

namespace Google\Cloud\Core\Tests\Unit\Telemetry;

use Google\Cloud\Core\Telemetry\TelemetryConfiguration;
use PHPUnit\Framework\TestCase;

/**
* @group core
* @group telemetry
*/
class TelemetryConfigurationTest extends TestCase
{
private $originalTracingEnabled;
private $originalLoggingEnabled;
private $originalMetricsEnabled;
private $originalLegacyTelemetry;

public function setUp(): void
{
$this->originalTracingEnabled = getenv('GOOGLE_SDK_PHP_TRACING_ENABLED');
$this->originalLoggingEnabled = getenv('GOOGLE_SDK_PHP_LOGGING_ENABLED');
$this->originalMetricsEnabled = getenv('GOOGLE_SDK_PHP_METRICS_ENABLED');
$this->originalLegacyTelemetry = getenv('GOOGLE_API_ENABLE_TELEMETRY');
putenv('GOOGLE_SDK_PHP_TRACING_ENABLED');
putenv('GOOGLE_SDK_PHP_LOGGING_ENABLED');
putenv('GOOGLE_SDK_PHP_METRICS_ENABLED');
putenv('GOOGLE_API_ENABLE_TELEMETRY');
}

public function tearDown(): void
{
if ($this->originalTracingEnabled !== false) {
putenv("GOOGLE_SDK_PHP_TRACING_ENABLED={$this->originalTracingEnabled}");
}
if ($this->originalLoggingEnabled !== false) {
putenv("GOOGLE_SDK_PHP_LOGGING_ENABLED={$this->originalLoggingEnabled}");
}
if ($this->originalMetricsEnabled !== false) {
putenv("GOOGLE_SDK_PHP_METRICS_ENABLED={$this->originalMetricsEnabled}");
}
if ($this->originalLegacyTelemetry !== false) {
putenv("GOOGLE_API_ENABLE_TELEMETRY={$this->originalLegacyTelemetry}");
}
}

public function testIsTracingEnabledDefaultFalse()
{
$this->assertFalse(TelemetryConfiguration::isTracingEnabled());
}

public function testIsTracingEnabledWithSpecificEnv()
{
putenv('GOOGLE_SDK_PHP_TRACING_ENABLED=true');
$this->assertTrue(TelemetryConfiguration::isTracingEnabled());

putenv('GOOGLE_SDK_PHP_TRACING_ENABLED=false');
$this->assertFalse(TelemetryConfiguration::isTracingEnabled());
}

public function testIsTracingEnabledWithLegacyEnv()
{
putenv('GOOGLE_API_ENABLE_TELEMETRY=true');
$this->assertTrue(TelemetryConfiguration::isTracingEnabled());

putenv('GOOGLE_API_ENABLE_TELEMETRY=false');
$this->assertFalse(TelemetryConfiguration::isTracingEnabled());
}

public function testIsTracingEnabledPrecedence()
{
// Specific flag takes precedence over legacy flag
putenv('GOOGLE_SDK_PHP_TRACING_ENABLED=false');
putenv('GOOGLE_API_ENABLE_TELEMETRY=true');
$this->assertFalse(TelemetryConfiguration::isTracingEnabled());

putenv('GOOGLE_SDK_PHP_TRACING_ENABLED=true');
putenv('GOOGLE_API_ENABLE_TELEMETRY=false');
$this->assertTrue(TelemetryConfiguration::isTracingEnabled());
}

public function testIsLoggingEnabledPrecedence()
{
putenv('GOOGLE_SDK_PHP_LOGGING_ENABLED=false');
putenv('GOOGLE_API_ENABLE_TELEMETRY=true');
$this->assertFalse(TelemetryConfiguration::isLoggingEnabled());

putenv('GOOGLE_SDK_PHP_LOGGING_ENABLED=true');
putenv('GOOGLE_API_ENABLE_TELEMETRY=false');
$this->assertTrue(TelemetryConfiguration::isLoggingEnabled());
}

public function testIsMetricsEnabledPrecedence()
{
putenv('GOOGLE_SDK_PHP_METRICS_ENABLED=false');
putenv('GOOGLE_API_ENABLE_TELEMETRY=true');
$this->assertFalse(TelemetryConfiguration::isMetricsEnabled());

putenv('GOOGLE_SDK_PHP_METRICS_ENABLED=true');
putenv('GOOGLE_API_ENABLE_TELEMETRY=false');
$this->assertTrue(TelemetryConfiguration::isMetricsEnabled());
}
}
3 changes: 2 additions & 1 deletion Gax/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"guzzlehttp/psr7": "^2.6.3||^3.0",
"google/common-protos": "^4.9",
"google/longrunning": "~0.4",
"ramsey/uuid": "^4.0"
"ramsey/uuid": "^4.0",
"open-telemetry/api": "^1.0"
},
"require-dev": {
"phpunit/phpunit": "^9.6",
Expand Down
55 changes: 55 additions & 0 deletions Gax/src/Options/ClientOptions.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/*
* Copyright 2023 Google LLC
* All rights reserved.
Expand Down Expand Up @@ -38,6 +39,8 @@
use Google\ApiCore\Transport\TransportInterface;
use Google\Auth\FetchAuthTokenInterface;
use InvalidArgumentException;
use OpenTelemetry\API\Logs\LoggerProviderInterface;
use OpenTelemetry\API\Trace\TracerProviderInterface;
use Psr\Log\LoggerInterface;

/**
Expand Down Expand Up @@ -99,6 +102,12 @@ class ClientOptions implements ArrayAccess, OptionsInterface

private null|false|LoggerInterface $logger;

/** @var TracerProviderInterface|null */
private $tracerProvider;

/** @var LoggerProviderInterface|null */
private $loggerProvider;

/**
* @param array $options {
* @type string $apiEndpoint
Expand Down Expand Up @@ -169,6 +178,10 @@ class ClientOptions implements ArrayAccess, OptionsInterface
* The API key to be used for the client.
* @type null|false|LoggerInterface
* A PSR-3 compliant logger.
* @type TracerProviderInterface|null $tracerProvider
* A tracer provider for OpenTelemetry.
* @type LoggerProviderInterface|null $loggerProvider
* A logger provider for OpenTelemetry.
* }
*/
public function __construct(array $options)
Expand Down Expand Up @@ -200,6 +213,8 @@ private function fromArray(array $arr): void
$this->setUniverseDomain($arr['universeDomain'] ?? null);
$this->setApiKey($arr['apiKey'] ?? null);
$this->setLogger($arr['logger'] ?? null);
$this->setTracerProvider($arr['tracerProvider'] ?? null);
$this->setLoggerProvider($arr['loggerProvider'] ?? null);
}

/**
Expand Down Expand Up @@ -418,4 +433,44 @@ public function setLogger(null|false|LoggerInterface $logger): self

return $this;
}

/**
* @param TracerProviderInterface|null $tracerProvider
*
* @return $this
*/
public function setTracerProvider($tracerProvider): self
{
$this->tracerProvider = $tracerProvider;

return $this;
}

/**
* @param LoggerProviderInterface|null $loggerProvider
*
* @return $this
*/
public function setLoggerProvider($loggerProvider): self
{
$this->loggerProvider = $loggerProvider;

return $this;
}

/**
* @return TracerProviderInterface|null
*/
public function getTracerProvider()
{
return $this->tracerProvider;
}

/**
* @return LoggerProviderInterface|null
*/
public function getLoggerProvider()
{
return $this->loggerProvider;
}
}
56 changes: 56 additions & 0 deletions Gax/tests/Unit/Options/ClientOptionsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<?php
/**
* Copyright 2026 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

namespace Google\ApiCore\Tests\Unit\Options;

use Google\ApiCore\Options\ClientOptions;
use PHPUnit\Framework\TestCase;
use OpenTelemetry\API\Logs\LoggerProviderInterface;
use OpenTelemetry\API\Trace\TracerProviderInterface;

class ClientOptionsTest extends TestCase
{
public function testSetAndGetTracerProvider()
{
$tracerProvider = $this->createMock(TracerProviderInterface::class);
$options = new ClientOptions([]);
$options->setTracerProvider($tracerProvider);
$this->assertSame($tracerProvider, $options->getTracerProvider());
}

public function testSetAndGetLoggerProvider()
{
$loggerProvider = $this->createMock(LoggerProviderInterface::class);
$options = new ClientOptions([]);
$options->setLoggerProvider($loggerProvider);
$this->assertSame($loggerProvider, $options->getLoggerProvider());
}

public function testConstructorInjection()
{
$tracerProvider = $this->createMock(TracerProviderInterface::class);
$loggerProvider = $this->createMock(LoggerProviderInterface::class);

$options = new ClientOptions([
'tracerProvider' => $tracerProvider,
'loggerProvider' => $loggerProvider,
]);

$this->assertSame($tracerProvider, $options->getTracerProvider());
$this->assertSame($loggerProvider, $options->getLoggerProvider());
}
}
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@
"google/protobuf": "^4.31||^5.34",
"google/grpc-gcp": "^0.4",
"ramsey/uuid": "^4.0",
"open-telemetry/sdk": "^1.13"
"open-telemetry/sdk": "^1.13",
"open-telemetry/api": "^1.0"
},
"require-dev": {
"phpunit/phpunit": "^9.6",
Expand Down
Loading