Skip to content

oslabs-beta/Lumos

Repository files navigation


Lumos Logo

Lumos Lambda Metrics Visualizer

Table of Contents
  1. About Lumos
  2. Techologies Used
  3. Getting Started
  4. Key Lambda Metrics
  5. How to Contribute
  6. License
  7. Contributors

About Lumos

Serverless architecture is an integral benefit of cloud computing which allows developers to build and run services without having to manage the underlying infrastructure. Amazon Web Services' (AWS) Lambda is the dominant service in the serverless market and is relied upon by the world's largest companies due to its cost-effective, event-driven service that runs code in response to events and automatically manages the computing resources required by that code.

One drawback to using AWS's services is that navigating the AWS console can be quite challenging. Additionally, lack of descriptive documentation pertaining to AWS's Lambda service makes it difficult to visualize key function metrics at a glance. To solve this, we built Lumos, a free and open-source AWS lambda monitoring tool that allows users to connect their AWS account to track and visualize their key lambda metrics on a visually appealing UI.

Technologies Used

Getting Started

Lumos requires access keys to sign programmatic requests to the AWS SDK. It is best practice to create an IAM user with permanent long-term credentials to interact with AWS services directly.

  1. In your AWS console, create an new IAM user. Make sure to check off "Access key - Programmatic access" when selecting an AWS credential type. Save these keys in a secure location. They cannot be retrieved after you've completed your IAM setup! If you lose your key, you will have to delete the access key and create a new one.
  1. Attach two existing policies directly to your IAM user's security policy:
  1. Download and install the AWS CLI.

  2. From your terminal, access the AWS CLI by typing in aws configure. Follow the steps on your screen and input your access key ID and secret access key.

Key Lambda Metrics

The key lambda metrics we found to be of most interest to users were invocations, durations, and errors. One can visualize their lambda functions metrics across three different time periods: 24 hours, 1 week, or 1 month. Users can visualize their insights through two charts: donut and line. A donut chart will give an overview of all active invocations relating to the functions. The line chart will give a visualization of the number of times each lambda function has been invoked across selected time periods. Lumos also approximates the total cost of a user's lambda functions based on the function's duration and memory usage.

How to Contribute

At Lumos, we open-sourced the project with the intention of having amazing people iterate on our project.

If you have any suggestions on how to improve Lumos, please follow the steps below:

  1. Fork Lumos
  2. Create your Feature Branch (git checkout -b feature/YourFeature)
  3. Add your changes using (git add .)
  4. Commit your Changes (git commit -m 'Add Your Feature')
  5. Push to the Branch (git push origin feature/YourFeature)
  6. Open a Pull Request
  7. Hit the star button!!

Thank you and we truly appreciate all your contributions!

License

Distributed under the MIT License.

Contributors

About

Lumos is an AWS Lambda visualizer and open source alternative to AWS CloudWatch.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published