# rs-crisp-status-reporter

[![Test and Build](https://github.com/crisp-im/rs-crisp-status-reporter/workflows/Test%20and%20Build/badge.svg?branch=master)](https://github.com/crisp-im/rs-crisp-status-reporter/actions?query=workflow%3A%22Test+and+Build%22) [![Build and Release](https://github.com/crisp-im/rs-crisp-status-reporter/workflows/Build%20and%20Release/badge.svg)](https://github.com/crisp-im/rs-crisp-status-reporter/actions?query=workflow%3A%22Build+and+Release%22)

* [Documentation](https://docs.rs/crate/crisp-status-reporter)
* [Crate](https://crates.io/crates/crisp-status-reporter)

**Crisp Status Reporter for Rust.**

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 install?

Include `crisp-status-reporter` in your `Cargo.toml` dependencies:

```toml
[dependencies]
crisp-status-reporter = "1.1"
```

## How to use?

### Create reporter

`crisp-status-reporter` can be instantiated as such:

```rust
extern crate crisp_status_reporter;

use std::time::Duration;
use crisp_status_reporter::Reporter;

// Build reporter
let reporter = Reporter::new("YOUR_TOKEN_SECRET")
  .service_id("YOUR_SERVICE_ID")      // Service ID containing the parent Node for Replica (given by Crisp)
  .node_id("YOUR_NODE_ID")            // Node ID containing Replica (given by Crisp)
  .replica_id("192.168.1.10")         // Unique Replica ID for instance (ie. your IP on the LAN)
  .interval(Duration::from_secs(30))  // Reporting interval (in seconds; defaults to 30 seconds if not set)
  .build();

// Run reporter (starts reporting)
reporter.run();
```

## Where can I find my token?

Your private token can be found on your [Crisp dashboard](https://app.crisp.chat/). 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:

<p align="center">
  <img width="605" src="https://crisp-im.github.io/rs-crisp-status-reporter/images/setup.gif" alt="How to add monitored node">
</p>

## Get more help

You can find more help on our helpdesk article: [How to setup the Crisp Status Reporter library?](https://help.crisp.chat/en/article/1koqk09/)