Giter Club home page Giter Club logo

logsnag-kotlin's Introduction

LogSnag

LogSnag Kotlin

Get notifications and track your project events in your Kotlin project.

LogSnag Kotlin Discord Documentation
Badge Android Badge iOS Badge JVM


๐Ÿ“ฆ Setup

  1. Add the following to your build.gradle.kts file:
repositories {
    mavenCentral()
}

dependencies {
    implementation("io.github.vinceglb:logsnag-kotlin:1.0.0")
}
  1. Choose and add to your dependencies one of Ktor's engines. In case of Kotlin Multiplatform project, add an engine to each target.

๐Ÿง‘โ€๐Ÿ’ป Usage

โšก๏ธ Initialize Client

Create an instance of LogSnag client:

val logSnag = LogSnag(
    token = "your-token",
    project = "your-project",
)

๐Ÿ“ Track Event

Send a track event to LogSnag:

logSnag.track(
    channel = "waitlist",
    event = "User Joined",
    description = "A user joined the waitlist",
    icon = "๐ŸŽ‰",
    userId = "user_123",
    tags = mapOf("source" to "google"),
    notify = true,
)

๐Ÿ‘ค User Properties

Identify a user and set their properties:

logSnag.identify(
    userId = "user_123",
    properties = mapOf(
        "name" to "John Doe",
        "email" to "[email protected]",
        "plan" to "premium",
    ),
)

โœจ Track Insight

Send a insight track to LogSnag:

logSnag.insightTrack(
    title = "User Count",
    value = "100",
    icon = "๐Ÿ‘จ",
)

โž• Increment Insight

Increment an insight track to LogSnag:

logSnag.insightIncrement(
    title = "User Count",
    value = 1,
    icon = "๐Ÿ‘จ",
)

๐Ÿคฉ Contributing

To be able to work on the project locally, you need to update the local.properties file with your LogSnag token and project ID:

LOGSNAG_TOKEN=your-token
LOGSNAG_PROJECT=your-project

logsnag-kotlin's People

Contributors

vinceglb avatar

Watchers

 avatar

logsnag-kotlin's Issues

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.