Git Product home page Git Product logo

celomonitoringscripts's Introduction

Celo Monitoring Tools

Overview

Set of tools to monitor all needs for being a validator on the Celo network.

Running a validator consists of running at least three seperate machines. A proxy that is connect to the internet, a validator that is connect via a private network communicating with the proxy and an attestation service for mapping mobile phone numbers to cryptographic addresses. These scripts monitor the health of the validator and the attestation service. For the time being they DO NOT manage the health of the machines that these services are running on.

Instructions

Set environment variables so the scripts can read information securely.

LINUX

  • source ~/.bash_profile
  • set env variables
    • Attestation
      • CELO_ATTESTATION_IP
      • CELO_ATTESTATION_ERRORS
      • CELO_UNEXPECTED_ERRORS
    • Twilio
      • TWILIO_ACCOUNT_SID
      • TWILIO_AUTH_TOKEN
      • TWILIO_NUMBER_TO_SEND
      • TWILIO_NUMBER
    • Validator
      • CELO_VALIDATOR_RG_ADDRESS
    • Attestation
      • ATTESTATION_SERVICE_SWITCH

Install Celo cli

Install the Celo cli

Install this package

On the machine you have your env variables and the celo cli installed - mkdir monitoringTools && cd monitoringTools - wget https://github.com/abellinii/celoMonitoringScripts.git - Set cronjob to run every minute by $ crontab -e and " * * * * * /home/ubuntu/monitoringTools/monitor.sh >> /home/ubuntu/monitoringTools/mainnetjob.log 2>&1 " - this will also provide a log to help with debugging

Settings

Set the Attestation service logging to on by setting ATTESTATION_SERVICE_SWITCH=1 and ATTESTATION_SERVICE_SWITCH=0 to turn it off

Includes

Terraform Celo Validator Stack

Overview

Inital setup forked from (Celo Repo)[https://github.com/celo-org/celo-monorepo/tree/master/packages/terraform-modules-public/aws] and modified

Terraform is a tool by Hashicorp that allows developers to treat "infrastructure as code", easying the management and repeatibility of the infrastructure. Infrastructure and all kind of cloud resources are defined in modules, and Terraform creates/changes/destroys when changes are applied.

Inside the testnet folder you will find a module (and submodules) to create the setup for running a Celo Validator on Google Cloud Platform. The next logic resources can be created:

The proxy, validator and tx-node services includes the geth-exporter service to export geth metrics for Prometheus. Serving at port 9200, you can configure your Prometheus server to collect the metrics at endpoint http://:9200/metrics

Requirements

Inside the example folder you can find an example tf to use the module. We recommend you to use that tf as base file for your deployment, modifying the account variables used for your convenience. Alternatively you can take that tf files as base for customizing your deployment. Please take care specially about the VPC network configuration. The validators nodes deployed have not a public IP so the access to them is restricted. In order to provide outbound connection of these nodes the VPC network has to be configured with a NAT service allowing external traffic.

Useful documents

celomonitoringscripts's People

Contributors

abellinii avatar

Stargazers

BenAtCLabs avatar

Watchers

James Cloos 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.