# Templates

Templates are a powerful way to share patterns and best practices when it comes to observing your Serverless app. A template is a collection of .yml files that contain queries, alerts. Templates can be shared publicly or within organisations to help teams consistently manage their o11y, and prevent us from all having to write the same lambda timeout alert for every project!

# Getting started

You can find the templates in the UI when creating new services, or through the baselime cli.

To list the available templates run

baselime templates list

To preview a template run

baselime templates get -w baselime -n metrics

preview a template
preview a template

To save the template as a file you can run baselime templates get -w baselime -n metrics > metrics.yml. This uses the "redirection" operator to redirect the standard output to a file

# Adding templates to services

When you run baselime init to create a service you will be prompted to select templates that you can add.

baselime init service templates
baselime init service templates

The queries and alerts for this template will be available instantly.

To add templates to an existing service edit the .baselime/index.yml file, appending - ${workspace}/${name} to the templates array.

  - name: baselime/dynamodb
  - name: baselime/pokedex

# Becoming a template author

Anyone can publish a template to the Baselime Template Repository. All our example templates can be found on github. If you would like an example templates for an AWS service or find a bug please create an issue

These templates are currently publicly accessible, to publish a private template please get in touch via the baselime-community slack channel

The templates are made up of

  • index.yml file
  • .yml files
  • Optional Licence and README files

The index.yml at the root of the templates folder must contain

# index.yml
service: {{ ERROR }}
provider: aws
description: {{ ERROR }}
version: '1'
# my-first-template.yml
  type: query
    name: "Request Count"
    description: Total number of requests made to the API Gateway
        - apigateway-logs
        - COUNT

You can structure your queries and alerts into any number of files and directories as you would like. Each file can also contain multiple queries and alerts.

To publish a template run

baselime templates publish -p ./template-dir