logsnag 0.3.2

A logsnag API wrapper
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# A Logsnag API Wrapper for Rust

[![Crate](https://img.shields.io/crates/v/logsnag.svg)](https://crates.io/crates/logsnag)
[![API](https://docs.rs/logsnag/badge.svg)](https://docs.rs/logsnag)

`logsnag` is a simple and efficient Rust library for interacting with the [Logsnag](https://docs.logsnag.com/endpoints/log) API. It supports asynchronous requests and allows easy publication of logs and insights.

Note: this crate is currently being actively developed. It may change a lot until v1.0. Keep this in mind if you're using it for production apps.

## Features

- Publish logs to channels with specified event, optional description, icon, and notify flag
- Publish insights with a specified title, event, value, and an optional icon
- Support tags
- Support validation for inputs on the strings (some)
- [TODO] Make wrapper calls easier (ex. &str instead of Strings, inline tag input)
## Getting Started

First, add `logsnag` to your `Cargo.toml`:

```toml
[dependencies]
logsnag = "0.3.2"
```
Then, import it in your file(s).

```rust
use logsnag::Logsnag;
use logsnag::models::TagHashMap;
use logsnag::models::InsightValue; //Only required for Insights
```

## Usage

Here is a basic example of how to use the `Logsnag` client:

```rust
use logsnag::Logsnag;
use logsnag::models::TagHashMap;
use logsnag::models::InsightValue;

async fn main() {
    let logsnag = Logsnag::new(
        env::var("LOGSNAG_API_KEY").expect("No Logsnag API Key found"), 
        env::var("LOGSNAG_PROJECT").expect("No Logsnag Project found")
    );

    //Use the following for Raw Strings
    //let client = Logsnag::new("my-api-token".to_string(), "my-project".to_string());

    let mut tags = TagHashMap::new();
    tags.insert("guild-id", "test-guild-id");
    tags.insert("User_Name", "test-username-id"); //will auto lowercase and change "_" to "-" to fit API constraints

    let publish_response = logsnag.publish(
        "channel".to_string(),
        "event".to_string(),
        Some("description".to_string()),
        Some("❤️".to_string()),
        Some(true),
        Some(tags)
    ).await.expect("Failed to publish log");

    let insight_response = logsnag.insight(
        "title".to_string(), 
        "event".to_string(), 
        InsightValue::Str("online"), //InsightValue::Int(69), InsightValue::Bool(false)
        Some("❤️".to_string())
    ).await.expect("Failed to publish insight");
}
```

See the [API Documentation](https://docs.rs/logsnag) for more details.

## Contributing

Please feel free to submit issues, fork the repository and send pull requests!

Any questions, you can find me (rhh4x0r) on the [Official Logsnag Discord Server](https://discord.gg/udRNTt7xCJ) or submit an issue.