https://github.com/deanpcmad/logsnag

Ruby Library for sending LogSnag events
https://github.com/deanpcmad/logsnag

logsnag ruby rubygem

Last synced: 3 months ago
JSON representation

Ruby Library for sending LogSnag events

• Host: GitHub
• URL: https://github.com/deanpcmad/logsnag
• Owner: deanpcmad
• License: mit
• Created: 2022-04-14T15:35:28.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-01T20:41:07.000Z (about 2 years ago)
• Last Synced: 2024-10-09T16:48:02.785Z (4 months ago)
• Topics: logsnag, ruby, rubygem
• Language: Ruby
• Homepage:
• Size: 8.79 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# LogSnag

Ruby Library for sending LogSnag events.

## Installation

Add this line to your application's Gemfile:

```ruby

gem "logsnag"

```

## Usage

### Set Token

Firstly you'll need to set an API Token.

```ruby

@logsnag = LogSnag::Client.new(token: "")

```

### Sending an Event

```ruby

@logsnag.log(project: "my-project", channel: "channel", event: "my-event")

```

### Sending an Insight

```ruby

@logsnag.insight(project: "my-project", title: "Title of Insight", value: "the-value")

```

Available Options:

- description

- icon - Single emoji for the event icon

- notify - if this event should send a notification

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/logsnag.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).