logtail 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0af39db5d892f490e82d5c495f4e51b0646f418a13d4b940566c997aff7e5b1a
-  data.tar.gz: c3e756d0ecc74b2d8128d43914cf677458edce92c8d3bf261047f23a8ae54d65
+  metadata.gz: 4de48b70abbe9cebd9186345e9d410dd6021d53eaeaa9b204e10a364235e5088
+  data.tar.gz: df85920aa4c0f0c91b560816e4f57e4038bc7abf9035410264b134bad26ab9c7
 SHA512:
-  metadata.gz: abd7b6e30cbaa22c698259a59fdaf31a1f46b5c194a14ee9f24b03db08140876c19d25784038235574d9ddbd4b2429ae09f85400291767be88bae60adf023354
-  data.tar.gz: e99b8366d6dcd585f0472091e48b3e4f17f350a3d7ff3a8d97c05022e821a7ab1c05daf5420a512eec76e18ea7e53c3367429bddd53dfeea6488951c9e844c9c
+  metadata.gz: 3edf710be0595d057760e455787ee3b457a84d6e1ac998785a89f06693e05a33cf2c5b7043d133c6e61da732ea0c05a96f11990749455f118c6ca2c80ae19440
+  data.tar.gz: 296e2a96d9f98c4bd11e9f3148524a902104b8fd3d2f0b2ed1482033f2aadf87516093356b1cbf671e3f07c32fd41b7f1ab430d8db648d4e9e06eb2a4e839568

data/CHANGELOG.md

@@ -18,3 +18,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [0.1.3] - 2021-06-11
 
 - Fixed detection of the frame that calls the logger.
+
+## [0.1.7] - 2021-08-16
+
+- Fixed runtime context's frame label encoding.
+
+## [0.1.8] - 2023-01-16
+
+- Fix issue where message is lost when logging hashes with multiple IO devices (thanks @olivier-thatch!)

data/README.md

@@ -1,4 +1,69 @@
-# 🪵 Logtail - Ruby Logging For Everyone
+# Logtail - Ruby Logging Made Easy
+  
+  [![Logtail ruby dashboard](https://user-images.githubusercontent.com/19272921/154085622-59997d5a-3f91-4bc9-a815-3b8ead16d28d.jpeg)](https://betterstack.com/logtail)
 
 [![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
+[![Gem Version](https://badge.fury.io/rb/logtail-ruby.svg)](https://badge.fury.io/rb/logtail-ruby)
 [![Build Status](https://github.com/logtail/logtail-ruby/workflows/build/badge.svg)](https://github.com/logtail/logtail-ruby/actions?query=workflow%3Abuild)
+
+Collect logs directly from your Ruby projects. To start logging Ruby on Rails projects explore the [Logtail Rails library](https://github.com/logtail/logtail-ruby-rails).
+
+[Logtail](https://betterstack.com/logtail) is a hosted service that centralizes all of your logs into one place. Allowing for analysis, correlation and filtering with SQL. Actionable Grafana dashboards and collaboration come built-in. Logtail works with [any language or platform and any data source](https://docs.logtail.com/). 
+
+### Features
+- Simple integration.
+- Support for structured logging and events.
+- Automatically captures useful context.
+- Performant, light weight, with a thoughtful design.
+
+### Supported language versions
+- Ruby 2.7.0 or newer
+
+# Installation
+Install the Logtail Ruby client library, run the following command:
+
+```bash
+bundle add logtail
+```
+
+This will install Logtail gem and create `Gemfile` and `Gemfile.lock` that are used to track the code dependencies.
+
+Alternatively, add `gem "logtail"` to your `Gemfile` manually and then run `bundle install`.
+
+---
+
+# Example project
+
+To help you get started with using Logtail in your Ruby projects, we have prepared a simple program that showcases the usage of Logtail logger.
+
+## Download and install the example project
+
+You can download the [example project](https://github.com/logtail/logtail-ruby/tree/main/example-project) from GitHub directly or you can clone it to a select directory. Make sure you are in the projects directory and run the following command:
+
+```bash
+bundle install
+```
+
+This will install all dependencies listed in the `Gemfile.lock` file.
+
+ ## Run the example project
+ 
+ To run the example application, run the following command:
+
+```bash
+ruby main.rb <source-token>
+```
+
+*Don't forget to replace `<source-token>` with your actual source token which you can find by going to logtail.com -> sources -> edit.*
+
+This will create a total of 5 different logs, each corresponding to a different log level. You can review these logs in Logtail.
+
+## Explore how example project works
+ 
+Learn how to setup Ruby logging by exploring the workings of the [example project](https://github.com/logtail/logtail-ruby/tree/main/example-project) in detail. 
+ 
+---
+ 
+## Get in touch
+
+Have any questions? Please explore the Logtail [documentation](https://docs.logtail.com/) or contact our [support](https://betterstack.com/help).

data/example-project/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem "logtail"

data/example-project/Gemfile.lock

@@ -0,0 +1,15 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    logtail (0.1.7)
+      msgpack (~> 1.0)
+    msgpack (1.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  logtail
+
+BUNDLED WITH
+   2.1.4

data/example-project/README.md

@@ -0,0 +1,201 @@
+# Example project
+
+To help you get started with using Logtail in your Ruby projects, we have prepared a simple program that showcases the usage of Logtail logger.
+
+## Download and install the example project
+
+You can download the example project from GitHub directly or you can clone it to a select directory. Make sure you are in the projects directory and run the following command:
+
+```bash
+bundle install
+```
+
+This will install all dependencies listed in the `Gemfile.lock` file.
+
+Alternatively, add `gem "logtail"` to your `Gemfile` manually and then run `bundle install`.
+
+ ## Run the example project
+ 
+ Replace `<source-token>` with your actual source token in the `main.rb` file. You can find your source token by going to _logtail.com -> sources -> edit_.
+ 
+ To run the example application, run the following command adding your source token:
+
+```bash
+ruby main.rb <source-token>
+```
+
+This will create a total of 5 different logs, each corresponding to a different log level. You can review these logs in Logtail.
+
+# Logging
+
+The `logger` instance we created in the installation section is used to send log messages to Logtail. It provides 5 logging methods for the 5 default log levels. The log levels and their method are:
+
+- **DEBUG** - Send debug messages using the `debug()` method
+- **INFO** - Send informative messages about the application progress using the `info()` method
+- **WARN** - Report non-critical issues using the `warn()` method
+- **ERROR** - Send messages about serious problems using the `error()` method
+- **FATAL** - Send messages about fatal events that caused the app to crash using the `fatal()` method
+
+## Logging example
+
+In this example, we will send two logs - **DEBUG** and **INFO**
+
+```ruby
+# Send debug logs messages using the debug() method
+logger.debug("Logtail is ready!")
+
+# Send informative messages about interesting events using the info() method
+logger.info("I am using Logtail!")
+```
+
+This will create the following output:
+
+```json
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "debug",
+    "message": "Logtail is ready!",
+    "context": {
+        "runtime": {
+            "thread_id": 123,
+            "file": "main.rb",
+            "line": 6,
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        }
+    }
+}
+
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "info",
+    "message": "I am using Logtail!",
+    "context": {
+        "runtime": {
+            "thread_id": 123,
+            "file": "main.rb",
+            "line": 6,
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        }
+    }
+}
+```
+
+## Log structured data
+
+You can also log additional structured data. This can help you provide additional information when debugging and troubleshooting your application. You can provide this data as the second argument to any logging method.
+
+```ruby
+# Send messages about worrying events using the warn() method
+# You can also log additional structured data
+logger.warn(
+    "log structured data",
+    item: {
+        url: "https://fictional-store.com/item-123",
+        price: 100.00
+    }
+)
+```
+
+This will create the following output:
+
+```json
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "warn",
+    "message": "log structured data",
+    "item": {
+        "url": "https://fictional-store.com/item-123",
+        "price": 100.00
+    },
+    "context": {
+        "runtime": {
+            "thread_id": 123,
+            "file": "main.rb",
+            "line": 7,            
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        }
+    }
+}
+```
+
+## Context
+
+We add information about the current runtime environment and the current process into a `context` field of the logged item by default.
+
+If you want to add custom information to all logged items (e.g., the ID of the current user), you can do so by adding a custom context:
+
+```ruby
+# Provide context to the logs
+Logtail.with_context(user: { id: 123 }) do
+    logger.info('new subscription')
+end
+```
+
+This will generate the following JSON output:
+
+```json
+{
+    "dt": "2021-03-29T11:24:54.788Z",
+    "level": "warn",
+    "message": "new subscription",
+    "context": {
+        "runtime": {
+            "thread_id": 123456,
+            "file": "main.rb",
+            "line": 2,            
+            "frame": null,
+            "frame_label": "<main>"
+        },
+        "system": {
+            "hostname": "hostname"
+            "pid": 1234
+        },
+        "user": {
+            "id": 123
+        }
+    }
+}
+```
+
+We will automatically add the information about the current user to each log if you're using Ruby on Rails and the Devise gem.
+
+If you're not using Devise or you want to log some additional information for every request your Rails app handles, you can easily implement this using Rails' `around_action` in your application controller. A simple implementation could look like this:
+
+```ruby
+class ApplicationController < ActionController::Base
+  around_action :with_logtail_context
+
+  private
+
+    def with_logtail_context
+      if user_signed_in?
+        Logtail.with_context(user_context) { yield }
+      else
+        yield
+      end
+    end
+    
+    def user_context
+      Logtail::Contexts::User.new(
+        id: current_user.id,
+        name: current_user.name,
+        email: current_user.email
+      )
+    end
+end
+```

data/example-project/main.rb

@@ -0,0 +1,42 @@
+# This file showcases usage of logtail on Ruby projects
+# For more information visit https://github.com/logtail/logtail-ruby
+
+# SETUP
+
+# Include logtail library
+require "logtail"
+
+# Check for program arguments
+if ARGV.length != 1
+    puts "Program needs source token to run. Run the program as followed\nruby main.rb <source-token>"
+    exit
+end
+# Create logger
+http_device = Logtail::LogDevices::HTTP.new(ARGV[0])
+logger = Logtail::Logger.new(http_device)
+
+# LOGGING
+
+# Send debug logs messages using the debug() method
+logger.debug("Logtail is ready!")
+
+# Send informative messages about interesting events using the info() method
+logger.info("I am using Logtail!")
+
+# Send messages about worrying events using the warn() method
+# You can also log additional structured data
+logger.warn(
+    "log structured data",
+    item: {
+        url: "https://fictional-store.com/item-123",
+        price: 100.00
+    }
+)
+
+# Send error messages using the error() method
+logger.error("Oops! An error occurred!")
+
+# Send messages about fatal events that caused the app to crash using the fatal() method
+logger.fatal("Application crash! Needs to be fixed ASP!")
+
+puts "All done! You can check your logs now."

data/lib/logtail/log_entry.rb

@@ -129,7 +129,7 @@ module Logtail
         {
           file: path_relative_to_app_root(frame),
           line: frame.lineno,
-          frame_label: frame.label,
+          frame_label: frame.label.dup.force_encoding('UTF-8'),
         }
       end
 

data/lib/logtail/logger.rb

@@ -41,11 +41,13 @@ module Logtail
                          tags: tags)
           elsif logged_obj.is_a?(Hash)
             # Extract the tags
-            tags.push(logged_obj.delete(:tag)) if logged_obj.key?(:tag)
-            tags.concat(logged_obj.delete(:tags)) if logged_obj.key?(:tags)
+            tags.push(logged_obj[:tag]) if logged_obj.key?(:tag)
+            tags.concat(logged_obj[:tags]) if logged_obj.key?(:tags)
             tags.uniq!
 
-            message = logged_obj.delete(:message)
+            message = logged_obj[:message]
+
+            logged_obj = logged_obj.select { |k, _| ![:message, :tag, :tags].include?(k) }
 
             LogEntry.new(level, time, progname, message, context_snapshot, logged_obj, tags: tags)
           else

data/lib/logtail/version.rb

@@ -1,3 +1,3 @@
 module Logtail
-  VERSION = "0.1.6"
+  VERSION = "0.1.8"
 end

data/spec/logtail/log_entry_spec.rb

@@ -30,6 +30,7 @@ describe Logtail::LogEntry do
       expect(hash[:context][:runtime][:file]).to end_with('/spec/logtail/log_entry_spec.rb')
       expect(hash[:context][:runtime][:line]).to be(25)
       expect(hash[:context][:runtime][:frame_label]).to_not be_nil
+      expect(hash[:context][:runtime][:frame_label].encoding.to_s).to eq('UTF-8')
     end
   end
 end

data/spec/logtail/logger_spec.rb

@@ -78,6 +78,16 @@ describe Logtail::Logger do
       expect(io.string).to eq("")
     end
 
+    it "should not lose message when logging hashes with multiple io devices" do
+      io1 = StringIO.new
+      io2 = StringIO.new
+      logger = Logtail::Logger.new(io1, io2)
+      message = {message: "payment rejected", payment_rejected: {customer_id: "abcde1234", amount: 100}}
+      logger.info(message)
+      expect(io1.string).to include("payment rejected")
+      expect(io2.string).to include("payment rejected")
+    end
+
     context "with the AugmentedFormatter" do
       before(:each) { logger.formatter = Logtail::Logger::AugmentedFormatter.new }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Logtail
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -151,6 +151,10 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- example-project/Gemfile
+- example-project/Gemfile.lock
+- example-project/README.md
+- example-project/main.rb
 - lib/logtail.rb
 - lib/logtail/config.rb
 - lib/logtail/config/integrations.rb
@@ -219,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Query logs like you query your database. https://logtail.com