DEV Community: suraj upadhaya

API Rate Limiting Server

suraj upadhaya — Fri, 01 Nov 2024 11:06:11 +0000

This project implements an HTTP server with rate limiting. It ensures no more than 5 requests per second can be processed.

Introduction
Features
Github link
Installation
Endpoints
Usage
Test
License

Introduction

The API rate limiting server limits the number of requests per second to prevent abuse and manage server load effectively. It provides detailed logging and health check endpoints to monitor server status.

Features

Rate limiting to 5 requests per second
Health check endpoint to monitor server status
Detailed request logging

Github Link

https://github.com/surajupadhaya/Simple-API-RateLimit

Installation

1. Clone the repository:

   #git clone https://github.com/surajupadhaya/Simple-API-RateLimit
   #cd Simple-API-RateLimit


2. Install dependencies:
   #go mod tidy

Endpoints

1. /: Default route returns a "stupid request" message with status 400.

2. /healthcheck: Endpoint to check the health status of the server. Returns "Health Passed" if the /healthcheck file exists, otherwise "Health Failed".

3. /api/v1/product: Example endpoint for the product API. Returns "This is a Product API" if the /api/v1/product file exists, otherwise "There is no Product API".

Usage

1. Run the API rate limiting server:
   #go run main.go
2. Access the server:
   #curl -w %{http_code}http://localhost:8080

Test

1. Run Httperf tool to test the rate limiting 
Below httperf command is sending 6 connection parallelly in one sec 
Out of 6 only 1 will receive 503 code (due to throttling) remaining will receive based on behavior 
#httperf --server localhost --port 8080 --uri /healthcheck --num-conns 6

Sample output :

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/842aqi7lmzqw7sa1mcs1.png)

License

This project is licensed under the MIT License. See the LICENSE file for details.

This `README.md` should cover the current state of your project, focusing on the API rate limiting aspect. Ready to roll? 🚀


This should cover everything your project entails. You can add, modify, or remove sections as needed. 🚀

Docker Container health Dashboard in Go

suraj upadhaya — Sun, 12 May 2024 17:51:32 +0000

Under the Hood

At its core, the application is written in Go, a language known for its simplicity and performance. It interacts with Docker through the docker/docker client, which provides a rich set of functions to manage container lifecycles.

Key Features

Container Health Check: The ContainerHandler function serves as an endpoint that lists all Docker containers and their statuses, providing a quick health check for the system.

Dashboard Serving: The customHandler function serves a static HTML dashboard, allowing users to visualize the state of their Docker environment.

Snippet of Dashboard

https://github.com/surajupadhaya/containerDashboard

Use Circle CI to deploy Flask-Python app in Docker

suraj upadhaya — Fri, 26 Apr 2024 19:12:34 +0000

Clone the repo

Repo: https://github.com/surajupadhaya/Portfolio-app

Push the same code to your repository.

Setup the Circle CI (free CI/CD tool) with GitHub

Sign in to your CircleCI account.

Connect your GitHub account to CircleCI.
Once connected, you’ll see your existing projects populate on your CircleCI dashboard.
Add the environment variable by click on project setting option you will find Environment variable option
$Hub_Pass = docker hub password
$Hub_user = docker hub username

Now make changes in templates/index.html file as needed

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Suraj Upadhaya</title>
    <style>
        /* Basic styling */
        body {
            font-family: 'IBM Plex Mono', monospace;
            margin: 0;
            padding: 0;
            overflow: hidden;
            background: url('../static/stars2.jpg') fixed;
            background-size: cover;
        }
        .container {
            max-width: 800px;
            margin: 0 auto;
            padding: 20px;
            background-color: rgba(255, 255, 255, 0.8);
            border-radius: 5px;
            box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
        }
        h1 {
            color: #833AB4;
            font-size: 36px;
            font-weight: bold;
            text-align: center;
            margin-bottom: 20px;
        }
        p {
            color: #333;
            font-size: 18px;
            text-align: center;
        }
        a {
            color: #FD1D1D;
            text-decoration: none;
        }
        .logo-container {
            display: flex;
            justify-content: center;
            align-items: center;
            margin-top: 20px;
        }
        .logo {
            width: 30px;
            height: 30px;
            margin-right: 10px;
        }
    </style>
</head>
<body>
    <div class="stars"></div>
    <div class="container">
        <h1>!! Hey !!</h1>
        <p>Check out my <a href="https://github.com/surajupadhaya">GitHub profile</a> and connect with me on <a href="https://www.linkedin.com/in/surajupadhaya/">LinkedIn</a>.</p>
    <p style="font-family: Arial, sans-serif; font-size: 18px; color: #333;">Tech Stack:</p>
    <ul style="font-family: 'Courier New', monospace; font-size: 16px; color: #666;">
        <li><a href="https://docs.ansible.com/">Ansible</a></li>
        <li><a href="https://www.gnu.org/software/bash/manual/">Bash</a></li>
        <li><a href="https://www.perl.org/docs.html">Perl</a></li>
        <li><a href="https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/">Azure Bicep</a></li>
        <li><a href="https://docs.python.org/3/">Python</a></li>
    </ul>
        <div class="logo-container">
            <a href="https://github.com/surajupadhaya"><img class="logo" src="../static/github-logo.png" alt="GitHub Logo"></a>
            <a href="https://www.linkedin.com/in/surajupadhaya/"><img class="logo" src="../static/linkedin-logo.png" alt="LinkedIn Logo"></a>
        </div>
    </div>
</body>
</html>

change Title name , GitHub repo link , LinkedIn link

<title>Suraj Upadhaya</title>
<p>Check out my <a href="https://github.com/surajupadhaya">GitHub profile</a> and connect with me on <a href="https://www.linkedin.com/in/surajupadhaya/">LinkedIn</a>.</p>

Push to your repository with the changes, Once pushed you will see the circle Ci pipeline get triggered and it starts to build the Docker images with python app and try to push the image to docker hub registry.
Once build is complete it will start with deploy the container and try to curl the localhost on port 5500 for html output of that application.

If you don't want to trigger the pipeline for any change push to repository then use [skip ci] in your commit message

Basic Structure of .circleci/config.yml

jobs:
  build :
     steps:
       - run:
         command: echo "hello word"
  deploy:
     steps:
       - run:
         command: echo "hello word"
workflows:
   "how you want your jobs to run "

Snippet below

BUILD :

jobs:

  build:
    docker:
      - image: cimg/base:current
    steps:
      - checkout
      - setup_remote_docker
      - run :
           name: Build the image from Docker file 
           command: |
             docker build -t suru12/portflask-cci:v1 .
             echo $Hub_Pass |docker login -u $Hub_user --password-stdin
             docker push suru12/portflask-cci:v1

This step images will get create according to the Dockefile and the image will get pushed to docker hub

DEPLOY:

 - run :
           name: Run the docker container with suraj/portflask-cci:v1 images 
           command: |
              docker run -d  --name portfolio -p 5500:5000 suru12/portflask-cci:v1
              sleep 20 
              curl localhost:5500

This step will run the docker container using the same image you just created and try to run curl on localhost:5500