https://github.com/coloredcow/gcp-budget-alerts-service

The micro-service is for tracking and monitoring the spending amount at the GCP service. This micro-service elevates an alert whenever the overall budget surpasses or meets predefined thresholds.
https://github.com/coloredcow/gcp-budget-alerts-service

gcp gcp-budget gcp-cloud-functions gcp-pubsub slack

Last synced: 5 days ago
JSON representation

The micro-service is for tracking and monitoring the spending amount at the GCP service. This micro-service elevates an alert whenever the overall budget surpasses or meets predefined thresholds.

• Host: GitHub
• URL: https://github.com/coloredcow/gcp-budget-alerts-service
• Owner: ColoredCow
• License: mit
• Created: 2023-12-23T11:03:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-21T13:00:38.000Z (8 months ago)
• Last Synced: 2024-05-22T12:51:06.682Z (8 months ago)
• Topics: gcp, gcp-budget, gcp-cloud-functions, gcp-pubsub, slack
• Language: Python
• Homepage:
• Size: 69.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gcp-budget-alerts-service

The microservice is for tracking and monitoring the spending amount at the GCP service. This microservice elevates an alert whenever the overall budget surpasses or meets predefined thresholds.

## Architecture

![_                                          Expected architecture for the Alert service](https://github.com/Sachinbisht27/gcp-budget-alerts-service/assets/96137915/86e87e12-824a-46a9-ba95-07edca694285)

Architecture for the Alert Service


## Installation Guideline

### Prerequisite

1. pyenv

2. python 3.8

3. A Slack App for delivering messages on the channel. [Setup Guideline](./SLACKAPP.md)

### Steps

1. Clone the repository

   ```sh

   git clone https://github.com/ColoredCow/gcp-budget-alerts-service.git

   ```

2. Switch to project folder and setup the vertual environment

   ```sh

   cd gcp-budget-alerts-service

   python -m venv venv

   ```

3. Activate the virtual environment

   ```sh

   source ./venv/bin/activate

   ```

4. Install the dependencies:

   ```sh

   pip install -r requirements-dev.txt

   ```

5. Set up your .env file by copying .env.example

   ```sh

   cp .env.example .env

   ```

6. Add/update variables in your `.env` file for your environment.

7. Run the following command to get started with pre-commit

   ```sh

   pre-commit install

   ```

8. Start the server by following command

   ```sh

   functions_framework --target=handle --debug

   ```