-
Notifications
You must be signed in to change notification settings - Fork 193
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: enable auth observability metrics (#509)
- Loading branch information
Showing
11 changed files
with
505 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <?php | ||
| /* | ||
| * Copyright 2024 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\Auth; | ||
|
|
||
| /** | ||
| * Trait containing helper methods required for enabling | ||
| * observability metrics in the library. | ||
| * | ||
| * @internal | ||
| */ | ||
| trait MetricsTrait | ||
| { | ||
| /** | ||
| * @var string The version of the auth library php. | ||
| */ | ||
| private static $version; | ||
|
|
||
| /** | ||
| * @var string The header key for the observability metrics. | ||
| */ | ||
| protected static $metricMetadataKey = 'x-goog-api-client'; | ||
|
|
||
| /** | ||
| * @param string $credType [Optional] The credential type. | ||
| * Empty value will not add any credential type to the header. | ||
| * Should be one of `'sa'`, `'jwt'`, `'imp'`, `'mds'`, `'u'`. | ||
| * @param string $authRequestType [Optional] The auth request type. | ||
| * Empty value will not add any auth request type to the header. | ||
| * Should be one of `'at'`, `'it'`, `'mds'`. | ||
| * @return string The header value for the observability metrics. | ||
| */ | ||
| protected static function getMetricsHeader( | ||
| $credType = '', | ||
| $authRequestType = '' | ||
| ): string { | ||
| $value = sprintf( | ||
| 'gl-php/%s auth/%s', | ||
| PHP_VERSION, | ||
| self::getVersion() | ||
| ); | ||
|
|
||
| if (!empty($authRequestType)) { | ||
| $value .= ' auth-request-type/' . $authRequestType; | ||
| } | ||
|
|
||
| if (!empty($credType)) { | ||
| $value .= ' cred-type/' . $credType; | ||
| } | ||
|
|
||
| return $value; | ||
| } | ||
|
|
||
| /** | ||
| * @param array<mixed> $metadata The metadata to update and return. | ||
| * @return array<mixed> The updated metadata. | ||
| */ | ||
| protected function applyServiceApiUsageMetrics($metadata) | ||
| { | ||
| if ($credType = $this->getCredType()) { | ||
| // Add service api usage observability metrics info into metadata | ||
| // We expect upstream libries to have the metadata key populated already | ||
| $value = 'cred-type/' . $credType; | ||
| if (!isset($metadata[self::$metricMetadataKey])) { | ||
| // This case will happen only when someone invokes the updateMetadata | ||
| // method on the credentials fetcher themselves. | ||
| $metadata[self::$metricMetadataKey] = [$value]; | ||
| } elseif (is_array($metadata[self::$metricMetadataKey])) { | ||
| $metadata[self::$metricMetadataKey][0] .= ' ' . $value; | ||
| } else { | ||
| $metadata[self::$metricMetadataKey] .= ' ' . $value; | ||
| } | ||
| } | ||
|
|
||
| return $metadata; | ||
| } | ||
|
|
||
| /** | ||
| * @param array<mixed> $metadata The metadata to update and return. | ||
| * @param string $authRequestType The auth request type. Possible values are | ||
| * `'at'`, `'it'`, `'mds'`. | ||
| * @return array<mixed> The updated metadata. | ||
| */ | ||
| protected function applyTokenEndpointMetrics($metadata, $authRequestType) | ||
| { | ||
| $metricsHeader = self::getMetricsHeader($this->getCredType(), $authRequestType); | ||
| if (!isset($metadata[self::$metricMetadataKey])) { | ||
| $metadata[self::$metricMetadataKey] = $metricsHeader; | ||
| } | ||
| return $metadata; | ||
| } | ||
|
|
||
| protected static function getVersion(): string | ||
| { | ||
| if (is_null(self::$version)) { | ||
| $versionFilePath = __DIR__ . '/../VERSION'; | ||
| self::$version = trim((string) file_get_contents($versionFilePath)); | ||
| } | ||
| return self::$version; | ||
| } | ||
|
|
||
| protected function getCredType(): string | ||
| { | ||
| return ''; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.