logtail 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a6b0738bfe520cbd3e443365dff1cb77b6e2ae2849799badf8d47f785df52d4
-  data.tar.gz: ba02074bd5ee3e2ced09e286712c2af97b6b78175e06d372c50e4bc1a158d114
+  metadata.gz: 6cb9ce58d42f8eaae77256309904b1e1f1d34974ffb2baf9d08b3ae8f9bc9add
+  data.tar.gz: cee900d3422c3d51c4b5915b54281c7b4522e1ae49c14e72820539080b013870
 SHA512:
-  metadata.gz: 0f1f0865055d6f29eff1d251e8f4b13609ce3306ae2b2e72bd38afb44294c28d562ec7ee3aac74a4fd9ad386c302743d5a9c929741c511401afd50f8e59638ff
-  data.tar.gz: c95ee4374d040f864130b6f5ed0fc4f732e94e6d9b17b64c6579cea8fad59f1710b422a878b6bd798cf09b9d773ef0f3a86e609ac597c87d3c3b3c7ae77e2f1f
+  metadata.gz: 8d7fa9ab0b8ed9b7cb23d5a940485bc523037c31134f68a6a0e9adf91190ef22284008e650b95406d1bb76834744d889569dab81943b3af0ebc69fdda73519a7
+  data.tar.gz: 20d6428149c7e2f0687cc0c0af867f16ff1f495c7622b49afef8e661f83900c31c46a00b322e9f15510202f877d70d17196c0163efbfd460b03a2fa8a881e4f5

data/README.md

@@ -1,69 +1,22 @@
-# 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)
+# [Better Stack](https://betterstack.com/logs) Ruby client
 
-[![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.
+📣 Logtail is now part of Better Stack. [Learn more ⇗](https://betterstack.com/press/introducing-better-stack/)
 
-Alternatively, add `gem "logtail"` to your `Gemfile` manually and then run `bundle install`.
+[![Better Stack dashboard](https://github.com/logtail/logtail-python/assets/10132717/e2a1196b-7924-4abc-9b85-055e17b5d499)](https://betterstack.com/logs)
 
----
-
-# 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.
+[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
+[![Gem Version](https://badge.fury.io/rb/logtail.svg)](https://badge.fury.io/rb/logtail)
+[![Build Status](https://github.com/logtail/logtail-ruby/workflows/build/badge.svg)](https://github.com/logtail/logtail-ruby/actions?query=workflow%3Abuild)
 
- ## Run the example project
- 
- To run the example application, run the following command:
+Experience SQL-compatible structured log management based on ClickHouse. [Learn more ⇗](https://betterstack.com/logs)
 
-```bash
-bundle exec ruby main.rb <source-token>
-```
+## Documentation
 
-*Don't forget to replace `<source-token>` with your actual source token which you can find by going to logtail.com -> sources -> edit.*
+[Getting started ⇗](https://betterstack.com/docs/logs/ruby-and-rails/#logging-from-ruby)
 
-This will create a total of 5 different logs, each corresponding to a different log level. You can review these logs in Logtail.
+## Need help?
+Please let us know at [hello@betterstack.com](mailto:hello@betterstack.com). We're happy to help!
 
-## 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).
+[ISC license](https://github.com/logtail/logtail-ruby/blob/main/LICENSE.md), [example project](https://github.com/logtail/logtail-ruby/tree/main/example-project)

data/Rakefile

@@ -15,7 +15,7 @@ def puts_with_level(message, level = :info)
 end
 
 task :test_the_pipes, [:source_token] do |t, args|
-  support_email = "support@logtail.com"
+  support_email = "hello@betterstack.com"
   # Do not modify below this line. It's important to keep the `Logtail::Logger`
   # because it provides an API for logging structured data and capturing context.
   header = <<~HEREDOC
@@ -31,7 +31,7 @@ task :test_the_pipes, [:source_token] do |t, args|
   if response.is_a?(Exception)
     message = <<~HEREDOC
         Unable to deliver logs.
-        Here's what we received from the Logtail API:
+        Here's what we received from the Better Stack Telemetry API:
         #{response.inspect}
         If you continue to have trouble please contact support:
         #{support_email}
@@ -39,13 +39,13 @@ task :test_the_pipes, [:source_token] do |t, args|
     puts_with_level(message, :error)
   elsif response.is_a?(Net::HTTPResponse)
     if response.code.start_with? '2'
-      puts_with_level("Logs successfully sent! View them at https://logtail.com",
+      puts_with_level("Logs successfully sent! View them at https://telemetry.betterstack.com",
         :success)
     else
       message =
         <<~HEREDOC
         Unable to deliver logs.
-        We received a #{response.code} response from the Logtail API:
+        We received a #{response.code} response from the Better Stack Telemetry API:
         #{response.body.inspect}
         If you continue to have trouble please contact support:
         #{support_email}

data/example-project/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gem "logtail", "~> 0.1.12"
+gem "logtail", "~> 0.1.14"

data/example-project/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    logtail (0.1.12)
+    logtail (0.1.14)
       msgpack (~> 1.0)
     msgpack (1.7.2)
 
@@ -9,7 +9,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  logtail
+  logtail (~> 0.1.14)
 
 BUNDLED WITH
    2.1.4

data/example-project/README.md

@@ -15,13 +15,13 @@ 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_.
- 
+
+_Don't forget to replace `<source_token>` and `<ingesting_host>` with your actual source token and ingesting host which you can find by going to **[Sources](https://telemetry.betterstack.com/team/0/sources) -> Configure** in Better Stack._ 
+
  To run the example application, run the following command adding your source token:
 
 ```bash
-bundle exec ruby main.rb <source-token>
+bundle exec ruby main.rb <source_token> <ingesting_host>
 ```
 
 This will create a total of 5 different logs, each corresponding to a different log level. You can review these logs in Logtail.

data/example-project/main.rb

@@ -7,12 +7,12 @@
 require "logtail"
 
 # Check for program arguments
-if ARGV.length != 1
-    puts "Program needs source token to run. Run the program as followed\nbundle exec ruby main.rb <source-token>"
+if ARGV.length != 2
+    puts "Program needs source token and ingesting host to run. Run the program as followed\nbundle exec ruby main.rb <source_token> <ingesting_host>"
     exit
 end
 # Create logger
-http_device = Logtail::LogDevices::HTTP.new(ARGV[0])
+http_device = Logtail::LogDevices::HTTP.new(ARGV[0], ingesting_host: ARGV[1])
 logger = Logtail::Logger.new(http_device)
 
 # Filter logs that shouldn't be sent to Better Stack, see {Logtail::LogEntry} for available attributes
@@ -21,10 +21,10 @@ Logtail.config.filter_sent_to_better_stack { |log_entry| log_entry.message.inclu
 # LOGGING
 
 # Send debug logs messages using the debug() method
-logger.debug("Logtail is ready!")
+logger.debug("Better Stack is ready!")
 
 # Send informative messages about interesting events using the info() method
-logger.info("I am using Logtail!")
+logger.info("I am using Better Stack!")
 
 # Send messages about worrying events using the warn() method
 # You can also log additional structured data

data/lib/logtail/config.rb

@@ -46,7 +46,7 @@ module Logtail
     # See {Logtail::LogEntry} for available attributes of the block parameter.
     #
     # @example Rails
-    #   config.logtail.filter_sent_to_better_stack { |log_entry| log_entry.context_snapshot[:http][:path].start_with?('_') }
+    #   config.logtail.filter_sent_to_better_stack { |log_entry| log_entry.context_snapshot[:http][:path].start_with?('/_') }
     # @example Everything else
     #   Logtail.config.filter_sent_to_better_stack { |log_entry| log_entry.message.include?('IGNORE') }
     def filter_sent_to_better_stack(&block)

data/lib/logtail/log_devices/http.rb

@@ -17,13 +17,11 @@ module Logtail
     #
     # See {#initialize} for options and more details.
     class HTTP
-      LOGTAIL_STAGING_HOST = "in.logtail.dev".freeze
-      LOGTAIL_PRODUCTION_HOST = "in.logtail.com".freeze
-      LOGTAIL_HOST = ENV['LOGTAIL_STAGING'] ? LOGTAIL_STAGING_HOST : LOGTAIL_PRODUCTION_HOST
-      LOGTAIL_PORT = 443
-      LOGTAIL_SCHEME = "https".freeze
+      DEFAULT_INGESTING_HOST = "in.logs.betterstack.com".freeze
+      DEFAULT_INGESTING_PORT = 443
+      DEFAULT_INGESTING_SCHEME = "https".freeze
       CONTENT_TYPE = "application/msgpack".freeze
-      USER_AGENT = "Logtail Ruby/#{Logtail::VERSION} (HTTP)".freeze
+      USER_AGENT = "Better Stack Telemetry for Ruby/#{Logtail::VERSION} (HTTP)".freeze
 
       # Instantiates a new HTTP log device that can be passed to {Logtail::Logger#initialize}.
       #
@@ -36,15 +34,15 @@ module Logtail
       # you can drop the log messages instead by passing a {DroppingSizedQueue} via the
       # `:request_queue` option.
       #
-      # @param source_token [String] The API key provided to you after you add your application to
-      #   [Logtail](https://logtail.com).
+      # @param source_token [String] The API key provided to you after you add your source to
+      #   [Better Stack](https://telemetry.betterstack.com).
       # @param [Hash] options the options to create a HTTP log device with.
       # @option attributes [Symbol] :batch_size (1000) Determines the maximum of log lines in
       #   each HTTP payload. If the queue exceeds this limit an HTTP request will be issued. Bigger
       #   payloads mean higher throughput, but also use more memory. Logtail will not accept
       #   payloads larger than 1mb.
       # @option attributes [Symbol] :flush_continuously (true) This should only be disabled under
-      #   special circumstsances (like test suites). Setting this to `false` disables the
+      #   special circumstances (like test suites). Setting this to `false` disables the
       #   continuous flushing of log message. As a result, flushing must be handled externally
       #   via the #flush method.
       # @option attributes [Symbol] :flush_interval (1) How often the client should
@@ -55,25 +53,30 @@ module Logtail
       #   single persistent connection. After this number is met, the connection will be closed
       #   and a new one will be opened.
       # @option attributes [Symbol] :request_queue (FlushableDroppingSizedQueue.new(25)) The request
-      #   queue object that queues Net::HTTP requests for delivery. By deafult this is a
+      #   queue object that queues Net::HTTP requests for delivery. By default this is a
       #   `FlushableDroppingSizedQueue` of size `25`. Meaning once the queue fills up to 25
       #   requests new requests will be dropped. If you'd prefer to apply back pressure,
       #   ensuring you do not lose log data, pass a standard {SizedQueue}. See examples for
       #   an example.
-      # @option attributes [Symbol] :logtail_host The Logtail host to delivery the log lines to.
-      #   The default is set via {LOGTAIL_HOST}.
+      # @option attributes [Symbol] :ingesting_host The Better Stack Telemetry ingesting host to delivery the log lines to.
+      #   The default is set via {INGESTING_HOST}.
       #
       # @example Basic usage
-      #   Logtail::Logger.new(Logtail::LogDevices::HTTP.new("my_logtail_source_token"))
+      #   Logtail::Logger.new(Logtail::LogDevices::HTTP.new("<source_token>", ingesting_host: "<ingesting_host>"))
       #
       # @example Apply back pressure instead of dropping messages
-      #   http_log_device = Logtail::LogDevices::HTTP.new("my_logtail_source_token", request_queue: SizedQueue.new(25))
+      #   http_log_device = Logtail::LogDevices::HTTP.new("<source_token>", ingesting_host: "<ingesting_host>", request_queue: SizedQueue.new(25))
       #   Logtail::Logger.new(http_log_device)
       def initialize(source_token, options = {})
+        # Handle backward-compatibility of argument names
+        options[:ingesting_host] ||= options[:ingesting_host] if options[:ingesting_host].present?
+        options[:ingesting_port] ||= options[:logtail_port] if options[:logtail_port].present?
+        options[:ingesting_scheme] ||= options[:logtail_scheme] if options[:logtail_scheme].present?
+
         @source_token = source_token || raise(ArgumentError.new("The source_token parameter cannot be blank"))
-        @logtail_host = options[:logtail_host] || ENV['LOGTAIL_HOST'] || LOGTAIL_HOST
-        @logtail_port = options[:logtail_port] || ENV['LOGTAIL_PORT'] || LOGTAIL_PORT
-        @logtail_scheme = options[:logtail_scheme] || ENV['LOGTAIL_SCHEME'] || LOGTAIL_SCHEME
+        @ingesting_host = options[:ingesting_host] || ENV['INGESTING_HOST'] || ENV['LOGTAIL_HOST'] || DEFAULT_INGESTING_HOST
+        @ingesting_port = options[:ingesting_port] || ENV['INGESTING_PORT'] || ENV['LOGTAIL_PORT'] || DEFAULT_INGESTING_PORT
+        @ingesting_scheme = options[:ingesting_scheme] || ENV['INGESTING_SCHEME'] || ENV['LOGTAIL_SCHEME'] || DEFAULT_INGESTING_SCHEME
         @batch_size = options[:batch_size] || 1_000
         @flush_continuously = options[:flush_continuously] != false
         @flush_interval = options[:flush_interval] || 2 # 2 seconds
@@ -153,7 +156,7 @@ module Logtail
           if @last_resp.nil?
             print "."
           elsif @last_resp.code == "202"
-            puts "Log delivery successful! View your logs at https://logtail.com"
+            puts "Log delivery successful! View your logs at https://telemetry.betterstack.com"
           else
             raise <<-MESSAGE
 
@@ -282,9 +285,9 @@ MESSAGE
 
         # Builds an `Net::HTTP` object to deliver requests over.
         def build_http
-          http = Net::HTTP.new(@logtail_host, @logtail_port)
+          http = Net::HTTP.new(@ingesting_host, @ingesting_port)
           http.set_debug_output(Config.instance.debug_logger) if Config.instance.debug_logger
-          if @logtail_scheme == 'https'
+          if @ingesting_scheme == 'https'
             http.use_ssl = true
             # Verification on Windows fails despite having a valid certificate.
             http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -360,7 +363,7 @@ MESSAGE
 
               Logtail::Config.instance.debug do
                 if resp.code == "202"
-                  "Logs successfully sent! View your logs at https://logtail.com"
+                  "Logs successfully sent! View your logs at https://telemetry.betterstack.com"
                 else
                   "Log delivery failed! status: #{resp.code}, body: #{resp.body}"
                 end

data/lib/logtail/log_entry.rb

@@ -16,7 +16,7 @@ module Logtail
 
     attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time
 
-    # Creates a log entry suitable to be sent to the Logtail API.
+    # Creates a log entry suitable to be sent to the Better Stack Telemetry API.
     # @param level [Integer] the log level / severity
     # @param time [Time] the exact time the log message was written
     # @param progname [String] the progname scope for the log message
@@ -134,13 +134,13 @@ module Logtail
       end
 
       def logtail_logger_frame?(frame)
-        !frame.absolute_path.nil? && frame.absolute_path.end_with?(LOGGER_FILE)
+        !frame.path.nil? && frame.path.end_with?(LOGGER_FILE)
       end
 
       def path_relative_to_app_root(frame)
         Pathname.new(frame.absolute_path).relative_path_from(root_path).to_s
       rescue
-        frame.absolute_path
+        frame.absolute_path || frame.path
       end
 
       def root_path

data/lib/logtail/version.rb

@@ -1,3 +1,3 @@
 module Logtail
-  VERSION = "0.1.12"
+  VERSION = "0.1.14"
 end

data/spec/logtail/log_devices/http_spec.rb

@@ -125,7 +125,7 @@ describe Logtail::LogDevices::HTTP do
     let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
 
     it "should deliver requests on an interval" do
-      stub = stub_request(:post, "https://in.logtail.com/").
+      stub = stub_request(:post, "https://in.logs.betterstack.com/").
         with(
           :body => start_with("\x92\x84\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT")),
           :headers => {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Better Stack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -146,7 +146,6 @@ files:
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md

data/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [0.1.0] - 2021-02-11
-
-- The first version of the client.
-
-## [0.1.2] - 2021-04-22
-
-- Fixed string encoding.
-
-## [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!)