# Quickstart Guide

Welcome to Baselime! This quickstart guide will help you get up and running with the platform in just a few steps.

All you need is:

If you do not have a deployed application, you can use one of our example applications.

# Step 1: Sign up for Baselime

To use Baselime, you'll need to sign up for an account. You can sign up for a free account here.

  1. Create a workspace. Typically this will be the name of your organisation.
  2. Start exploring the telemetry data in your workspace sandbox.

# Step 2: (Optional) Install the Baselime CLI

The Baselime CLI is a command-line tool that you can use to interact with the platform. Installing the CLI can make it easier to work with Baselime, unlocks Observability as Code and provides additional functionality not available in the web console. To install the CLI, follow the instructions here.

# Step 3: Connect your AWS account

To start collecting telemetry data from your serverless application, you'll need to connect your AWS account to Baselime. This is done by deploying a CloudFormation template onto your AWS account.

To generate and download the CloudFormation template:

baselime environments connect
  • Follow the prompts to generate and download the template.

Next, you must deploy the template to your AWS account:

  • Click the link provided by the Baselime Console or CLI to open the CloudFormation service in your AWS account
  • Check the box to acknowledge that the template creates IAM roles
  • Click "Create stack" to deploy the stack, making sure to use the correct credentials and region for your AWS account

We've open-sourced the CloudFormation template here.

Once the stack is deployed, telemetry data from your AWS account will be automatically ingested by Baselime and will be available through the various clients.

To verify the connection, invoke any deployed AWS Lambda function in your account and you should see data from it in the Baselime console within seconds. Additionally, you can stream all the events ingested by Baselime directly in your terminal using the baselime tail command.

# Step 4: Explore the data

Once your AWS Account is connected, you can start exploring the telemetry data it generates. You can use the web console or the CLI (if installed) to access and analyze the data.

Baselime ingests and indexes every field and nested field in your telemetry data.

# Accessing data in the web console

To explore the data in the web console:

  • Go to the Baselime Console and sign in with your account
  • Select your environment from the list of environments
  • Use the various filters and tools in the console to slice and dice the data, such as:
    • Filtering by resource type, key-value pair, operation type, or time range
    • Searching for specific strings or regexes in the data
    • Viewing the trace data for a specific request or operation
    • Viewing the logs and metrics for a specific resource or operation
    • Segmenting the results by specific field or nested field

# Accessing data in the CLI

To access the data in the CLI:

If you installed the CLI, you can use the baselime query command to interactively explore the data. Here's how it works:

  1. If you haven't already done so, sign in to the CLI using the baselime login command
  2. Run the following command:
baselime query
  1. Select the service you want to query
  2. Select one of your saved queries or interactively build a query
  3. Enter the start and end time for the query (optional - defaults to the past hour)
  4. The command will output a table with the results of the query and a unique URL that you can share with your team
✔ Running the query
║ Aggregate      │ Value              ║
║ MAX(@duration) │ 8758.75            ║
║ MIN(@duration) │ 2.25               ║
║ P99(@duration) │ 322.98440000000005 ║

Follow this url: https://console.baselime.io/<workspace>/<env>/queries/lambda-duration/1653302639712

# Step 5: Implement Observability as Code

Baselime enables you to define and manage your observability configurations, such as queries and alert rules, using code that can be stored and versioned in your source control repository. This is known as Observability as Code.

To implement observability as code:

  1. Use the baselime init command to create a .baselime folder in your repository and generate an index.yaml file
  2. Answer the prompts to specify metadata about your service, such as its name, description, and details about the cloud infrastructure of the service
  3. The baselime init command will create one or more configuration files in the .baselime folder using the Baselime Observability Reference Language (ORL). The ORL provides a set of commands and syntax for defining configurations such as queries, alert rules, and dashboards.
  4. Use the baselime push command to apply your configurations to your environment.

For example:

baselime push

This will apply your observability configurations to your environment, replacing any existing configurations.

To verify that your configurations have been applied, use the baselime plan command to compare your local configuration files with the ones deployed in your environment.

For more information about the Baselime ORL and how to use it, check out the Reference Guide.

# Step 6: Set up integrations

Baselime offers a variety of integrations with popular tools and services to help you get the most out of your observability data.

To set up an integration:

  1. Go to the Integrations page in the Baselime console
  2. Choose the integration you want to set up from the list
  3. Follow the prompts to configure the integration. This may include providing credentials or setting up webhooks.
  4. Save your changes to complete the setup

For more information about the available integrations and how to use them, check out the Integrations Guide.

# Guides

  • Sending Data: Learn how to ingest telemetry data from your serverless applications
  • Analyzing Data: Discover how to use the various interfaces provided by Baselime to analyze and understand your data
  • Integrations: Find out how to connect Baselime with your favorite tools

# Reference

  • Reference Guide: Learn about the Baselime Observability Reference Language (ORL) and how to use it to define observability configurations
  • CLI Reference: Complete reference for the Baselime command-line interface
  • API Reference: Detailed documentation of the Baselime API

# Community

Join the Baselime community to get help with using the platform, share your own experiences, and stay up-to-date with the latest developments.

  • Slack: Join our Slack community to connect with other Baselime users and get real-time support from the Baselime team
  • Blog: Read about the latest features, best practices, and more from the Baselime team
  • Social media: Follow us on Twitter, LinkedIn, and YouTube to stay up-to-date with the latest news and updates from Baselime

We look forward to connecting with you!