Merge branch 'GoogleCloudPlatform:main' into main

Author: DylanRussell

samples/instrumentation-quickstart/Dockerfile

@@ -1,6 +1,6 @@
-FROM python:3.12
+FROM python:3.12-slim
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
 WORKDIR /usr/src/app
 COPY . .
-RUN python -m venv /venv && \
-    /venv/bin/pip install -r requirements.txt
-CMD /venv/bin/gunicorn -b 0.0.0.0:8080 -w 4 'app:app'  2>&1 | tee /var/log/app.log
+RUN uv sync --frozen
+CMD uv run gunicorn -b 0.0.0.0:8080 -w 4 'app:app'  2>&1 | tee /var/log/app.log

samples/instrumentation-quickstart/README.md

@@ -1,8 +1,6 @@
 # OpenTelemetry Python instrumentation example
 
-**This example is under development, and does not currently work**
-
-This sample is a Python application instrumented with TODO. This is a python version
+This sample is a Python application instrumented with OpenTelemetry. This is a python version
 of [this golang
 sample](https://github.com/GoogleCloudPlatform/golang-samples/tree/main/opentelemetry/instrumentation).
 It uses docker compose to run the application and send it some requests.
@@ -85,4 +83,4 @@ After a successful run of the example, you can see the generated metrics in the
 Similarly, to view the generated traces in the GCP console, use the Trace Explorer.
 
 [auth_command]: https://cloud.google.com/sdk/gcloud/reference/beta/auth/application-default/login
-[ADC]: https://cloud.google.com/docs/authentication/application-default-credentials
+[ADC]: https://cloud.google.com/docs/authentication/application-default-credentials

samples/instrumentation-quickstart/app.py

@@ -12,41 +12,55 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from random import randint, uniform
-import time
 import logging
+import time
+from random import randint, uniform
+
 import requests
 from flask import Flask, url_for
-import setup_opentelemetry
-import gcp_logging
-
-from opentelemetry.instrumentation.requests import RequestsInstrumentor
 from opentelemetry.instrumentation.flask import FlaskInstrumentor
+from opentelemetry.instrumentation.requests import RequestsInstrumentor
+
+from gcp_logging import setup_structured_logging
+from setup_opentelemetry import setup_opentelemetry
 
 # [START opentelemetry_instrumentation_main]
 logger = logging.getLogger(__name__)
 
+# Initialize OpenTelemetry Python SDK and structured logging
+setup_opentelemetry()
+setup_structured_logging()
+
 app = Flask(__name__)
+
+# Add instrumentation
 FlaskInstrumentor().instrument_app(app)
 RequestsInstrumentor().instrument()
 # [END opentelemetry_instrumentation_main]
 
+
 # [START opentelemetry_instrumentation_handle_multi]
-@app.route('/multi')
+@app.route("/multi")
 def multi():
     """Handle an http request by making 3-7 http requests to the /single endpoint."""
-    subRequests = randint(3, 7)
-    logger.info("handle /multi request", extra={'subRequests': subRequests})
-    for _ in range(subRequests):
-        requests.get(url_for('single', _external=True))
-    return 'ok'
+    sub_requests = randint(3, 7)
+    logger.info("handle /multi request", extra={"subRequests": sub_requests})
+    for _ in range(sub_requests):
+        requests.get(url_for("single", _external=True))
+    return "ok"
+
+
 # [END opentelemetry_instrumentation_handle_multi]
 
+
 # [START opentelemetry_instrumentation_handle_single]
-@app.route('/single')
+@app.route("/single")
 def single():
     """Handle an http request by sleeping for 100-200 ms, and write the number of seconds slept as the response."""
     duration = uniform(0.1, 0.2)
+    logger.info("handle /single request", extra={"duration": duration})
     time.sleep(duration)
-    return f'slept {duration} seconds'
+    return f"slept {duration} seconds"
+
+
 # [END opentelemetry_instrumentation_handle_single]

samples/instrumentation-quickstart/gcp_logging.py

@@ -13,27 +13,44 @@
 # limitations under the License.
 
 import logging
-from pythonjsonlogger import jsonlogger
+from datetime import datetime
+from typing import Optional
+
 from opentelemetry.instrumentation.logging import LoggingInstrumentor
+from pythonjsonlogger import jsonlogger
+
+
+# We override JsonFormatter.formatTime() instead of using the datefmt strftime parameter
+# because it does not support microsecond precision.
+
 
 # [START opentelemetry_instrumentation_setup_logging]
-LoggingInstrumentor().instrument()
-
-logHandler = logging.StreamHandler()
-formatter = jsonlogger.JsonFormatter(
-    "%(asctime)s %(levelname)s %(message)s %(otelTraceID)s %(otelSpanID)s %(otelTraceSampled)s",
-    rename_fields={
-        "levelname": "severity",
-        "asctime": "timestamp",
-        "otelTraceID": "logging.googleapis.com/trace",
-        "otelSpanID": "logging.googleapis.com/spanId",
-        "otelTraceSampled": "logging.googleapis.com/trace_sampled",
+class JsonFormatter(jsonlogger.JsonFormatter):
+    def formatTime(self, record: logging.LogRecord, datefmt: Optional[str] = None):
+        # Format the timestamp as RFC 3339 with microsecond precision
+        isoformat = datetime.fromtimestamp(record.created).isoformat()
+        return f"{isoformat}Z"
+
+
+def setup_structured_logging() -> None:
+    LoggingInstrumentor().instrument()
+
+    log_handler = logging.StreamHandler()
+    formatter = JsonFormatter(
+        "%(asctime)s %(levelname)s %(message)s %(otelTraceID)s %(otelSpanID)s %(otelTraceSampled)s",
+        rename_fields={
+            "levelname": "severity",
+            "asctime": "timestamp",
+            "otelTraceID": "logging.googleapis.com/trace",
+            "otelSpanID": "logging.googleapis.com/spanId",
+            "otelTraceSampled": "logging.googleapis.com/trace_sampled",
         },
-    datefmt="%Y-%m-%dT%H:%M:%SZ",
-)
-logHandler.setFormatter(formatter)
-logging.basicConfig(
-    level=logging.INFO,
-    handlers=[logHandler],
-)
+    )
+    log_handler.setFormatter(formatter)
+    logging.basicConfig(
+        level=logging.INFO,
+        handlers=[log_handler],
+    )
+
+
 # [END opentelemetry_instrumentation_setup_logging]