![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@google-cloud/functions-framework
Advanced tools
Changelog
Readme
An open source FaaS (Function as a service) framework for writing portable Node.js functions -- brought to you by the Google Cloud Functions team.
The Functions Framework lets you write lightweight functions that run in many different environments, including:
The framework allows you to go from:
exports.helloWorld = (req, res) => {
res.send('Hello, World');
};
To:
curl http://my-url
# Output: Hello, World
All without needing to worry about writing an HTTP server or complicated request handling logic.
Add the Functions Framework to your package.json
file using npm
.
npm install @google-cloud/functions-framework
Create an index.js
file with the following contents:
exports.helloWorld = (req, res) => {
res.send('Hello, World');
};
Run the following command:
npx @google-cloud/functions-framework --target=helloWorld
Open http://localhost:8080/ in your browser and see Hello, World.
Create an index.js
file with the following contents:
exports.helloWorld = (req, res) => {
res.send('Hello, World');
};
To run a function locally, first create a package.json
file using npm init
:
npm init
Now install the Functions Framework:
npm install @google-cloud/functions-framework
Add a start
script to package.json
, with configuration passed via
command-line arguments:
"scripts": {
"start": "functions-framework --target=helloWorld"
}
Use npm start
to start the built-in local development server:
npm start
...
Serving function...
Function: helloWorld
URL: http://localhost:8080/
Send requests to this function using curl
from another terminal window:
curl localhost:8080
# Output: Hello, World
The
Node.js 10 runtime on Google Cloud Functions
is based on the Functions Framework. On Cloud Functions, the Functions Framework
is completely optional: if you don't add it to your package.json
, it will be
installed automatically.
After you've written your function, you can simply deploy it from your local
machine using the gcloud
command-line tool.
Check out the Cloud Functions quickstart.
Once you've written your function, added the Functions Framework and updated your start
script in package.json
, all that's left is to create a container image. Check out the Cloud Run quickstart for Node.js to create a container image and deploy it to Cloud Run. You'll write a Dockerfile
when you build your container. This Dockerfile
allows you to specify exactly what goes into your container (including custom binaries, a specific operating system, and more).
If you want even more control over the environment, you can deploy your container image to Cloud Run on GKE. With Cloud Run on GKE, you can run your function on a GKE cluster, which gives you additional control over the environment (including use of GPU-based instances, longer timeouts and more).
Cloud Run and Cloud Run on GKE both implement the Knative Serving API. The Functions Framework is designed to be compatible with Knative environments. Just build and deploy your container to a Knative environment.
You can configure the Functions Framework using command-line flags or environment variables. If you specify both, the environment variable will be ignored.
Command-line flag | Environment variable | Description |
---|---|---|
--port | PORT | The port on which the Functions Framework listens for requests. Default: 8080 |
--target | FUNCTION_TARGET | The name of the exported function to be invoked in response to requests. Default: function |
--signature-type | FUNCTION_SIGNATURE_TYPE | The signature used when writing your function. Controls unmarshalling rules and determines which arguments are used to invoke your function. Default: http ; accepted values: http or event |
--source | FUNCTION_SOURCE | The path to the directory of your function. Default: cwd (the current working directory) |
You can set command-line flags in your package.json
via the start
script.
For example:
"scripts": {
"start": "functions-framework --target=helloWorld"
}
The Functions Framework can unmarshall incoming
CloudEvents payloads to data
and context
objects.
These will be passed as arguments to your function when it receives a request.
Note that your function must use the event-style function signature:
exports.helloEvents = (data, context) => {
console.log(data);
console.log(context);
};
To enable automatic unmarshalling, set the function signature type to event
using a command-line flag or an environment variable. By default, the HTTP
signature will be used and automatic event unmarshalling will be disabled.
For more details on this signature type, check out the Google Cloud Functions documentation on background functions.
More advanced guides and docs can be found in the docs/
folder.
Contributions to this library are welcome and encouraged. See CONTRIBUTING for more information on how to get started.
FAQs
FaaS (Function as a service) framework for writing portable Node.js functions
The npm package @google-cloud/functions-framework receives a total of 771,744 weekly downloads. As such, @google-cloud/functions-framework popularity was classified as popular.
We found that @google-cloud/functions-framework demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.