appsignal 1.2.5 → 1.3.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 521e9247fc6acfdd862d5ee49fa231906883882b
-  data.tar.gz: bae55d3f3670ff7119b81bdb9ade0b599669f73d
+  metadata.gz: 4023d8cb736130f72754788bec91b9b9fea252b6
+  data.tar.gz: d1fd533404476c04494e467db4b4d609c42fc743
 SHA512:
-  metadata.gz: d68f09956247bbe23c0a0b0ffcb4a6cd531973752f998977aea39073ab9fc30e386595fb9933e21043e618476ffb3e22183f3fee974be3e906e6ba3dc293daf7
-  data.tar.gz: fa176448701886352cfacd5e2b4f9a8dcf39669a74372c5876306332a751e14f48cc1e7baf87a2f5464ef584661d0fbdc70a405bd425169ab6d12a35f60e7b40
+  metadata.gz: 93c63a9ba4b9c27dcb3df5338406b27fec2bf037c078071473dca6821accf280bfc827591e805ab5cbc0acac457238587374349b1717c5b81465159b15d04f8e
+  data.tar.gz: 3fc6023b24f6734cb73aa336beba37e6c22592506a186f96c8a7b32f5be16b2e39e77babfbf8fc3e79d2e2b86608f5d11ca0dc149fbeb71a48c7b157161ebada

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 1.3.0
+* Host metrics is now enabled by default
+* Beta of minutely probes including GC metrics
+* Refactor of param sanitization
+* Param filtering for non-Rails frameworks
+* Support for modular Sinatra applications
+* Add Sinatra middleware to `Sinatra::Base` by default
+* Allow a new transaction to be forced by sinatra instrumentation
+* Allow hostname to be set with environment variable
+* Helpers for easy method instrumentation
+* `Appsignal.instrument` helper to easily instrument blocks of code
+* `record_event` method to instrument events without a start hook
+* `send_params` is now configurable via the environment
+
 # 1.2.5
 * Bugfix in CPU utilization calculation for host metrics
 

data/circle.yml

@@ -1,3 +1,7 @@
+machine:
+  ruby:
+    version: 2.3.0
+
 dependencies:
   override:
     - bundle

data/ext/agent.yml

@@ -1,18 +1,18 @@
 ---
-version: d9d702b
+version: ec934f7
 triples:
   x86_64-linux:
-    checksum: b5b8fb84a3f7702b1a67cb0f2712997413d58aaa9a1da8d72e356360e1cabcd5
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d9d702b/appsignal-x86_64-linux-all-static.tar.gz
+    checksum: 1a247a98823bcf4648363d86d600f2c5f2a4ee147551c6fcee641cef1b109a21
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ec934f7/appsignal-x86_64-linux-all-static.tar.gz
   i686-linux:
-    checksum: 432c8539e817febe7999d89291bd57fbc6d8dd9450b7003a8f6305083533b49e
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d9d702b/appsignal-i686-linux-all-static.tar.gz
+    checksum: cac5e0b0b39d7f546caf8a2f03cf0c063cfa5aa4123c8e85e59bfe667cb8e0ee
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ec934f7/appsignal-i686-linux-all-static.tar.gz
   x86-linux:
-    checksum: 432c8539e817febe7999d89291bd57fbc6d8dd9450b7003a8f6305083533b49e
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d9d702b/appsignal-i686-linux-all-static.tar.gz
+    checksum: cac5e0b0b39d7f546caf8a2f03cf0c063cfa5aa4123c8e85e59bfe667cb8e0ee
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ec934f7/appsignal-i686-linux-all-static.tar.gz
   x86_64-darwin:
-    checksum: d23f701015bc0f35f8919b15abb74cedf267a88a7ecb6e712ce83eb08c960582
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d9d702b/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 0c0a61129c40362eee779889cf51e84b97e44366ee3d60a81113655673d6d541
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ec934f7/appsignal-x86_64-darwin-all-static.tar.gz
   universal-darwin:
-    checksum: d23f701015bc0f35f8919b15abb74cedf267a88a7ecb6e712ce83eb08c960582
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d9d702b/appsignal-x86_64-darwin-all-static.tar.gz
+    checksum: 0c0a61129c40362eee779889cf51e84b97e44366ee3d60a81113655673d6d541
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ec934f7/appsignal-x86_64-darwin-all-static.tar.gz

data/ext/appsignal_extension.c

@@ -1,6 +1,20 @@
 #include "ruby/ruby.h"
+#include "ruby/encoding.h"
 #include "appsignal_extension.h"
 
+static inline appsignal_string_t make_appsignal_string(VALUE str) {
+  return (appsignal_string_t) {
+    .len = RSTRING_LEN(str),
+    .buf = RSTRING_PTR(str)
+  };
+}
+
+static inline VALUE make_ruby_string(appsignal_string_t string) {
+  VALUE str = rb_str_new(string.buf, string.len);
+  rb_enc_associate(str, rb_utf8_encoding());
+  return str;
+}
+
 VALUE Appsignal;
 VALUE Extension;
 VALUE ExtTransaction;
@@ -18,26 +32,27 @@ static VALUE stop(VALUE self) {
 }
 
 static VALUE get_server_state(VALUE self, VALUE key) {
-  char * ptr = appsignal_get_server_state(StringValueCStr(key));
+  appsignal_string_t string;
 
   Check_Type(key, T_STRING);
 
-  if (ptr) {
-    return rb_str_new2(ptr);
+  string = appsignal_get_server_state(make_appsignal_string(key));
+  if (string.len > 0) {
+    return make_ruby_string(string);
   } else {
     return Qnil;
   }
 }
 
 static VALUE start_transaction(VALUE self, VALUE transaction_id, VALUE namespace) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
   Check_Type(transaction_id, T_STRING);
   Check_Type(namespace, T_STRING);
 
   transaction = appsignal_start_transaction(
-      StringValueCStr(transaction_id),
-      StringValueCStr(namespace)
+      make_appsignal_string(transaction_id),
+      make_appsignal_string(namespace)
   );
 
   if (transaction) {
@@ -48,9 +63,9 @@ static VALUE start_transaction(VALUE self, VALUE transaction_id, VALUE namespace
 }
 
 static VALUE start_event(VALUE self) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_start_event(transaction);
 
@@ -58,71 +73,96 @@ static VALUE start_event(VALUE self) {
 }
 
 static VALUE finish_event(VALUE self, VALUE name, VALUE title, VALUE body, VALUE body_format) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
   Check_Type(name, T_STRING);
   Check_Type(title, T_STRING);
   Check_Type(body, T_STRING);
   Check_Type(body_format, T_FIXNUM);
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_finish_event(
       transaction,
-      StringValueCStr(name),
-      StringValueCStr(title),
-      StringValueCStr(body),
+      make_appsignal_string(name),
+      make_appsignal_string(title),
+      make_appsignal_string(body),
       FIX2INT(body_format)
   );
   return Qnil;
 }
 
+static VALUE record_event(VALUE self, VALUE name, VALUE title, VALUE body, VALUE duration, VALUE body_format) {
+  appsignal_transaction_t* transaction;
+  int duration_type;
+
+  Check_Type(name, T_STRING);
+  Check_Type(title, T_STRING);
+  Check_Type(body, T_STRING);
+  duration_type = TYPE(duration);
+  if (duration_type != T_FIXNUM && duration_type != T_BIGNUM) {
+      rb_raise(rb_eTypeError, "duration should be a Fixnum or Bignum");
+  }
+  Check_Type(body_format, T_FIXNUM);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
+
+  appsignal_record_event(
+      transaction,
+      make_appsignal_string(name),
+      make_appsignal_string(title),
+      make_appsignal_string(body),
+      FIX2INT(body_format),
+      NUM2LONG(duration)
+  );
+  return Qnil;
+}
+
 static VALUE set_transaction_error(VALUE self, VALUE name, VALUE message, VALUE backtrace) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
   Check_Type(name, T_STRING);
   Check_Type(message, T_STRING);
   Check_Type(backtrace, T_STRING);
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_set_transaction_error(
       transaction,
-      StringValueCStr(name),
-      StringValueCStr(message),
-      StringValueCStr(backtrace)
+      make_appsignal_string(name),
+      make_appsignal_string(message),
+      make_appsignal_string(backtrace)
   );
   return Qnil;
 }
 
 static VALUE set_transaction_sample_data(VALUE self, VALUE key, VALUE payload) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
   Check_Type(key, T_STRING);
   Check_Type(payload, T_STRING);
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_set_transaction_sample_data(
       transaction,
-      StringValueCStr(key),
-      StringValueCStr(payload)
+      make_appsignal_string(key),
+      make_appsignal_string(payload)
   );
   return Qnil;
 }
 
 static VALUE set_transaction_action(VALUE self, VALUE action) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
   Check_Type(action, T_STRING);
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_set_transaction_action(
       transaction,
-      StringValueCStr(action)
+      make_appsignal_string(action)
   );
   return Qnil;
 }
 
 static VALUE set_transaction_queue_start(VALUE self, VALUE queue_start) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
   int queue_start_type;
 
   queue_start_type = TYPE(queue_start);
@@ -130,7 +170,7 @@ static VALUE set_transaction_queue_start(VALUE self, VALUE queue_start) {
       rb_raise(rb_eTypeError, "queue_start should be a Fixnum or Bignum");
   }
 
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_set_transaction_queue_start(
       transaction,
@@ -140,34 +180,34 @@ static VALUE set_transaction_queue_start(VALUE self, VALUE queue_start) {
 }
 
 static VALUE set_transaction_metadata(VALUE self, VALUE key, VALUE value) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
   Check_Type(key, T_STRING);
   Check_Type(value, T_STRING);
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_set_transaction_metadata(
       transaction,
-      StringValueCStr(key),
-      StringValueCStr(value)
+      make_appsignal_string(key),
+      make_appsignal_string(value)
   );
   return Qnil;
 }
 
 static VALUE finish_transaction(VALUE self) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
   int sample;
 
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   sample = appsignal_finish_transaction(transaction);
   return sample == 1 ? Qtrue : Qfalse;
 }
 
 static VALUE complete_transaction(VALUE self) {
-  appsignal_transaction* transaction;
+  appsignal_transaction_t* transaction;
 
-  Data_Get_Struct(self, appsignal_transaction, transaction);
+  Data_Get_Struct(self, appsignal_transaction_t, transaction);
 
   appsignal_complete_transaction(transaction);
   return Qnil;
@@ -178,7 +218,29 @@ static VALUE set_gauge(VALUE self, VALUE key, VALUE value) {
   Check_Type(value, T_FLOAT);
 
   appsignal_set_gauge(
-      StringValueCStr(key),
+      make_appsignal_string(key),
+      NUM2DBL(value)
+  );
+  return Qnil;
+}
+
+static VALUE set_host_gauge(VALUE self, VALUE key, VALUE value) {
+  Check_Type(key, T_STRING);
+  Check_Type(value, T_FLOAT);
+
+  appsignal_set_host_gauge(
+      make_appsignal_string(key),
+      NUM2DBL(value)
+  );
+  return Qnil;
+}
+
+static VALUE set_process_gauge(VALUE self, VALUE key, VALUE value) {
+  Check_Type(key, T_STRING);
+  Check_Type(value, T_FLOAT);
+
+  appsignal_set_process_gauge(
+      make_appsignal_string(key),
       NUM2DBL(value)
   );
   return Qnil;
@@ -189,7 +251,7 @@ static VALUE increment_counter(VALUE self, VALUE key, VALUE count) {
   Check_Type(count, T_FIXNUM);
 
   appsignal_increment_counter(
-      StringValueCStr(key),
+      make_appsignal_string(key),
       FIX2INT(count)
   );
   return Qnil;
@@ -200,7 +262,7 @@ static VALUE add_distribution_value(VALUE self, VALUE key, VALUE value) {
   Check_Type(value, T_FLOAT);
 
   appsignal_add_distribution_value(
-      StringValueCStr(key),
+      make_appsignal_string(key),
       NUM2DBL(value)
   );
   return Qnil;
@@ -240,10 +302,10 @@ static VALUE install_gc_event_hooks() {
       Qnil
   );
   #endif
-  #if defined(RUBY_INTERNAL_EVENT_GC_END_SWEEP)
+  #if defined(RUBY_INTERNAL_EVENT_GC_END_MARK)
   rb_add_event_hook(
       track_gc_end,
-      RUBY_INTERNAL_EVENT_GC_END_MARK | RUBY_INTERNAL_EVENT_GC_END_SWEEP,
+      RUBY_INTERNAL_EVENT_GC_END_MARK,
       Qnil
   );
   #endif
@@ -269,6 +331,7 @@ void Init_appsignal_extension(void) {
   // Transaction instance methods
   rb_define_method(ExtTransaction, "start_event",     start_event,                 0);
   rb_define_method(ExtTransaction, "finish_event",    finish_event,                4);
+  rb_define_method(ExtTransaction, "record_event",    record_event,                5);
   rb_define_method(ExtTransaction, "set_error",       set_transaction_error,       3);
   rb_define_method(ExtTransaction, "set_sample_data", set_transaction_sample_data, 2);
   rb_define_method(ExtTransaction, "set_action",      set_transaction_action,      1);
@@ -283,6 +346,8 @@ void Init_appsignal_extension(void) {
 
   // Metrics
   rb_define_singleton_method(Extension, "set_gauge",              set_gauge,              2);
+  rb_define_singleton_method(Extension, "set_host_gauge",         set_host_gauge,         2);
+  rb_define_singleton_method(Extension, "set_process_gauge",      set_process_gauge,      2);
   rb_define_singleton_method(Extension, "increment_counter",      increment_counter,      2);
   rb_define_singleton_method(Extension, "add_distribution_value", add_distribution_value, 2);
 }

data/lib/appsignal.rb

@@ -58,7 +58,11 @@ module Appsignal
           Appsignal::EventFormatter.initialize_formatters
           initialize_extensions
           Appsignal::Extension.install_allocation_event_hook if config[:enable_allocation_tracking]
-          Appsignal::Extension.install_gc_event_hooks if config[:enable_gc_instrumentation]
+          if config[:enable_gc_instrumentation]
+            Appsignal::Extension.install_gc_event_hooks
+            Appsignal::Minutely.add_gc_probe
+          end
+          Appsignal::Minutely.start if config[:enable_minutely_probes]
           @subscriber = Appsignal::Subscriber.new
         else
           logger.info("Not starting, not active for #{config.env}")
@@ -177,32 +181,39 @@ module Appsignal
     end
     alias :tag_job :tag_request
 
+    def instrument(name, title=nil, body=nil, body_format=Appsignal::EventFormatter::DEFAULT)
+      Appsignal::Transaction.current.start_event
+      r = yield
+      Appsignal::Transaction.current.finish_event(name, title, body, body_format)
+      r
+    end
+
     def set_gauge(key, value)
-      Appsignal::Extension.set_gauge(key, value.to_f)
+      Appsignal::Extension.set_gauge(key.to_s, value.to_f)
     rescue RangeError
       Appsignal.logger.warn("Gauge value #{value} for key '#{key}' is too big")
     end
 
     def set_host_gauge(key, value)
-      Appsignal::Extension.set_host_gauge(key, value.to_f)
+      Appsignal::Extension.set_host_gauge(key.to_s, value.to_f)
     rescue RangeError
       Appsignal.logger.warn("Host gauge value #{value} for key '#{key}' is too big")
     end
 
     def set_process_gauge(key, value)
-      Appsignal::Extension.set_process_gauge(key, value.to_f)
+      Appsignal::Extension.set_process_gauge(key.to_s, value.to_f)
     rescue RangeError
       Appsignal.logger.warn("Process gauge value #{value} for key '#{key}' is too big")
     end
 
     def increment_counter(key, value=1)
-      Appsignal::Extension.increment_counter(key, value)
+      Appsignal::Extension.increment_counter(key.to_s, value)
     rescue RangeError
       Appsignal.logger.warn("Counter value #{value} for key '#{key}' is too big")
     end
 
     def add_distribution_value(key, value)
-      Appsignal::Extension.add_distribution_value(key, value.to_f)
+      Appsignal::Extension.add_distribution_value(key.to_s, value.to_f)
     rescue RangeError
       Appsignal.logger.warn("Distribution value #{value} for key '#{key}' is too big")
     end
@@ -280,6 +291,7 @@ require 'appsignal/config'
 require 'appsignal/event_formatter'
 require 'appsignal/hooks'
 require 'appsignal/marker'
+require 'appsignal/minutely'
 require 'appsignal/params_sanitizer'
 require 'appsignal/integrations/railtie' if defined?(::Rails)
 require 'appsignal/integrations/resque'

data/lib/appsignal/cli/install.rb

@@ -85,7 +85,7 @@ module Appsignal
           puts 'Installing for Sinatra'
           config[:name] = required_input('  Enter application name: ')
           puts
-          configure(config, ['production', 'staging'], true)
+          configure(config, ['development', 'production', 'staging'], true)
 
           puts "Finish Sinatra configuration"
           puts "  Sinatra requires some manual configuration."
@@ -107,7 +107,7 @@ module Appsignal
           config[:name] = required_input('  Enter application name: ')
           puts
 
-          configure(config, ['production', 'staging'], true)
+          configure(config, ['development', 'production', 'staging'], true)
 
           puts "Finish Padrino installation"
           puts "  Padrino requires some manual configuration."
@@ -127,7 +127,7 @@ module Appsignal
           config[:name] = required_input('  Enter application name: ')
           puts
 
-          configure(config, ['production', 'staging'], true)
+          configure(config, ['development', 'production', 'staging'], true)
 
           puts "Manual Grape configuration needed"
           puts "  See the installation instructions here:"