A Logsnag API Wrapper for Rust

logsnag is a simple and efficient Rust library for interacting with the Logsnag 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:

[dependencies]
logsnag = "0.3.2"

Then, import it in your file(s).

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:

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 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 or submit an issue.