Recommend max instances in functions samples (#8772)

* Recommend max instances in functions samples

* Changelog

* 80 character column limit

Author: inlined

CHANGELOG.md

@@ -1,4 +1,5 @@
 - Updated the Data Connect emulator to use pglite 0.3.x and Postgres 17, which fixes some crashes related to wire protocol inconsistencies. (#8679, #8658)
 - Remove container cleanup logic in functions:delete command (#8771)
 - Fixed an issue where the IAM enablement for GenKit monitoring would try to change an invalid service account. (#8756)
+- Added a max instance default to function templates and comments educating users on cost controls. (#8772)
 - Added caching to API enablement checks to reduce burn of `serviceusage.googleapis.com` quota.

templates/init/functions/javascript/index.js

@@ -7,9 +7,22 @@
  * See a full list of supported triggers at https://firebase.google.com/docs/functions
  */
 
-const {onRequest} = require("firebase-functions/v2/https");
+const {setGlobalOptions} = require("firebase-functions");
+const {onRequest} = require("firebase-functions/https");
 const logger = require("firebase-functions/logger");
 
+// For cost control, you can set the maximum number of containers that can be
+// running at the same time. This helps mitigate the impact of unexpected
+// traffic spikes by instead downgrading performance. This limit is a
+// per-function limit. You can override the limit for each function using the
+// `maxInstances` option in the function's options, e.g.
+// `onRequest({ maxInstances: 5 }, (req, res) => { ... })`.
+// NOTE: setGlobalOptions does not apply to functions using the v1 API. V1
+// functions should each use functions.runWith({ maxInstances: 10 }) instead.
+// In the v1 API, each function can only serve one request per container, so
+// this will be the maximum concurrent request count.
+setGlobalOptions({ maxInstances: 10 });
+
 // Create and deploy your first functions
 // https://firebase.google.com/docs/functions/get-started
 

templates/init/functions/python/main.py

@@ -3,8 +3,16 @@
 # Deploy with `firebase deploy`
 
 from firebase_functions import https_fn
+from firebase_functions.options import set_global_options
 from firebase_admin import initialize_app
 
+# For cost control, you can set the maximum number of containers that can be
+# running at the same time. This helps mitigate the impact of unexpected
+# traffic spikes by instead downgrading performance. This limit is a per-function
+# limit. You can override the limit for each function using the max_instances
+# parameter in the decorator, e.g. @https_fn.on_request(max_instances=5).
+set_global_options(max_instances=10)
+
 # initialize_app()
 #
 #

templates/init/functions/typescript/index.ts

@@ -7,12 +7,25 @@
  * See a full list of supported triggers at https://firebase.google.com/docs/functions
  */
 
-import {onRequest} from "firebase-functions/v2/https";
+import {setGlobalOptions} from "firebase-functions";
+import {onRequest} from "firebase-functions/https";
 import * as logger from "firebase-functions/logger";
 
 // Start writing functions
 // https://firebase.google.com/docs/functions/typescript
 
+// For cost control, you can set the maximum number of containers that can be
+// running at the same time. This helps mitigate the impact of unexpected
+// traffic spikes by instead downgrading performance. This limit is a
+// per-function limit. You can override the limit for each function using the
+// `maxInstances` option in the function's options, e.g.
+// `onRequest({ maxInstances: 5 }, (req, res) => { ... })`.
+// NOTE: setGlobalOptions does not apply to functions using the v1 API. V1
+// functions should each use functions.runWith({ maxInstances: 10 }) instead.
+// In the v1 API, each function can only serve one request per container, so
+// this will be the maximum concurrent request count.
+setGlobalOptions({ maxInstances: 10 });
+
 // export const helloWorld = onRequest((request, response) => {
 //   logger.info("Hello logs!", {structuredData: true});
 //   response.send("Hello from Firebase!");