Git Product home page Git Product logo

is-my-api-down's Introduction

Api-Status Checker Slack BOT

This is a small configurable bot that checks URL-x for status at every x-minutes and notifies any x-channel on your slack workspace.

You might end up modifying your API to have a separate /api/status GET route (check ./server.js)

How to setup ๐Ÿ‘ท

  • Create a Slack App
  • Create appropriate scope for the app(chats:read,chats:join)
  • Get the token xoxb..
  • Add the app to your workspace
  • /invite the app to your channel

How to run ๐Ÿƒ ๐Ÿณ

Build the image

docker image build -t <your-tag> .

Run the container

docker run -d -e URL=<YOUR_URL> -e SLACK_TOKEN=<YOUR_SLACK_TOKEN> -e MINUTE=<MINUTE_VALUE> -e CHANNEL=<CHANNEL_NAME> <IMAGE_NAME>

How to test

  • Once everything is setup,you will get the error posted to your channel.

  • In case you want to test, grab the id of your container and go inside it

docker exec -it <container-id> sh
  • run the server (at localhost:3002) and set the URL in the container as localhost:3002
npm run dev

Screenshot

is-my-api-down's People

Contributors

rishabhkodes avatar yashmeh avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.