logtail 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d044ba470b7e68b4da31ecd63bf00d4e35be44cd58ab0af0cb3b3837335692d3
-  data.tar.gz: 58052b27afea62453f35eb9807144554ebc798eec805939b6f5b29a7d7d3156a
+  metadata.gz: cd895e734e1d553b0dfdf1011f0a46b6f043a50c391d27822ee015a517759650
+  data.tar.gz: 964ab22275d822db5df10f3a4616e25d500b0d9292057ea26f4467be40786e63
 SHA512:
-  metadata.gz: aac98143909431c687db15b2b33090f899e044660df8bcd0246b82d3cd62a32c713840189f94e6b9761fbe43953a6cd95e429906a90ba512711efff01fb2e649
-  data.tar.gz: 1cfd8815639f7e1c27483d254a99c2ceedd9884630c4e2fefb3e59f8bb2510166a74f8687038078955679fd55099c6422d4a79baccedd52b461e6af6e8f05de6
+  metadata.gz: 6556a1a6135a0c12070fab2080f43800e48fc0c7acfebab062d70ccc99999dadcbcb913145312d3fd61a0a5ad9f3ab411e6017a2cfe5cb55988867f882a748ec
+  data.tar.gz: 10e8559ff2347820d3e7d0af52c019fbdd84c82507653f232b33e1bfdd9cd35382ba04a109537e6c537b429df857e0383bd2b3930cd60f576d121fb1e1f0f5ab

data/.github/workflows/main.yml

@@ -2,19 +2,22 @@ name: build
 
 on:
   push:
+    branches: [main]
+  pull_request:
   schedule:
     - cron: '20 5 * * 1'
   workflow_dispatch:
 
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     strategy:
       fail-fast: false
 
       matrix:
         ruby-version:
+          - "4.0"
           - "3"
           - "3.4"
           - "3.3"
@@ -24,13 +27,10 @@ jobs:
           - "2.7"
           - "2.6"
           - "2.5"
-          - "jruby-9.4.3.0"
-          - "jruby-9.2.14.0"
-          - "truffleruby-23.0.0"
-          - "truffleruby-22.1.0"
+          - "truffleruby"
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
 
       - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1

data/.github/workflows/no-closing-keywords.yml

@@ -0,0 +1,28 @@
+# Issues in this repo are synced with Linear. A GitHub closing keyword ("Closes #123",
+# "Fixes owner/repo#123") closes the issue the moment the PR merges, while Linear's PR
+# automation moves the linked Linear issue to Self QA at the same time. The two automations
+# then fight: the GitHub issue is closed, reopened, and the Linear issue lands in Triage.
+# Reference the issue with "Refs #123" instead and close it from Linear once the fix is
+# released.
+name: no closing keywords
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+permissions:
+  pull-requests: read
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Reject GitHub closing keywords in the PR description
+        env:
+          BODY: ${{ github.event.pull_request.body }}
+        run: |
+          pattern='\b(close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved)\b:?[[:space:]]+(#[0-9]+|[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+#[0-9]+|https?://github\.com/[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+/issues/[0-9]+)'
+          if matches=$(printf '%s' "$BODY" | grep -inoE "$pattern"); then
+            echo "::error::The PR description contains a GitHub closing keyword, which would close the issue on merge and desync it from Linear:"
+            echo "$matches"
+            echo "Use 'Refs #123' instead and close the issue from Linear once the fix is released."
+            exit 1
+          fi
+          echo "No closing keywords found."

data/.github/workflows/release.yml

@@ -0,0 +1,215 @@
+# Publishes the gem to RubyGems.org from GitHub Actions with trusted publishing (OIDC), the way
+# logtail-js releases the @logtail/* packages to npm. No RubyGems.org API key exists anywhere:
+# the gem on rubygems.org trusts exactly this workflow file, run from this repository in the
+# "rubygems" environment, and the shared account's multi-factor authentication stays as it is.
+#
+# One-time setup on rubygems.org, signed in as the gem's owner: the gem's page → Trusted publishers
+# → GitHub Actions, with the repository owner "logtail", this repository's name, the workflow
+# "release.yml" and the environment "rubygems".
+#
+# Repository settings this relies on: the "rubygems" environment with deployment branches limited
+# to main and no required reviewers (add reviewers there if releases should need an approval; a
+# job that references a missing environment would create it WITHOUT protection), and the GitHub
+# Actions app among the actors allowed to bypass the pull request requirement of main, which the
+# version commit needs.
+#
+# Release: Actions → Release → Run workflow from main, pick patch or minor. The workflow runs the
+# tests, bumps the version in lib/*/version.rb, builds the gem, commits "vX.Y.Z", tags it, pushes
+# both, pushes the gem to RubyGems.org and creates a GitHub release with auto-generated notes for
+# the tag; edit the notes afterwards if needed.
+#
+# Retry: if a release failed after the version commit was pushed, run "retry" from main. It bumps
+# nothing, checks out the tag of the version in lib/*/version.rb and rebuilds that commit, pushes
+# the gem if RubyGems.org is still missing it and creates the GitHub release if it is still
+# missing. Running patch or minor again would release the next version instead.
+#
+# Dry run: bumps in place without committing, builds the gem and, on main, exchanges the
+# workflow's OIDC token with RubyGems.org, which proves that the trusted publisher matches this
+# workflow. Nothing is pushed. Every push that touches this file is a dry run, so a change to the
+# workflow proves itself on its pull request before it reaches main, and the push that merges it
+# performs the token exchange as well, because the "rubygems" environment only admits main. A dry
+# run can also be dispatched from any branch.
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release:
+        description: "patch or minor: bump, tag and publish. retry: finish a release that failed halfway."
+        type: choice
+        options: [patch, minor, retry]
+        required: true
+      dry_run:
+        description: "Dry run: bump and build, verify RubyGems.org accepts this workflow, publish nothing"
+        type: boolean
+        default: false
+  push:
+    paths:
+      - .github/workflows/release.yml
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+env:
+  DRY_RUN: ${{ github.event_name == 'push' || inputs.dry_run }}
+  RELEASE: ${{ inputs.release || 'patch' }}
+
+jobs:
+  verify:
+    name: Test
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3"
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec
+
+  build:
+    name: Bump and build
+    needs: verify
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write # pushes the version commit and the tag
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      gem: ${{ steps.build.outputs.gem }}
+
+    steps:
+      - name: Releases run from main only
+        if: ${{ env.DRY_RUN != 'true' && github.ref != 'refs/heads/main' }}
+        run: |
+          echo "::error::Dispatch the release from main, not from $GITHUB_REF_NAME."
+          exit 1
+
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0 # the version check looks at the tags on HEAD
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3"
+
+      - name: Bump version
+        id: version
+        run: |
+          ruby - <<'EOF'
+          release, dry_run = ENV.fetch("RELEASE"), ENV["DRY_RUN"] == "true"
+          path = Dir["lib/**/version.rb"].fetch(0)
+          source = File.read(path)
+          current = source[/VERSION = "(\d+\.\d+\.\d+)"/, 1] || abort("no VERSION constant in #{path}")
+          tagged = `git tag --points-at HEAD`.split.include?("v#{current}")
+
+          if release == "retry"
+            # main may have moved on since the version commit, so build what the tag points at
+            abort("retry only finishes a release whose version v#{current} is tagged") unless system("git", "rev-parse", "-q", "--verify", "refs/tags/v#{current}", out: File::NULL)
+            system("git", "checkout", "-q", "v#{current}") || abort("could not check out v#{current}")
+            version = current
+          else
+            abort("HEAD is already released as v#{current}, there is nothing new to release") if tagged && !dry_run
+            major, minor, patch = current.split(".").map(&:to_i)
+            version = release == "minor" ? "#{major}.#{minor + 1}.0" : "#{major}.#{minor}.#{patch + 1}"
+            File.write(path, source.sub(%("#{current}"), %("#{version}")))
+          end
+
+          puts "#{current} -> #{version}"
+          File.open(ENV.fetch("GITHUB_OUTPUT"), "a") { |output| output.puts "version=#{version}" }
+          EOF
+
+      - name: Build the gem
+        id: build
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          git diff --stat
+          gem build *.gemspec
+          gem=$(ls *.gem)
+          case "$gem" in
+            *-"$VERSION".gem) ;;
+            *) echo "::error::Built $gem, expected version $VERSION."; exit 1 ;;
+          esac
+          echo "gem=$gem" >> "$GITHUB_OUTPUT"
+
+      - name: Commit and tag
+        if: ${{ env.DRY_RUN != 'true' && env.RELEASE != 'retry' }}
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git commit -am "v$VERSION"
+          git tag -a "v$VERSION" -m "v$VERSION"
+          git push origin main "v$VERSION"
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: gem
+          path: "*.gem"
+          if-no-files-found: error
+
+  release:
+    name: Publish
+    needs: build
+    # The rubygems environment only admits main, so dry runs from other branches stop after the build
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-24.04
+    environment: rubygems
+    permissions:
+      contents: write # creates the GitHub release
+      id-token: write # OIDC token exchange with RubyGems.org
+    env:
+      VERSION: ${{ needs.build.outputs.version }}
+      GEM: ${{ needs.build.outputs.gem }}
+
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: gem
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3"
+
+      # Exchanges the job's OIDC token for a short-lived RubyGems.org API key and hands it to
+      # `gem push`. Fails when no trusted publisher on rubygems.org matches this workflow.
+      - uses: rubygems/configure-rubygems-credentials@v2.1.0
+
+      - name: Dry run
+        if: ${{ env.DRY_RUN == 'true' }}
+        run: |
+          ls -l "$GEM"
+          echo "RubyGems.org accepted the OIDC token: the trusted publisher matches this workflow. Nothing is pushed."
+
+      - name: Push to RubyGems.org
+        if: ${{ env.DRY_RUN != 'true' }}
+        run: |
+          name="${GEM%-$VERSION.gem}"
+          if gem specification --remote "$name" --version "$VERSION" > /dev/null 2>&1; then
+            echo "$name $VERSION is on rubygems.org already, finishing the release."
+          else
+            gem push "$GEM"
+          fi
+
+      - name: Create GitHub release
+        if: ${{ env.DRY_RUN != 'true' }}
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+        run: |
+          if gh release view "v$VERSION" > /dev/null 2>&1; then
+            echo "Release v$VERSION already exists."
+          else
+            # --verify-tag: only ever attach to the tag the build job pushed, never create one here.
+            gh release create "v$VERSION" --verify-tag --generate-notes
+          fi

data/lib/logtail/log_devices/http.rb

@@ -1,4 +1,3 @@
-require "base64"
 require "msgpack"
 require "net/https"
 require "zlib"
@@ -30,10 +29,8 @@ module Logtail
       # options control when the flush happens, `:batch_byte_size` and `:flush_interval`.
       # If either of these are surpassed, the buffer will be flushed.
       #
-      # By default, the buffer will apply back pressure when the rate of log messages exceeds
-      # the maximum delivery rate. If you don't want to sacrifice app performance in this case
-      # you can drop the log messages instead by passing a {DroppingSizedQueue} via the
-      # `:request_queue` option.
+      # By default, the buffer will drop log messages when the rate of log messages exceeds
+      # the maximum delivery rate. You can change this with the `:request_queue` option.
       #
       # @param source_token [String] The API key provided to you after you add your source to
       #   [Better Stack](https://telemetry.betterstack.com).
@@ -122,13 +119,13 @@ module Logtail
       # Closes the log device, cleans up, and attempts one last delivery.
       def close
         # Kill the flush thread immediately since we are about to flush again.
-        @flush_thread.kill if @flush_thread
+        @flush_thread.kill.join if @flush_thread
 
         # Flush all remaining messages
         flush
 
         # Kill the request queue thread. Flushing ensures that no requests are pending.
-        @request_outlet_thread.kill if @request_outlet_thread
+        @request_outlet_thread.kill.join if @request_outlet_thread
       end
 
       def deliver_one(msg)

data/lib/logtail/version.rb

@@ -1,3 +1,3 @@
 module Logtail
-  VERSION = "0.1.17"
+  VERSION = "0.1.19"
 end

data/logtail.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency('msgpack', '~> 1.0')
+  spec.add_dependency('logger', '~> 1.0')
 
   spec.add_development_dependency('bundler-audit', '>= 0')
   spec.add_development_dependency('rails_stdout_logging', '>= 0')

data/spec/logtail/log_devices/http_spec.rb

@@ -57,10 +57,8 @@ describe Logtail::LogDevices::HTTP do
       http.send(:ensure_flush_threads_are_started)
       http.close
       thread = http.instance_variable_get(:@flush_thread)
-      sleep 0.1 # too fast!
       expect(thread).to_not be_alive
       thread = http.instance_variable_get(:@request_outlet_thread)
-      sleep 0.1 # too fast!
       expect(thread).to_not be_alive
     end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logtail
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.19
 platform: ruby
 authors:
 - Better Stack
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -24,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +135,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description:
 email:
 - hello@betterstack.com
 executables: []
@@ -130,6 +142,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
+- ".github/workflows/no-closing-keywords.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
@@ -193,7 +207,6 @@ metadata:
   changelog_uri: https://github.com/logtail/logtail-ruby/tree/master/CHANGELOG.md
   homepage_uri: https://github.com/logtail/logtail-ruby
   source_code_uri: https://github.com/logtail/logtail-ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -208,20 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Query logs like you query your database. https://logs.betterstack.com/
-test_files:
-- spec/README.md
-- spec/logtail/current_context_spec.rb
-- spec/logtail/events/controller_call_spec.rb
-- spec/logtail/events/error_spec.rb
-- spec/logtail/log_devices/http_spec.rb
-- spec/logtail/log_entry_spec.rb
-- spec/logtail/logger_spec.rb
-- spec/spec_helper.rb
-- spec/support/logtail.rb
-- spec/support/socket_hostname.rb
-- spec/support/timecop.rb
-- spec/support/webmock.rb
+test_files: []