Merge pull request #1419 from appsignal/nginx-port

Add `nginx_port` configuration option

Author: unflxw

.changesets/add--nginx_port--configuration-option.md

@@ -1,7 +1,6 @@
 ---
 bump: patch
 type: add
-integrations: all
 ---
 
 Add `nginx_port` configuration option. This configuration option can be used to customize the port on which the AppSignal integration exposes [the NGINX metrics server](https://docs.appsignal.com/metrics/nginx.html).

lib/appsignal/config.rb

@@ -166,6 +166,7 @@ def dsl_config_file?
       :push_api_key => "APPSIGNAL_PUSH_API_KEY",
       :sidekiq_report_errors => "APPSIGNAL_SIDEKIQ_REPORT_ERRORS",
       :statsd_port => "APPSIGNAL_STATSD_PORT",
+      :nginx_port => "APPSIGNAL_NGINX_PORT",
       :working_directory_path => "APPSIGNAL_WORKING_DIRECTORY_PATH",
       :revision => "APP_REVISION"
     }.freeze
@@ -436,6 +437,7 @@ def write_to_environment # rubocop:disable Metrics/AbcSize
       ENV["_APPSIGNAL_RUNNING_IN_CONTAINER"]         = config_hash[:running_in_container].to_s
       ENV["_APPSIGNAL_SEND_ENVIRONMENT_METADATA"]    = config_hash[:send_environment_metadata].to_s
       ENV["_APPSIGNAL_STATSD_PORT"]                  = config_hash[:statsd_port].to_s
+      ENV["_APPSIGNAL_NGINX_PORT"]                   = config_hash[:nginx_port].to_s
       if config_hash[:working_directory_path]
         ENV["_APPSIGNAL_WORKING_DIRECTORY_PATH"] = config_hash[:working_directory_path]
       end

spec/lib/appsignal/config_spec.rb

@@ -616,7 +616,8 @@ def on_load
         :send_session_data => false,
         :sidekiq_report_errors => "all",
         :statsd_port => "7890",
-        :working_directory_path => working_directory_path
+        :working_directory_path => working_directory_path,
+        :nginx_port => "4321"
       }
     end
     let(:env_vars) do
@@ -638,6 +639,7 @@ def on_load
         "APPSIGNAL_PUSH_API_KEY" => "aaa-bbb-ccc",
         "APPSIGNAL_SIDEKIQ_REPORT_ERRORS" => "all",
         "APPSIGNAL_STATSD_PORT" => "7890",
+        "APPSIGNAL_NGINX_PORT" => "4321",
         "APPSIGNAL_WORKING_DIRECTORY_PATH" => working_directory_path,
         "APP_REVISION" => "v2.5.1",
 
@@ -1002,6 +1004,7 @@ def on_load
       expect(ENV.fetch("_APPSIGNAL_FILES_WORLD_ACCESSIBLE", nil)).to eq "true"
       expect(ENV.fetch("_APPSIGNAL_SEND_ENVIRONMENT_METADATA", nil)).to eq "false"
       expect(ENV.fetch("_APPSIGNAL_STATSD_PORT", nil)).to eq ""
+      expect(ENV.fetch("_APPSIGNAL_NGINX_PORT", nil)).to eq ""
       expect(ENV.fetch("_APPSIGNAL_FILTER_PARAMETERS", nil)).to eq "password,confirm_password"
       expect(ENV.fetch("_APPSIGNAL_FILTER_SESSION_DATA", nil)).to eq "key1,key2"
       expect(ENV.fetch("_APP_REVISION", nil)).to eq "v2.5.1"
@@ -1043,6 +1046,15 @@ def on_load
         expect(ENV.fetch("_APPSIGNAL_STATSD_PORT", nil)).to eq "1000"
       end
     end
+
+    context "with :nginx_port" do
+      let(:options) { { :nginx_port => "4321" } }
+      before { config.write_to_environment }
+
+      it "sets the nginx_port env var" do
+        expect(ENV.fetch("_APPSIGNAL_NGINX_PORT", nil)).to eq "4321"
+      end
+    end
   end
 
   describe "#log_file_path" do