Giter VIP home page Giter VIP logo

go-crisp-status-reporter's Introduction

go-crisp-status-reporter

Test and Build

Crisp Status Reporter for Golang.

Crisp Status Reporter is used to actively submit health information to Crisp Status from your apps. Apps are best monitored via application probes, which are able to report detailed system information such as CPU and RAM load. This lets Crisp Status show if an application host system is under high load.

How to use?

Create reporter

crisp-status-reporter can be instantiated as such:

import (
  Reporter "github.com/crisp-im/go-crisp-status-reporter/crisp_status_reporter"
  "time"
)

// Build reporter
builder := Reporter.New("YOUR_TOKEN_SECRET")

// Service ID containing the parent Node for Replica (given by Crisp)
// Node ID containing Replica (given by Crisp)
// Unique Replica ID for instance (ie. your IP on the LAN)
// Reporting interval (in seconds; defaults to 30 seconds if not set)
reporter := builder.ServiceID("YOUR_SERVICE_ID").NodeID("YOUR_NODE_ID").ReplicaID("192.168.1.10").Interval(time.Duration(30 * time.Second)).Build()

// Run reporter (starts reporting)
reporter.Run()

Where can I find my token?

Your private token can be found on your Crisp dashboard. Go to Settings, then Status Page, and then scroll down to "Configure your Status Reporter". Copy the secret token shown there, and use it while configuring this library in your application.

How to add monitored node?

You can easily add a push node for the application running this library on your Crisp dashboard. Add the node, and retrieve its service_id and node_id as follows:

How to add monitored node

Get more help

You can find more help on our helpdesk article: How to setup the Crisp Status Reporter library?

go-crisp-status-reporter's People

Contributors

valeriansaliou 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.