Code Monkey home page Code Monkey logo

go-cabot's Introduction

go-cabot

GoDoc

An idiomatic Go client library for interacting with Arachnys' Cabot API.

Cabot is a self-hosted, easily-deployable monitoring, and alerts service - like a lightweight PagerDuty.

TODO

  • Less boilerplate-y
  • Tests (???)
  • More examples

Usage

  1. Download, and install go-cabot/cabot:

    go get github.com/mrsaints/go-cabot/cabot
  2. Import the package into your code:

    import "github.com/mrsaints/go-cabot/cabot"
  3. Construct a Cabot API client:

    auth := cabot.WithBasicAuth("username", "password")
    baseURL := cabot.WithBaseURL("https://your-base-cabot-url/")
    
    // Accepts a variable number of `Option` arguments
    client = cabot.NewClient(auth, baseURL)
  4. Using the newly constructed client, call methods via its respective service:

    // Returns a list of services
    client.Services.List()
    
    // Returns a specific instance using its ID
    client.Instances.Get(1)
    
    // Creates a new ICMP check with "Hello World!" as its name
    check := &cabot.ICMPCheck{cabot.StatusCheck{Name: "Hello World!"}}
    created, _ := client.ICMPChecks.Create(check)
    log.Println(created)

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.