Getting Started

Welcome to Serverless Console, a developer-first observability service for apps built on serverless architectures.

Here's what you need to start using Serverless Console.

Onboard using the browser

Sign up and create your org on Serverless Console and follow the prompts to add an AWS account integration.

Onboard using the Serverless Framework

If you are a Serverless Framework user, you can onboard to Serverless Console from the CLI.

Upgrade to version 3.24.0+

npm install -g serverless

Run this command to add the AWS Account integration.

serverless --console 

You'll need to deploy the function if you haven't already.

serverless deploy

Next, you'll need to instrument the newly deployed function from the browser.

Instrument a function

If you haven't already enabled instrumentation on a function while onboarding, you'll need to instrument an AWS Lambda function to enable logs, traces, spans, and events, in Serverless Console.

Follow these Instrumentation steps to enable instrumentation on your function.

Add custom instrumentation (optional)

In addition to the automatic instrumentation of your AWS Lambda functions, you can also add custom instrumentation for setting tags, and events in your code.

Use the Node.js or Python Serverless SDK to add custom instrumentation to Node.js 12+ and Python 3.8+. Other runtime support is coming soon.

Invoke & Observe

Now you are ready to see your data in Serverless Console.

If you haven't already, invoke your function.

If you set the Instrumentation Mode to Dev, then you'll see the traces, spans, logs, and events in DevMode in real-time.

You'll also be able to use the Metrics and Explorer to view all the metrics, traces, spans, logs, and events. This works with both Dev and Prod Instrumentation Modes. After an invocation, it may take 3 minutes to be made available on the Metrics and Explorer pages.