טיפים וטריקים
במסמך הזה מתוארות שיטות מומלצות לתכנון, להטמעה, לבדיקה ולפריסה של פונקציות Cloud Run.
נכונות
בקטע הזה מתוארות שיטות מומלצות כלליות לתכנון וליישום של פונקציות Cloud Run.
כתיבת פונקציות אידמפוטנטיות
הפונקציות צריכות להפיק את אותה תוצאה גם אם קוראים להן כמה פעמים. כך תוכלו לנסות שוב הפעלה אם ההפעלה הקודמת נכשלה באמצע הקוד. מידע נוסף זמין במאמר בנושא ניסיון חוזר של פונקציות מבוססות-אירועים.
מוודאים שפונקציות HTTP שולחות תגובת HTTP
אם הפונקציה מופעלת על ידי HTTP, חשוב לשלוח תגובת HTTP, כמו שמוצג בהמשך. אם לא תעשו את זה, הפונקציה תמשיך לפעול עד שתגיע לזמן הקצוב לתפוגה. במקרה כזה, תחויבו על כל משך הזמן של פסק הזמן. פסק זמן עלול גם לגרום להתנהגות בלתי צפויה או להפעלות קרות בהפעלות הבאות, וכתוצאה מכך להתנהגות בלתי צפויה או לזמן אחזור נוסף.
Node.js
Python
Go
Java
C#
using Google.Cloud.Functions.Framework; using Microsoft.AspNetCore.Http; using Microsoft.Extensions.Logging; using System.IO; using System.Text.Json; using System.Threading.Tasks; namespace HelloHttp; public class Function : IHttpFunction { private readonly ILogger _logger; public Function(ILogger<Function> logger) => _logger = logger; public async Task HandleAsync(HttpContext context) { HttpRequest request = context.Request; // Check URL parameters for "name" field // "world" is the default value string name = ((string) request.Query["name"]) ?? "world"; // If there's a body, parse it as JSON and check for "name" field. using TextReader reader = new StreamReader(request.Body); string text = await reader.ReadToEndAsync(); if (text.Length > 0) { try { JsonElement json = JsonSerializer.Deserialize<JsonElement>(text); if (json.TryGetProperty("name", out JsonElement nameElement) && nameElement.ValueKind == JsonValueKind.String) { name = nameElement.GetString(); } } catch (JsonException parseException) { _logger.LogError(parseException, "Error parsing JSON request"); } } await context.Response.WriteAsync($"Hello {name}!", context.RequestAborted); } }
Ruby
PHP
<?php use Google\CloudFunctions\FunctionsFramework; use Psr\Http\Message\ServerRequestInterface; // Register the function with Functions Framework. // This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=http` environment // variable when deploying. The `FUNCTION_TARGET` environment variable should // match the first parameter. FunctionsFramework::http('helloHttp', 'helloHttp'); function helloHttp(ServerRequestInterface $request): string { $name = 'World'; $body = $request->getBody()->getContents(); if (!empty($body)) { $json = json_decode($body, true); if (json_last_error() != JSON_ERROR_NONE) { throw new RuntimeException(sprintf( 'Could not parse body: %s', json_last_error_msg() )); } $name = $json['name'] ?? $name; } $queryString = $request->getQueryParams(); $name = $queryString['name'] ?? $name; return sprintf('Hello, %s!', htmlspecialchars($name)); }
לא להפעיל פעילויות ברקע
פעילות ברקע היא כל מה שקורה אחרי שהפונקציה מסתיימת.
הפעלת פונקציה מסתיימת כשהפונקציה מחזירה ערך או מסמנת שהיא הושלמה, למשל על ידי קריאה לארגומנט callback בפונקציות מבוססות-אירועים ב-Node.js. לכל קוד שמופעל אחרי סיום תקין אין גישה למעבד, והוא לא יתקדם.
בנוסף, כשמבצעים הפעלה עוקבת באותה סביבה,
הפעילות ברקע ממשיכה ומשבשת את ההפעלה החדשה. הדבר עלול לגרום להתנהגות לא צפויה ולשגיאות שקשה לאבחן. בדרך כלל, גישה לרשת אחרי סיום הפונקציה מובילה לאיפוס החיבורים (ECONNRESET קוד שגיאה).
לעתים קרובות אפשר לזהות פעילות ברקע ביומנים של קריאות נפרדות לפונקציה, על ידי חיפוש של כל מה שמתועד אחרי השורה שמציינת שהקריאה לפונקציה הסתיימה. לפעמים פעילות ברקע מוסתרת עמוק יותר בקוד, במיוחד כשקיימות פעולות אסינכרוניות כמו קריאות חוזרות או טיימרים. בודקים את הקוד כדי לוודא שכל הפעולות האסינכרוניות מסתיימות לפני שמסיימים את הפונקציה.
מחיקת קבצים זמניים תמיד
אחסון בדיסק מקומי בספרייה הזמנית הוא מערכת קבצים בזיכרון. קבצים שאתם כותבים צורכים זיכרון שזמין לפונקציה, ולפעמים נשמרים בין הפעלות. אם לא מוחקים את הקבצים האלה באופן מפורש, יכול להיות שבסופו של דבר תתקבל שגיאת חוסר זיכרון, ולאחר מכן תתבצע הפעלה במצב התחלתי (cold start).
כדי לראות את הזיכרון שבו נעשה שימוש בפונקציה מסוימת, בוחרים אותה ברשימת הפונקציות בGoogle Cloud מסוף ובוחרים בתרשים Memory usage (שימוש בזיכרון).
אל תנסו לכתוב מחוץ לספרייה הזמנית, והקפידו להשתמש בשיטות שאינן תלויות בפלטפורמה או במערכת ההפעלה כדי ליצור נתיבי קבצים.
כדי להקטין את דרישות הזיכרון כשמעבדים קבצים גדולים יותר, אפשר להשתמש בצינורות. לדוגמה, אפשר לעבד קובץ ב-Cloud Storage על ידי יצירת זרם קריאה, העברתו דרך תהליך מבוסס-זרם וכתיבת זרם הפלט ישירות ל-Cloud Storage.
Functions Framework
כשפורסים פונקציה, Functions Framework מתווסף באופן אוטומטי כהסתמכות, באמצעות הגרסה הנוכחית שלו. כדי לוודא שאותן תלויות מותקנות באופן עקבי בסביבות שונות, מומלץ להצמיד את הפונקציה לגרסה ספציפית של Functions Framework.
כדי לעשות את זה, צריך לכלול את הגרסה המועדפת בקובץ הנעילה הרלוונטי (לדוגמה, package-lock.json עבור Node.js או requirements.txt עבור Python).
כלים
בקטע הזה מפורטות הנחיות לשימוש בכלים להטמעה, לבדיקה ולביצוע אינטראקציה עם פונקציות Cloud Run.
פיתוח מקומי
פריסת הפונקציה אורכת זמן, ולכן בדרך כלל מהר יותר לבדוק את הקוד של הפונקציה באופן מקומי.
דיווח על שגיאות
בשפות שמשתמשות בטיפול בחריגים, אל תפעילו חריגים שלא נתפסו, כי הם גורמים להפעלות במצב התחלתי (cold start) בהפעלות עתידיות. במדריך לדיווח על שגיאות מוסבר איך לדווח על שגיאות בצורה נכונה.
לא לצאת באופן ידני
יציאה ידנית עלולה לגרום להתנהגות לא צפויה. במקום זאת, צריך להשתמש בביטויים הבאים שספציפיים לשפה:
Node.js
אל תשתמשו ב-process.exit(). פונקציות HTTP צריכות לשלוח תגובה עם res.status(200).send(message), ופונקציות מבוססות-אירוע יסיימו את הפעולה שלהן אחרי שהן יחזירו ערך (באופן מרומז או מפורש).
Python
אל תשתמשו ב-sys.exit(). פונקציות HTTP צריכות להחזיר באופן מפורש תגובה כמחרוזת, ופונקציות מבוססות-אירועים יסיימו את הפעולה ברגע שהן יחזירו ערך (באופן מרומז או מפורש).
Go
אל תשתמשו ב-os.Exit(). פונקציות HTTP צריכות להחזיר באופן מפורש תגובה כמחרוזת, ופונקציות מבוססות-אירועים יסיימו את הפעולה ברגע שהן יחזירו ערך (באופן מרומז או מפורש).
Java
אל תשתמשו ב-System.exit(). פונקציות HTTP צריכות לשלוח תגובה עם response.getWriter().write(message), ופונקציות מבוססות-אירוע יסיימו את הפעולה שלהן אחרי שהן יחזירו ערך (באופן מרומז או מפורש).
C#
אל תשתמשו ב-System.Environment.Exit(). פונקציות HTTP צריכות לשלוח תגובה עם context.Response.WriteAsync(message), ופונקציות מבוססות-אירוע יסיימו את הפעולה שלהן אחרי שהן יחזירו ערך (באופן מרומז או מפורש).
Ruby
אסור להשתמש ב-exit() או ב-abort(). פונקציות HTTP צריכות להחזיר באופן מפורש תגובה כמחרוזת, ופונקציות מבוססות-אירועים יסיימו את הפעולה ברגע שהן יחזירו ערך (באופן מרומז או מפורש).
PHP
אסור להשתמש ב-exit() או ב-die(). פונקציות HTTP צריכות להחזיר באופן מפורש תגובה כמחרוזת, ופונקציות מבוססות-אירועים יסיימו את הפעולה ברגע שהן יחזירו ערך (באופן מרומז או מפורש).
שימוש ב-Sendgrid לשליחת אימיילים
פונקציות Cloud Run לא מאפשרות חיבורים יוצאים ביציאה 25, ולכן אי אפשר ליצור חיבורים לא מאובטחים לשרת SMTP. הדרך המומלצת לשליחת אימיילים היא באמצעות SendGrid. אפשרויות נוספות לשליחת אימייל מופיעות במדריך שליחת אימייל ממופע של Compute Engine.
ביצועים
בקטע הזה מתוארות שיטות מומלצות לאופטימיזציה של הביצועים.
שימוש חכם בתלות
מכיוון שהפונקציות הן בלי שמירת מצב, סביבת ההרצה מאותחלת לעיתים קרובות מאפס (במהלך מה שנקרא הפעלה במצב התחלתי (cold start)). כאשר מתרחשת הפעלה במצב התחלתי (cold start), ההקשר הגלובלי של הפונקציה מוערך.
אם הפונקציות מייבאות מודולים, זמן הטעינה של המודולים האלה יכול להוסיף לזמן האחזור של הקריאה במהלך הפעלה במצב התחלתי (cold start). כדי לצמצם את זמן האחזור הזה ואת הזמן שנדרש לפריסת הפונקציה, צריך לטעון את התלות בצורה נכונה ולא לטעון תלות שהפונקציה לא משתמשת בה.
שימוש במשתנים גלובליים כדי לעשות שימוש חוזר באובייקטים בהפעלות עתידיות
אין ערובה לכך שהמצב של פונקציה יישמר עבור הפעלות עתידיות. עם זאת, פונקציות Cloud Run ממחזרות לעיתים קרובות את סביבת ההפעלה של קריאה קודמת. אם מצהירים על משתנה בהיקף גלובלי, אפשר לעשות שימוש חוזר בערך שלו בהפעלות הבאות בלי לחשב אותו מחדש.
כך אפשר לשמור במטמון אובייקטים שיכול להיות שיקר ליצור מחדש בכל הפעלה של פונקציה. העברת אובייקטים כאלה מגוף הפונקציה להיקף גלובלי עשויה להוביל לשיפורים משמעותיים בביצועים. בדוגמה הבאה נוצר אובייקט כבד רק פעם אחת לכל מופע של פונקציה, והוא משותף לכל הקריאות לפונקציה שמגיעות למופע הנתון:
Node.js
Python
Go
Java
C#
using Google.Cloud.Functions.Framework; using Microsoft.AspNetCore.Http; using System.Linq; using System.Threading.Tasks; namespace Scopes; public class Function : IHttpFunction { // Global (server-wide) scope. // This computation runs at server cold-start. // Warning: Class variables used in functions code must be thread-safe. private static readonly int GlobalVariable = HeavyComputation(); // Note that one instance of this class (Function) is created per invocation, // so calling HeavyComputation in the constructor would not have the same // benefit. public async Task HandleAsync(HttpContext context) { // Per-function-invocation scope. // This computation runs every time this function is called. int functionVariable = LightComputation(); await context.Response.WriteAsync( $"Global: {GlobalVariable}; function: {functionVariable}", context.RequestAborted); } private static int LightComputation() { int[] numbers = { 1, 2, 3, 4, 5, 6, 7, 8, 9 }; return numbers.Sum(); } private static int HeavyComputation() { int[] numbers = { 1, 2, 3, 4, 5, 6, 7, 8, 9 }; return numbers.Aggregate((current, next) => current * next); } }
Ruby
PHP
use Psr\Http\Message\ServerRequestInterface; function scopeDemo(ServerRequestInterface $request): string { // Heavy computations should be cached between invocations. // The PHP runtime does NOT preserve variables between invocations, so we // must write their values to a file or otherwise cache them. // (All writable directories in Cloud Functions are in-memory, so // file-based caching operations are typically fast.) // You can also use PSR-6 caching libraries for this task: // https://packagist.org/providers/psr/cache-implementation $cachePath = sys_get_temp_dir() . '/cached_value.txt'; $response = ''; if (file_exists($cachePath)) { // Read cached value from file, using file locking to prevent race // conditions between function executions. $response .= 'Reading cached value.' . PHP_EOL; $fh = fopen($cachePath, 'r'); flock($fh, LOCK_EX); $instanceVar = stream_get_contents($fh); flock($fh, LOCK_UN); } else { // Compute cached value + write to file, using file locking to prevent // race conditions between function executions. $response .= 'Cache empty, computing value.' . PHP_EOL; $instanceVar = _heavyComputation(); file_put_contents($cachePath, $instanceVar, LOCK_EX); } // Lighter computations can re-run on each function invocation. $functionVar = _lightComputation(); $response .= 'Per instance: ' . $instanceVar . PHP_EOL; $response .= 'Per function: ' . $functionVar . PHP_EOL; return $response; }
חשוב במיוחד לשמור במטמון חיבורים לרשת, הפניות לספריות ואובייקטים של לקוח API בהיקף גלובלי. דוגמאות מפורטות במאמר בנושא אופטימיזציה של הרשת.
ביצוע אתחול עצלני של משתנים גלובליים
אם מאתחלים משתנים בהיקף גלובלי, קוד האתחול תמיד יופעל באמצעות הפעלה במצב התחלתי (cold start), מה שיגדיל את זמן האחזור של הפונקציה.
במקרים מסוימים, זה גורם לפסק זמן לסירוגין בשירותים שמתבצעת אליהם קריאה, אם הם לא מטופלים בצורה מתאימה בבלוק try/catch. אם חלק מהאובייקטים לא נמצאים בשימוש בכל נתיבי הקוד, כדאי לאתחל אותם לפי דרישה:
Node.js
Python
Go
Java
C#
using Google.Cloud.Functions.Framework; using Microsoft.AspNetCore.Http; using System; using System.Linq; using System.Threading; using System.Threading.Tasks; namespace LazyFields; public class Function : IHttpFunction { // This computation runs at server cold-start. // Warning: Class variables used in functions code must be thread-safe. private static readonly int NonLazyGlobal = FileWideComputation(); // This variable is initialized at server cold-start, but the // computation is only performed when the function needs the result. private static readonly Lazy<int> LazyGlobal = new Lazy<int>( FunctionSpecificComputation, LazyThreadSafetyMode.ExecutionAndPublication); public async Task HandleAsync(HttpContext context) { // In a more complex function, there might be some paths that use LazyGlobal.Value, // and others that don't. The computation is only performed when necessary, and // only once per server. await context.Response.WriteAsync( $"Lazy global: {LazyGlobal.Value}; non-lazy global: {NonLazyGlobal}", context.RequestAborted); } private static int FunctionSpecificComputation() { int[] numbers = { 1, 2, 3, 4, 5, 6, 7, 8, 9 }; return numbers.Sum(); } private static int FileWideComputation() { int[] numbers = { 1, 2, 3, 4, 5, 6, 7, 8, 9 }; return numbers.Aggregate((current, next) => current * next); } }
Ruby
PHP
פונקציות PHP לא יכולות לשמור משתנים בין בקשות. בדוגמה שלמעלה לגבי היקפים נעשה שימוש בטעינה מדורגת כדי לשמור במטמון ערכים של משתנים גלובליים בקובץ.
זה חשוב במיוחד אם מגדירים כמה פונקציות בקובץ אחד, וכל פונקציה משתמשת במשתנים שונים. אם לא משתמשים באתחול עצלן, יכול להיות שתבזבזו משאבים על משתנים שאותחלו אבל אף פעם לא נעשה בהם שימוש.
הפחתת הפעלות במצב התחלתי (cold start) על ידי הגדרת מספר מינימלי של מופעים
כברירת מחדל, פונקציות Cloud Run משנות את מספר המכונות בהתאם למספר הבקשות הנכנסות. אפשר לשנות את התנהגות ברירת המחדל הזו על ידי הגדרת מספר מינימלי של מופעים שפונקציות Cloud Run צריכות לשמור במצב מוכן כדי לטפל בבקשות. הגדרת מספר מינימלי של מופעים מצמצמת את ההפעלה האיטית במצב התחלתי של האפליקציה. מומלץ להגדיר מספר מינימלי של מופעים אם האפליקציה רגישה לזמן האחזור.
במאמר שימוש במספר מינימלי של מכונות מוסבר איך להגדיר מספר מינימלי של מכונות.
מקורות מידע נוספים
מידע נוסף על אופטימיזציה של הביצועים זמין בסרטון 'Google Cloud Performance Atlas' בנושא זמן אתחול קר של פונקציות Cloud Run.