feat: [Logging] Add resource labels to logs from Cloud Run services a…

…nd jobs
googleapis · Sep 4, 2024 · 06ba585 · 06ba585
1 parent 012b88f
commit 06ba585
Show file tree

Hide file tree

Showing 9 changed files with 541 additions and 165 deletions.
diff --git a/Core/src/Report/CloudRunJobMetadataProvider.php b/Core/src/Report/CloudRunJobMetadataProvider.php
@@ -0,0 +1,144 @@
+<?php
+/**
+ * Copyright 2023 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\Report;
+
+use Google\Cloud\Core\Compute\Metadata;
+
+/**
+ * A MetadataProvider for Cloud Run Jobs.
+ */
+class CloudRunJobMetadataProvider implements MetadataProviderInterface
+{
+    /**
+     * @var Metadata
+     */
+    private $metadata;
+
+    /**
+     * @var string
+     */
+    private $serviceId;
+
+    /**
+     * @var string
+     */
+    private $revisionId;
+
+    /**
+     * @var string
+     */
+    private $taskIndex;
+
+    /**
+     * @var string
+     */
+    private $taskAttempt;
+
+    /**
+     * @var string
+     */
+    private $instanceId;
+
+    /**
+     * @var string
+     */
+    private $traceId;
+
+    /**
+     * @var string
+     */
+    private $region;
+
+    /**
+     * @see https://cloud.google.com/run/docs/container-contract#jobs-env-vars
+     * @param array $env
+     */
+    public function __construct(array $env, ?Metadata $metadata = null)
+    {
+        $this->serviceId = $env['CLOUD_RUN_JOB'] ?? 'unknown-job';
+        $this->revisionId = $env['CLOUD_RUN_EXECUTION'] ?? '';
+        $this->taskIndex = $env['CLOUD_RUN_TASK_INDEX'] ?? '';
+        $this->taskAttempt = $env['CLOUD_RUN_TASK_ATTEMPT'] ?? '';
+
+        $this->traceId = isset($env['HTTP_X_CLOUD_TRACE_CONTEXT'])
+            ? \substr($env['HTTP_X_CLOUD_TRACE_CONTEXT'], 0, 32)
+            : null;
+
+        $this->metadata = $metadata ?? new Metadata();
+        $this->region = \basename($this->metadata->get('instance/region'));
+        $this->instanceId = $this->metadata->get('instance/id');
+    }
+
+    /**
+     * @return array
+     */
+    public function monitoredResource()
+    {
+        return [
+            'type' => 'cloud_run_job',
+            'labels' => [
+                'job_name' => $this->serviceId,
+                'location' => $this->region,
+                'project_id' => $this->projectId(),
+            ],
+        ];
+    }
+
+    /**
+     * Return the project id.
+     * @return string
+     */
+    public function projectId()
+    {
+        return $this->metadata->getProjectId();
+    }
+
+    /**
+     * Return the service id.
+     * @return string
+     */
+    public function serviceId()
+    {
+        return $this->serviceId;
+    }
+
+    /**
+     * Return the version id.
+     * @return string
+     */
+    public function versionId()
+    {
+        return $this->revisionId;
+    }
+
+    /**
+     * Return the labels.
+     * @return array
+     */
+    public function labels()
+    {
+        $labels = [
+            'instanceId' => $this->instanceId,
+            'run.googleapis.com/execution_name' => $this->revisionId,
+            'run.googleapis.com/task_attempt' => $this->taskAttempt,
+            'run.googleapis.com/task_index' => $this->taskIndex,
+            'run.googleapis.com/trace_id' => $this->traceId,
+        ];
+        return \array_filter($labels);
+    }
+}
diff --git a/Core/src/Report/CloudRunMetadataProvider.php b/Core/src/Report/CloudRunMetadataProvider.php
diff --git a/Core/src/Report/CloudRunServiceMetadataProvider.php b/Core/src/Report/CloudRunServiceMetadataProvider.php
@@ -0,0 +1,138 @@
+<?php
+/**
+ * Copyright 2023 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\Report;
+
+use Google\Cloud\Core\Compute\Metadata;
+
+/**
+ * A MetadataProvider for Cloud Run Services.
+ */
+class CloudRunServiceMetadataProvider implements MetadataProviderInterface
+{
+    /**
+     * @var Metadata
+     */
+    private $metadata;
+
+    /**
+     * @var string
+     */
+    private $configurationId;
+
+    /**
+     * @var string
+     */
+    private $serviceId;
+
+    /**
+     * @var string
+     */
+    private $revisionId;
+
+    /**
+     * @var string
+     */
+    private $instanceId;
+
+    /**
+     * @var string
+     */
+    private $traceId;
+
+    /**
+     * @var string
+     */
+    private $region;
+
+    /**
+     * @see https://cloud.google.com/run/docs/container-contract#services-env-vars
+     * @param array $env
+     */
+    public function __construct(array $env, ?Metadata $metadata = null)
+    {
+        $this->configurationId = $env['K_CONFIGURATION'] ?? 'unknown-configuration';
+        $this->serviceId = $env['K_SERVICE'] ?? 'unknown-service';
+        $this->revisionId = $env['K_REVISION'] ?? 'unknown-revision';
+        $this->traceId = isset($env['HTTP_X_CLOUD_TRACE_CONTEXT'])
+            ? \substr($env['HTTP_X_CLOUD_TRACE_CONTEXT'], 0, 32)
+            : null;
+
+        $this->metadata = $metadata ?? new Metadata();
+        $this->region = \basename($this->metadata->get('instance/region'));
+        $this->instanceId = $this->metadata->get('instance/id');
+    }
+
+    /**
+     * @return array
+     */
+    public function monitoredResource()
+    {
+        return [
+            'type' => 'cloud_run_revision',
+            'labels' => [
+                'configuration_name' => $this->configurationId,
+                'location' => $this->region,
+                'project_id' => $this->projectId(),
+                'revision_name' => $this->revisionId,
+                'service_name' => $this->serviceId,
+            ],
+        ];
+    }
+
+    /**
+     * Return the project id.
+     * @return string
+     */
+    public function projectId()
+    {
+        return $this->metadata->getProjectId();
+    }
+
+    /**
+     * Return the service id.
+     * @return string
+     */
+    public function serviceId()
+    {
+        return $this->serviceId;
+    }
+
+    /**
+     * Return the version id.
+     * @return string
+     */
+    public function versionId()
+    {
+        return $this->revisionId;
+    }
+
+    /**
+     * Return the labels. We need to evaluate $_SERVER for each request.
+     *
+     * @return array
+     * @todo Figure out where to get the `container_name` from
+     */
+    public function labels()
+    {
+        $labels = [
+            'instanceId' => $this->instanceId,
+            'run.googleapis.com/trace_id' => $this->traceId,
+        ];
+        return \array_filter($labels);
+    }
+}