logtail-rack 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f0b7693831d0097e1496ba79258afc7b8b7cda69d805fa99248cbc79812181
-  data.tar.gz: 23bdde6dc4a16420b3f8604edc3266775b248e2a51177be01c64a314577612d9
+  metadata.gz: ea4d53412f33978d3cc76fc31a163946d6903e7959301178aae01c32e7b51230
+  data.tar.gz: bb99faa3536a6f42582585336689c206b22086455cb24c642a07b97b7d28cf37
 SHA512:
-  metadata.gz: f9dc63f41ea21c4f31360608d82ec1cbf6652cac1774a28695a845a36858a95215ee24d49696278f07267266922659559cee8790a85767e64cd143e833232950
-  data.tar.gz: c1faf9719cac776039dac04d3acc9b91b9520f9f7983a4db242344e9f66cfedd37feb0bfe8b6575185b883918e45b37eaf76a61708f364dd627a8805349f6989
+  metadata.gz: 87d33e37c66ad70843676eb7560ed66ab395f62643eb49670d620008d664c92460f3b293bc429b84f47ac4a363e042c8986575c5472188dcd325ed4bca273970
+  data.tar.gz: 97b69afc3342e0089c542574d2b3babfa2ac45fc96758205d7802761191b455325620f35e7b3e4759d7fc1a85883f8c8abc7a489db26e12000598d5bbd55156f

data/.gitignore

@@ -10,6 +10,7 @@
 .ruby-version
 coverage
 Gemfile.lock
+!/example-project/Gemfile.lock
 *.swp
 *.gem
 

data/README.md

@@ -1,10 +1,22 @@
-# 🪵 Logtail Integration For Rack
+# [Better Stack](https://betterstack.com/logs) Rack client
+
+📣 Logtail is now part of Better Stack. [Learn more ⇗](https://betterstack.com/press/introducing-better-stack/)
+
+[![Better Stack dashboard](https://github.com/logtail/logtail-python/assets/10132717/e2a1196b-7924-4abc-9b85-055e17b5d499)](https://betterstack.com/logs)
 
 [![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
 [![Gem Version](https://badge.fury.io/rb/logtail-rack.svg)](https://badge.fury.io/rb/logtail-rack)
-[![Build Status](https://github.com/logtail/logtail-ruby-rack/workflows/build/badge.svg)](https://github.com/logtail/logtail-ruby-rack/actions?query=workflow%3Abuild)
+[![Build Status](https://github.com/logtail/logtail-ruby-rack/actions/workflows/main.yml/badge.svg)](https://github.com/logtail/logtail-ruby-rack/actions/workflows/main.yml)
+
+Experience SQL-compatible structured log management based on ClickHouse. [Learn more ⇗](https://betterstack.com/logs)
+
+## Documentation
+
+[Getting started ⇗](https://betterstack.com/docs/logs/ruby-and-rails/#logging-from-rack)
+
+## Need help?
+Please let us know at [hello@betterstack.com](mailto:hello@betterstack.com). We're happy to help!
 
-This library integrates the [`logtail` Ruby library](https://github.com/logtail/logtail-ruby) with the [rack](https://github.com/rack/rack) framework,
-turning your Rack logs into rich structured events.
+---
 
-* **Sign-up: [https://logtail.com](https://logtail.com)**
+[ISC license](https://github.com/logtail/logtail-ruby-rack/blob/main/LICENSE.md), [example project](https://github.com/logtail/logtail-ruby-rack/tree/main/example-project)

data/example-project/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "rack", "~> 3.0"
+
+gem "rackup", "~> 2.1"
+
+gem "logtail-rack", "~> 0.2.4"

data/example-project/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    logtail (0.1.12)
+      msgpack (~> 1.0)
+    logtail-rack (0.2.4)
+      logtail (~> 0.1)
+      rack (>= 1.2, < 4.0)
+    msgpack (1.7.2)
+    rack (3.0.0)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    webrick (1.8.1)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  logtail-rack (~> 0.2.4)
+  rack (~> 3.0)
+  rackup (~> 2.1)
+
+BUNDLED WITH
+   2.3.14

data/example-project/README.md

@@ -0,0 +1,40 @@
+# Example project
+
+To help you get started with using Better Stack in your Rack 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-rack/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.
+
+Then replace `<SOURCE_TOKEN>` in `config.ru` with your actual source token which you can find by going to [Better Stack Logs](https://logs.betterstack.com/dashboard) -> Source -> Edit.
+
+```ruby
+http_io_device = Logtail::LogDevices::HTTP.new("<YOUR_ACTUAL_SOURCE_TOKEN>")
+```
+
+## Run the example project
+
+To run the example application, run the following command:
+
+```bash
+rackup
+```
+
+This will start a local server and you visit [http://127.0.0.1:9292](http://127.0.0.1:9292) in your browser.
+
+You should see the following output:
+
+```bash
+All done!
+Log into your Logtail account to check your logs.
+```
+
+This will create a total of 4 different logs. You can review these logs in Better Stack.
+
+You can visit any path on the server to see the request path being logged in context. Visit [/error](http://127.0.0.1:9292) to see an example exception being logged.

data/example-project/config.ru

@@ -0,0 +1,23 @@
+require 'logtail-rack'
+require './logging_app'
+
+# Initialization of logging middlewares
+use Logtail::Integrations::Rack::HTTPContext
+use Logtail::Integrations::Rack::HTTPEvents
+use Logtail::Integrations::Rack::ErrorEvent
+
+# HTTP IO device sends logs to Better Stack, replace <SOURCE_TOKEN> with your real source token
+http_io_device = Logtail::LogDevices::HTTP.new("<SOURCE_TOKEN>")
+
+# STDOUT IO device sends logs to console output
+stdout_io_device = STDOUT
+
+# Logger initialization, you can use any number of IO devices
+logger = Logtail::Logger.new(http_io_device, stdout_io_device)
+Logtail::Config.instance.logger = logger
+
+# App initialization
+logging_app = LoggingApp.new(logger)
+run do |env|
+  logging_app.run(env)
+end

data/example-project/logging_app.rb

@@ -0,0 +1,24 @@
+require 'logtail-rack'
+
+class LoggingApp
+  def initialize(logger)
+    @logger = logger
+  end
+
+  def run(env)
+    @logger.info("I am using Better Stack! 🚀")
+
+    # You can also provide additional information when logging
+    @logger.debug("Logging structured data...",
+      name: {
+        first: "John",
+        last: "Smith"
+      },
+      id: 123456
+    )
+
+    raise RuntimeError.new("Visiting /error raises an error. You should see it in Better Stack.") if env["REQUEST_PATH"].start_with?("/error")
+
+    [200, {}, ["All done!\nLog into your Logtail account to check your logs."]]
+  end
+end

data/lib/logtail-rack/http_context.rb

@@ -12,7 +12,7 @@ module Logtail
         def call(env)
           request = Util::Request.new(env)
           context = Contexts::HTTP.new(
-            host: Util::Encoding.force_utf8_encoding(request),
+            host: Util::Encoding.force_utf8_encoding(request.host),
             method: Util::Encoding.force_utf8_encoding(request.request_method),
             path: request.path,
             remote_addr: Util::Encoding.force_utf8_encoding(request.ip),

data/lib/logtail-rack/http_events.rb

@@ -269,10 +269,11 @@ module Logtail
           end
 
           def filter_http_headers(headers)
-            headers.each do |name, _|
-              normalized_header_name = self.class.normalize_header_name(name)
-              headers[name] = "[FILTERED]" if self.class.http_header_filters&.include?(normalized_header_name)
-            end
+            headers.map do |name, value|
+              normalized_name = self.class.normalize_header_name(name)
+              is_filtered = self.class.http_header_filters&.include?(normalized_name)
+              [name, is_filtered ? "[FILTERED]" : value]
+            end.to_h
           end
 
           def safe_to_i(val)

data/lib/logtail-rack/version.rb

@@ -1,7 +1,7 @@
 module Logtail
   module Integrations
     module Rack
-      VERSION = "0.2.3"
+      VERSION = "0.2.5"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail-rack
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Logtail
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logtail
@@ -100,6 +100,11 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- example-project/Gemfile
+- example-project/Gemfile.lock
+- example-project/README.md
+- example-project/config.ru
+- example-project/logging_app.rb
 - lib/logtail-rack.rb
 - lib/logtail-rack/config.rb
 - lib/logtail-rack/error_event.rb
@@ -136,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Logtail integration for Rack