Giter VIP home page Giter VIP logo

shardd's Introduction

botDD・SharDDとは?

Botがダウンした際、ユーザー・開発者が気付けるようにするサービスです。

BotDD・SharDDの違いは?

BotDDは他のBotが落ちていないか確認できるBotで、一般ユーザーがどのBotに対しても利用可能です。
一方SharDDは開発者向けに提供しているサービスで、ステータスを監視しているBotDDに比べて高精度での監視が可能です。

SharDDの利用方法

シャードごとのトークンの発行

  1. https://botdd.alpaca131.com/registerにアクセスし、Discordアカウントへのアクセスを許可します。
  2. フォームにBotのID、シャードの数、通知するDiscordのwebhookのURL、メンションするユーザー・ロールのIDを入力します。
  3. 一時TOKENが発行され表示されるので、それをhttps://discord.com/developers/applicationsで自分のBotの説明欄に追記し保存します。
  4. BotDDに戻り、「認証」ボタンをクリックして各シャードのトークンが入ったJSONをダウンロードします。
  5. もう不要なのでBotの説明欄に追記した一時トークンを削除します。

Botからheartbeatの送信

  • 前回のheartbeatから60秒以上アクセスがない場合、Botがダウンしたとみなします。
  • 60秒以内であればアクセス間隔は任意ですが、ネットワークのラグを考慮し60秒ちょうどにすることは推奨しません。
  • チェック間隔は60秒なので、最長でも障害発生から120秒以内には通知されます。
  • アクセス間隔があまりにも短く、当方が攻撃だと判断した場合は予告なくサービスの利用禁止措置を取ることがありますので、くれぐれも常識的な範囲内でのアクセスをお願いします。

heartbeatの送信方法

headerに{"Authorization": "Bearer TOKEN"}を指定し、https://botdd.alpaca131.com/api/heartbeatにPOSTして下さい。
シャードごとのマシン名の表示を行いたい場合はPOSTリクエストのjsonに{"machine_name": "マシン名"}のように指定してください。
※マシン名はSharDDに登録した開発者本人のアカウントでログインしている時のみ表示されます。

サンプルコード(py)

import requests

requests.post("https://botdd.alpaca131.com/api/heartbeat",
              headers={"Authorization": "Bearer TOKEN"},
              json={"machine_name": "レンタルサーバー1"})

shardd's People

Contributors

alpaca131 avatar

Stargazers

tikisan_ avatar Meatwo310 avatar らいとん avatar tomy avatar Naomasa Itakiyo avatar yutarou12 avatar Nanashi. avatar

Watchers

 avatar

Forkers

sevenc-nanashi

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.