README.md

AWS SAM Applications for Observe Inc

Welcome to the repository for AWS Serverless Application Model (SAM) applications used by Observe Inc. This suite of applications is designed to ingest metrics, monitoring logs, spans, traces, and events from AWS accounts into Observe for comprehensive observability.

Overview

This repository contains multiple SAM applications, each fulfilling a specific role in the observability pipeline. For detailed documentation on each application, please refer to the docs folder.

Cloudformation Quick-Create Links

Stack	Config	Forwarder

Getting Started

To begin using these applications, you'll need to have the AWS CLI and SAM CLI installed and configured. See below for quick instructions on building and deploying an application. For a full development guide, check out the DEVELOPER.md file.

Prerequisites

• AWS CLI
• SAM CLI
• Docker (optional, for linting and local testing)

Building and Deploying an Application

Navigate to an application's directory under apps/ and use the SAM CLI to build and deploy:

cd apps/forwarder
sam build
sam deploy --guided

For more detailed instructions on building, deploying, and publishing applications, please see the corresponding documentation in the docs folder.

Testing

To run tests, use the Go tooling:

go test ./...

For more comprehensive testing instructions, please refer to DEVELOPER.md.

Documentation

Each SAM application has its own documentation, providing specific details and usage instructions:

• Stack
• Forwarder
• MetricStream
• LogWriter
• Config

For development practices, build and release processes, and testing workflows, see the DEVELOPER.md file.

Contributing

We welcome contributions from the community. For more information on the contribution process, commit message standards, and branch naming conventions, please see our CONTRIBUTING.md. For information on how to develop, please read through the DEVELOPER.md file and the documentation for the specific application you are interested in.