Code Monkey home page Code Monkey logo

deeper-connect-monitoring's Introduction

Deeper Connect Monitoring Guide

This guide is intended to show you how to best monitor your Deeper Connect device using the Deeper CLI utility and if you'd like, also take advantage of New Relic's platform for complete observability allowing you to proactively protect and monitor your Deeper Connect investment (all for free!). Your Deeper Connect device is also an officially listed entity/network device in the New Relic platform, which is powered by the deeper-cli utility.

If you need help, feel free to find me in the Deeper Network Telegram (Kav), raise a GitHub issue. or connect with me on LinkedIn.

This project and guide will never ever ask for your wallet key or mnemonic. You are being scammed if you are! Only trust links from this guide!

Table of contents:


What do you get?

  • Everything below for free!
    • Secure logs & metric backup
    • Secure remote monitoring
    • Alerts with prebuilt and customizable dashboards
    • Monitor multiple devices at scale and group into workloads (great for rig builders!)
    • Access to the Deeper CLI
    • Probably some other stuff...

deeper entity deeper entity deeper entity deeper entity deeper entity deeper entity deeper entity


What is the Deeper CLI?

The Deeper CLI is a command line utility developed in Rust (The same language Deeper Chain is developed in!) that interfaces with the APIs of your Deeper Connect device. It provides a fast and programmatic way of quickly reading, capturing and backing up your devices data. This utility only outputs data to standard out (your terminal output) or to the New Relic Event API if enabled.

Authentication is handled identically to how you log into Atmos Web UI, your password is encrypted and never stored in plain text anywhere. This is safer then storing it in your browsers inbuilt credential manager that stores it in plaintext which can be compromised easily.


Why New Relic?

If you choose to also backup your metrics and logs to New Relic it is worth acknowledging a few key points.


Getting Started

  • If you just want a quick guide on how to use the CLI then view the CLI usage documentation here.

  • If you care about your investment in the Deeper Network and want the best monitoring possible for your device follow the New Relic Setup below which will cover the entire process.

New Relic Setup

  • You will require a Windows or Linux (mac available but untested) device to setup the Deeper CLI to remotely monitor your Deeper Connect device. This device needs to remain on to collect data from your Deeper Connect device to ship to New Relic.

  • You will be able to view all your data and dashboards from anywhere in the world within New Relic once setup.

  • ARM devices such as Raspberry Pi's are also supported with the Linux ARM package.

  • A Mac (darwin) distribution is available, but untested with the New Relic setup although will more then likely work.

  1. Sign up to New Relic
  2. Infrastructure agent install
  3. Create a User API Key for your account (NerdGraph Key)
  4. Create a Insert API Key for your account

With the above information collected, you may use the automated setup (recommended).

Automated (recommended) Manual
5. Deeper CLI automated setup 5. Deeper CLI manual setup
6. No step 6 :) 6. Capture Logs & Connection Data

  1. View Logs
  2. Setting up alerts
  3. Viewing all your data

If you've completed all the above steps, congratulations you're now what we call a DataNerd :)

Upgrading the Deeper CLI

  • The simplest method to upgrade the CLI is to replace the existing binary/executable with one from a newer package
    • This will always work unless there is a breaking change for some reason

Advanced topics

  • What the best way to monitor multiple connect devices from one host?
    • If your host can access each Deeper Connect device on a different address/port you can specify in your config DEEPER_CONNECT_URL with a different URL.
    • Other options include using route tables
    • If you can access each device on a different address then;
      • Do the CLI authentication step again and also supply --deeper-connect-url http://anotherconnectdevice.blah This will generate an encrypted credential for this connect device.
      • Follow from Step 5. again and use a new file name (it can be anything), also supply the DEEPER_CONNECT_URL under the env block in all sections as well.
  • I've got ideas to improve the prebuilt dashboards and alerts?

Deeper CLI Packages

Latest version: 0.2.4

deeper-connect-monitoring's People

Contributors

devfreddy avatar kav91 avatar

Watchers

 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.