appsignal 3.4.11 → 3.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ac4bb4c6c83da9041228fe7094f6543073d00fac2b317ade49695d795b770b
-  data.tar.gz: 1870d2a660dd057868f81d931a27bd047c781bb386ddc938cb3f5e48a41d989c
+  metadata.gz: 23564a15fbad1ecb68987675c925a81b0e423ffa66a3481563999f97db10ef79
+  data.tar.gz: a42321ba0bc9809e2b4b26a3c7e3707e5c06941a30ed6187cba491cbc76b9cfd
 SHA512:
-  metadata.gz: 5400da137bc9e4644301afc2c9d0de690edf0f6759cfceaf5b72a072b5f78e2f95d15df2d6ccb897f379b92d9bd7be0770a8d38538687ee8d4f3de9cfd7b6012
-  data.tar.gz: 13e146b750712f1e3e1cb08bf6765ecf88762f278a3e0d21067aaae390d2deadaf0dbc76a08c0812a1996d83fa18d99977e1fc96f50d0335aa6890a1a3bcf52b
+  metadata.gz: ff4db633c340cf16fc0cfb3b154f4b754ef3416d3e56077203b7a298851457624dba934576c634b56bad599199fe427d1200dfa019f3bcfab67a9aa7349a0591
+  data.tar.gz: 811176ae1f6735a901e1b0b822b4956aa5a0ca86efd2fbc8cc969afde01510022d3d2adf4fe11de50609f324df4dab0c699dbf84ca120ab27556d18735e7748b

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.4.12
+
+### Added
+
+- [441de353](https://github.com/appsignal/appsignal-ruby/commit/441de3537e7a8f36dd2460149c171aaa80929e53) patch - Add an option to not start AppSignal on config file errors. When the `config/appsignal.yml` file raises an error (due to ERB syntax issues or ERB errors), it will currently ignore the config file and try to make a configuration work from the other config sources (default, auto detection and system environment variables). This can cause unexpected behavior, because the config from the config file is not part of the loaded config.
+  
+  In future versions of the Ruby gem, AppSignal will not start when the config file contains an error. To opt-in to this new behavior, set the `APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR` system environment variable to either `1` or `true`.
+
+### Changed
+
+- [a42da92b](https://github.com/appsignal/appsignal-ruby/commit/a42da92b1ff16c48eb40dc081d3b4fbd6480c7c0) patch - Log an error when sample data is of an invalid type. Accepted types are Array and Hash. If any other types are given, it will log an error to the `appsignal.log` file.
+- [8e636323](https://github.com/appsignal/appsignal-ruby/commit/8e6363232dc7fabe5f1aeae5758802e4c8d6cbfa) patch - Bump agent to 6133900.
+  
+  - Fix `disk_inodes_usage` metric name format to not be interpreted as a JSON object.
+
 ## 3.4.11
 
 ### Added

data/ext/agent.rb

@@ -6,7 +6,7 @@
 # Modifications to this file will be overwritten with the next agent release.
 
 APPSIGNAL_AGENT_CONFIG = {
-  "version" => "d789895",
+  "version" => "6133900",
   "mirrors" => [
     "https://appsignal-agent-releases.global.ssl.fastly.net",
     "https://d135dj0rjqvssy.cloudfront.net"
@@ -14,131 +14,131 @@ APPSIGNAL_AGENT_CONFIG = {
   "triples" => {
     "x86_64-darwin" => {
       "static" => {
-        "checksum" => "8ea76b7d011c728b7988d017a39fc3a432d9c86392e6e46767ecc931e583777a",
+        "checksum" => "19cfea536fc6c4a8fe335a26d14ce955b422c23217902642f95d7df670152238",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "beacdcd579bcc06a69da279dbca2f363395ea4b1846fa4b6e49de612beb07a8a",
+        "checksum" => "f5c4b66b45faac47473befdbe286a037d8fca9386339b00f59be9e9505d15b13",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "universal-darwin" => {
       "static" => {
-        "checksum" => "8ea76b7d011c728b7988d017a39fc3a432d9c86392e6e46767ecc931e583777a",
+        "checksum" => "19cfea536fc6c4a8fe335a26d14ce955b422c23217902642f95d7df670152238",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "beacdcd579bcc06a69da279dbca2f363395ea4b1846fa4b6e49de612beb07a8a",
+        "checksum" => "f5c4b66b45faac47473befdbe286a037d8fca9386339b00f59be9e9505d15b13",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-darwin" => {
       "static" => {
-        "checksum" => "535fed60ac1484e40bbfe77cd4fe9131c67f25e6362a2fe31d987c36ec82ba08",
+        "checksum" => "4fa0dbccba79f70edc6844a86bfd047ccdd612d752b65aff46fe0e21d8a610ea",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "6c984f53a07788ebb469ede014ac8732d9db1ef43736825690492e7c12e3fb83",
+        "checksum" => "f86e88647be6c64f0f1f56b1ac15e0e4453c7e4a6c997fd5e510cf459c572a57",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm64-darwin" => {
       "static" => {
-        "checksum" => "535fed60ac1484e40bbfe77cd4fe9131c67f25e6362a2fe31d987c36ec82ba08",
+        "checksum" => "4fa0dbccba79f70edc6844a86bfd047ccdd612d752b65aff46fe0e21d8a610ea",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "6c984f53a07788ebb469ede014ac8732d9db1ef43736825690492e7c12e3fb83",
+        "checksum" => "f86e88647be6c64f0f1f56b1ac15e0e4453c7e4a6c997fd5e510cf459c572a57",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm-darwin" => {
       "static" => {
-        "checksum" => "535fed60ac1484e40bbfe77cd4fe9131c67f25e6362a2fe31d987c36ec82ba08",
+        "checksum" => "4fa0dbccba79f70edc6844a86bfd047ccdd612d752b65aff46fe0e21d8a610ea",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "6c984f53a07788ebb469ede014ac8732d9db1ef43736825690492e7c12e3fb83",
+        "checksum" => "f86e88647be6c64f0f1f56b1ac15e0e4453c7e4a6c997fd5e510cf459c572a57",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux" => {
       "static" => {
-        "checksum" => "35f96e0adf408fd8ac3e89c6cb3c5506eb4250643199aad3ba298ab131d773c8",
+        "checksum" => "cdd75637940fcfd369b569e873048c7d37a3844d9d31d783e4459b375b78ee0e",
         "filename" => "appsignal-aarch64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "6f4e5431c50c947f9fdeb92b7536780277bebb75327cfa5ee9c27659a9d20b5e",
+        "checksum" => "99b52c29d497d63f02a4ff7162152641b51e7ecd292d07f0330e7d4f3abc8075",
         "filename" => "appsignal-aarch64-linux-all-dynamic.tar.gz"
       }
     },
     "i686-linux" => {
       "static" => {
-        "checksum" => "f4a1c9a67a0a4cde7e13ef555a6782e5d4f15bfbce9277c2aaf8e248a0fb858e",
+        "checksum" => "a9374d1fd4baae84f1c4a74957cbb8c919b29ae2ab05a571ff75b9ca483717ab",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "26a3fa059874d76897e6a4c709048789f531d7e84e6b8ae4e7fbcdfb26cdef40",
+        "checksum" => "d643c72add6fe1054faff034101cf5a2676a169c7bff479f3d79e71875598b8a",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86-linux" => {
       "static" => {
-        "checksum" => "f4a1c9a67a0a4cde7e13ef555a6782e5d4f15bfbce9277c2aaf8e248a0fb858e",
+        "checksum" => "a9374d1fd4baae84f1c4a74957cbb8c919b29ae2ab05a571ff75b9ca483717ab",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "26a3fa059874d76897e6a4c709048789f531d7e84e6b8ae4e7fbcdfb26cdef40",
+        "checksum" => "d643c72add6fe1054faff034101cf5a2676a169c7bff479f3d79e71875598b8a",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux" => {
       "static" => {
-        "checksum" => "016c962727e31a07eee7a221944ff9c4bbb054eada7e87bbe4602233364f380c",
+        "checksum" => "bd625ed84100d0632b298ac602b152463628c41afe56a8621745cdae626f8413",
         "filename" => "appsignal-x86_64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "d286a8bcc4a876057a14a90cc6ceecdc75230e1c4d721ea3f3138c58c748e602",
+        "checksum" => "0daa644acfee46848282ad733b175e4994e7faf64c8bc046d2efff2b8fc1afdd",
         "filename" => "appsignal-x86_64-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux-musl" => {
       "static" => {
-        "checksum" => "2ce9e34b283c76c6b25028d3a770a942f4975cd071c586438a8765948237ca42",
+        "checksum" => "7988c4a2a6ba5d59be2186ce9bf51ab50b6537a60888b08c8e9066172516e59d",
         "filename" => "appsignal-x86_64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "0eebe8cd448bce5386cdce1039e7f74c60208408108af9537a80e8e8737f7aec",
+        "checksum" => "93e47c9400ddae42a8cd2b80c09c9134ee96a76bf622c3ad5d53b776fec1a3f0",
         "filename" => "appsignal-x86_64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux-musl" => {
       "static" => {
-        "checksum" => "017da79e62a2875c0384898c9160cd83acd712faba05154fd8a0627fec1b5ba4",
+        "checksum" => "8e5fe2a8bc4cb7de4ba7d61fec48f15aa0cd580050f67752f07625853636eb16",
         "filename" => "appsignal-aarch64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "507d4fa0f3d6168f905404b4b36fe494c5479606d77f50d2d2d3d27b6c645ea1",
+        "checksum" => "01f993b3320f0377ef9f652bb215ce268da208f46a6f59ad0c0e71f57257b4ef",
         "filename" => "appsignal-aarch64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "x86_64-freebsd" => {
       "static" => {
-        "checksum" => "13d27afcb68aff5e164e05fc4fd8874e73f14c0154301f2e6e6e75f67fa9182c",
+        "checksum" => "09e21821eb98ad6afdb5d3708b67ea25799aedbee2ccb0d566b99d9c5703cb1e",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "dafa25a73cd79e269466d5129dd7b61ac88e09d87c3f253fc9705e1d9469fa2b",
+        "checksum" => "e77592de9dd7ff41efb6c1d2d88e06fa7b663e9ff009392bb971b1333e0f28d7",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     },
     "amd64-freebsd" => {
       "static" => {
-        "checksum" => "13d27afcb68aff5e164e05fc4fd8874e73f14c0154301f2e6e6e75f67fa9182c",
+        "checksum" => "09e21821eb98ad6afdb5d3708b67ea25799aedbee2ccb0d566b99d9c5703cb1e",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "dafa25a73cd79e269466d5129dd7b61ac88e09d87c3f253fc9705e1d9469fa2b",
+        "checksum" => "e77592de9dd7ff41efb6c1d2d88e06fa7b663e9ff009392bb971b1333e0f28d7",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     }

data/lib/appsignal/config.rb

@@ -232,6 +232,7 @@ module Appsignal
     #   How to integrate AppSignal manually
     def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger,
       config_file = nil)
+      @config_file_error = false
       @root_path = root_path
       @config_file = config_file
       @logger = logger
@@ -417,8 +418,20 @@ module Appsignal
         nil
       end
     rescue => e
-      message = "An error occured while loading the AppSignal config file." \
-        " Skipping file config.\n" \
+      # TODO: Remove in the next major version
+      @config_file_error = true
+      extra_message =
+        if inactive_on_config_file_error?
+          "Not starting AppSignal because " \
+            "APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR is set."
+        else
+          "Skipping file config. In future versions AppSignal will not start " \
+            "on a config file error. To opt-in to this new behavior set " \
+            "'APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR=1' in your system " \
+            "environment."
+        end
+      message = "An error occured while loading the AppSignal config file. " \
+        "#{extra_message}\n" \
         "File: #{config_file.inspect}\n" \
         "#{e.class.name}: #{e}"
       Kernel.warn "appsignal: #{message}"
@@ -485,6 +498,12 @@ module Appsignal
     # stick around as a structure for future deprecations.
     def determine_overrides
       config = {}
+      # If an error was detected during config file reading/parsing and the new
+      # behavior is enabled to not start AppSignal on incomplete config, do not
+      # start AppSignal.
+      # TODO: Make default behavior in next major version. Remove
+      # `inactive_on_config_file_error?` call.
+      config[:active] = false if @config_file_error && inactive_on_config_file_error?
       skip_session_data = config_hash[:skip_session_data]
       send_session_data = config_hash[:send_session_data]
       if skip_session_data.nil? # Deprecated option is not set
@@ -508,5 +527,11 @@ module Appsignal
         config_hash[key] = value
       end
     end
+
+    # Does it use the new behavior?
+    def inactive_on_config_file_error?
+      value = ENV.fetch("APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR", false)
+      ["1", "true"].include?(value)
+    end
   end
 end

data/lib/appsignal/transaction.rb

@@ -320,7 +320,14 @@ module Appsignal
     end
 
     def set_sample_data(key, data)
-      return unless key && data && (data.is_a?(Array) || data.is_a?(Hash))
+      return unless key && data
+
+      if !data.is_a?(Array) && !data.is_a?(Hash)
+        Appsignal.logger.error(
+          "Invalid sample data for '#{key}'. Value is not an Array or Hash: '#{data.inspect}'"
+        )
+        return
+      end
 
       @ext.set_sample_data(
         key.to_s,

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.4.11"
+  VERSION = "3.4.12"
 end

data/spec/lib/appsignal/config_spec.rb

@@ -294,19 +294,48 @@ describe Appsignal::Config do
       end
       let(:config) { Appsignal::Config.new(config_path, "foo") }
 
-      it "logs & prints an error, skipping the file source" do
-        stdout = std_stream
-        stderr = std_stream
-        log = capture_logs { capture_std_streams(stdout, stderr) { config } }
-        message = "An error occured while loading the AppSignal config file. " \
-          "Skipping file config.\n" \
-          "File: #{File.join(config_path, "config", "appsignal.yml").inspect}\n" \
-          "KeyError: key not found"
-        expect(log).to contains_log :error, message
-        expect(log).to include("/appsignal/config.rb:") # Backtrace
-        expect(stdout.read).to_not include("appsignal:")
-        expect(stderr.read).to include "appsignal: #{message}"
-        expect(config.file_config).to eql({})
+      context "when APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR is not set" do
+        it "logs & prints an error, skipping the file source" do
+          stdout = std_stream
+          stderr = std_stream
+          log = capture_logs { capture_std_streams(stdout, stderr) { config } }
+          message = "An error occured while loading the AppSignal config file. " \
+            "Skipping file config. " \
+            "In future versions AppSignal will not start on a config file " \
+            "error. To opt-in to this new behavior set " \
+            "'APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR=1' in your system " \
+            "environment.\n" \
+            "File: #{File.join(config_path, "config", "appsignal.yml").inspect}\n" \
+            "KeyError: key not found"
+          expect(log).to contains_log :error, message
+          expect(log).to include("/appsignal/config.rb:") # Backtrace
+          expect(stdout.read).to_not include("appsignal:")
+          expect(stderr.read).to include "appsignal: #{message}"
+          expect(config.file_config).to eql({})
+        end
+      end
+
+      context "when APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR=1 is set" do
+        it "does not start AppSignal, logs & prints an error" do
+          stdout = std_stream
+          stderr = std_stream
+          ENV["APPSIGNAL_ACTIVE"] = "true"
+          ENV["APPSIGNAL_APP_NAME"] = "My app"
+          ENV["APPSIGNAL_APP_ENV"] = "dev"
+          ENV["APPSIGNAL_PUSH_API_KEY"] = "something valid"
+          ENV["APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR"] = "1"
+          log = capture_logs { capture_std_streams(stdout, stderr) { config } }
+          message = "An error occured while loading the AppSignal config file. " \
+            "Not starting AppSignal because APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR is set.\n" \
+            "File: #{File.join(config_path, "config", "appsignal.yml").inspect}\n" \
+            "KeyError: key not found"
+          expect(log).to contains_log :error, message
+          expect(log).to include("/appsignal/config.rb:") # Backtrace
+          expect(stdout.read).to_not include("appsignal:")
+          expect(stderr.read).to include "appsignal: #{message}"
+          expect(config.file_config).to eql({})
+          expect(config.active?).to be(false)
+        end
       end
     end
 

data/spec/lib/appsignal/transaction_spec.rb

@@ -688,6 +688,8 @@ describe Appsignal::Transaction do
           transaction.set_sample_data("params", "string")
 
           expect(transaction.to_h["sample_data"]).to eq({})
+          expect(log_contents(log)).to contains_log :error,
+            %(Invalid sample data for 'params'. Value is not an Array or Hash: '"string"')
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.4.11
+  version: 3.4.12
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-25 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack