remove syslog logging from cloud controller sinks

Benjamintf1 · Benjamintf1 · commit 7a36d74769d0 · 2026-04-13T09:28:31.000-06:00
diff --git a/.devcontainer/images/nginx/conf/nginx_external_endpoints.conf b/.devcontainer/images/nginx/conf/nginx_external_endpoints.conf
@@ -9,7 +9,6 @@ server {
   # proxy and log all CC traffic
   location / {
     access_log                  /tmp/nginx-access.log main;
-    access_log                  syslog:server=127.0.0.1,severity=info,tag=vcap_nginx_access main;
     proxy_buffering             off;
     proxy_set_header            Host $host;
     proxy_set_header            X-Real_IP $remote_addr;
diff --git a/Gemfile b/Gemfile
@@ -31,7 +31,6 @@ gem 'sequel_pg', require: 'sequel'
 gem 'sinatra', '~> 4.2'
 gem 'sinatra-contrib'
 gem 'statsd-ruby', '~> 1.5.0'
-gem 'syslog'
 gem 'talentbox-delayed_job_sequel', '~> 4.4.0'
 gem 'uri', '~> 1.1'
 gem 'vmstat', '~> 2.3'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -566,8 +566,6 @@ GEM
       spring (>= 0.9.1)
     statsd-ruby (1.5.0)
     stringio (3.2.0)
-    syslog (0.4.0)
-      logger
     talentbox-delayed_job_sequel (4.4.0)
       delayed_job (~> 4.1)
       sequel (>= 5.0, < 6.0)
@@ -681,7 +679,6 @@ DEPENDENCIES
   spring
   spring-commands-rspec
   statsd-ruby (~> 1.5.0)
-  syslog
   talentbox-delayed_job_sequel (~> 4.4.0)
   timecop
   uri (~> 1.1)
diff --git a/config/cloud_controller.yml b/config/cloud_controller.yml
@@ -111,7 +111,6 @@ nginx:
 logging:
   file: /tmp/cloud_controller.log
   level: debug2
-  syslog: vcap.example
   anonymize_ips: false
   format:
     timestamp: 'rfc3339'
diff --git a/lib/cloud_controller/config_schemas/api_schema.rb b/lib/cloud_controller/config_schemas/api_schema.rb
@@ -75,7 +75,6 @@ class ApiSchema < VCAP::Config
           logging: {
             level: String, # debug, info, etc.
             file: String, # Log file to use
-            syslog: String, # Name to associate with syslog messages (should start with 'vcap.')
             optional(:stdout_sink_enabled) => bool,
             optional(:anonymize_ips) => bool,
             optional(:format) => {
diff --git a/lib/cloud_controller/config_schemas/blobstore_benchmarks_schema.rb b/lib/cloud_controller/config_schemas/blobstore_benchmarks_schema.rb
@@ -34,7 +34,6 @@ class BlobstoreBenchmarksSchema < VCAP::Config
           optional(:logging) => {
             optional(:level) => String,
             optional(:file) => String,
-            optional(:syslog) => String,
             optional(:stdout_sink_enabled) => bool
           },
 
diff --git a/lib/cloud_controller/config_schemas/clock_schema.rb b/lib/cloud_controller/config_schemas/clock_schema.rb
@@ -44,8 +44,7 @@ class ClockSchema < VCAP::Config
 
           logging: {
             level: String, # debug, info, etc.
-            file: String, # Log file to use
-            syslog: String # Name to associate with syslog messages (should start with 'vcap.')
+            file: String # Log file to use
           },
 
           pid_filename: String, # Pid filename to use
diff --git a/lib/cloud_controller/config_schemas/deployment_updater_schema.rb b/lib/cloud_controller/config_schemas/deployment_updater_schema.rb
@@ -9,8 +9,7 @@ class DeploymentUpdaterSchema < VCAP::Config
 
           logging: {
             level: String, # debug, info, etc.
-            file: String, # Log file to use
-            syslog: String # Name to associate with syslog messages (should start with 'vcap.')
+            file: String # Log file to use
           },
 
           pid_filename: String, # Pid filename to use
diff --git a/lib/cloud_controller/config_schemas/migrate_schema.rb b/lib/cloud_controller/config_schemas/migrate_schema.rb
@@ -34,7 +34,6 @@ class MigrateSchema < VCAP::Config
           logging: {
             level: String, # debug, info, etc.
             file: String, # Log file to use
-            syslog: String, # Name to associate with syslog messages (should start with 'vcap.')
             optional(:stdout_sink_enabled) => bool
           }
         }
diff --git a/lib/cloud_controller/config_schemas/rotate_database_key_schema.rb b/lib/cloud_controller/config_schemas/rotate_database_key_schema.rb
@@ -8,7 +8,6 @@ class RotateDatabaseKeySchema < VCAP::Config
           logging: {
             level: String, # debug, info, etc.
             file: String, # Log file to use
-            syslog: String, # Name to associate with syslog messages (should start with 'vcap.')
             stdout_sink_enabled: bool
           },
 
diff --git a/lib/cloud_controller/config_schemas/route_syncer_schema.rb b/lib/cloud_controller/config_schemas/route_syncer_schema.rb
@@ -7,8 +7,7 @@ class RouteSyncerSchema < VCAP::Config
         {
           logging: {
             level: String, # debug, info, etc.
-            file: String, # Log file to use
-            syslog: String # Name to associate with syslog messages (should start with 'vcap.')
+            file: String # Log file to use
           },
 
           pid_filename: String, # Pid filename to use
diff --git a/lib/cloud_controller/config_schemas/worker_schema.rb b/lib/cloud_controller/config_schemas/worker_schema.rb
@@ -30,8 +30,7 @@ class WorkerSchema < VCAP::Config
 
           logging: {
             level: String, # debug, info, etc.
-            file: String, # Log file to use
-            syslog: String # Name to associate with syslog messages (should start with 'vcap.')
+            file: String # Log file to use
           },
 
           log_audit_events: bool,
diff --git a/lib/cloud_controller/rack_app_builder.rb b/lib/cloud_controller/rack_app_builder.rb
@@ -1,4 +1,3 @@
-require 'syslog/logger'
 require 'vcap_request_context_setter'
 require 'cors'
 require 'request_metrics'
diff --git a/lib/steno/config.rb b/lib/steno/config.rb
@@ -15,7 +15,6 @@ class << self
     #     logging:
     #       level:  <info, debug, etc>
     #       file:   </path/to/logfile>
-    #       syslog: <syslog name>
     #
     # @param [String] path  Path to yaml config
     # @param [Hash] overrides
@@ -48,11 +47,6 @@ def to_config_hash(hash)
         opts[:sinks] << Steno::Sink::IO.for_file(hash[:file], max_retries:)
       end
 
-      if hash[:syslog]
-        Steno::Sink::Syslog.instance.open(hash[:syslog])
-        opts[:sinks] << Steno::Sink::Syslog.instance
-      end
-
       opts[:sinks] << Steno::Sink::IO.new($stdout) if opts[:sinks].empty?
 
       opts
diff --git a/lib/steno/sink.rb b/lib/steno/sink.rb
@@ -1,4 +1,3 @@
 require 'steno/sink/base'
 require 'steno/sink/io'
-require 'steno/sink/syslog'
 require 'steno/sink/counter'
diff --git a/lib/steno/sink/syslog.rb b/lib/steno/sink/syslog.rb
diff --git a/spec/isolated_specs/steno/spec_helper.rb b/spec/isolated_specs/steno/spec_helper.rb
diff --git a/spec/isolated_specs/steno/unit/config_spec.rb b/spec/isolated_specs/steno/unit/config_spec.rb
@@ -13,12 +13,6 @@
       expect(Steno::Sink::IO).to receive(:for_file).with(@log_path,
                                                          max_retries: 5).
         and_return(@mock_sink_file)
-
-      @mock_sink_syslog = double('sink')
-      expect(@mock_sink_syslog).to receive(:codec=)
-      expect(@mock_sink_syslog).to receive(:open).with('test')
-      expect(Steno::Sink::Syslog).to receive(:instance).twice.
-        and_return(@mock_sink_syslog)
     end
 
     after do
@@ -28,16 +22,15 @@
       expect(@config.context.class).to eq(Steno::Context::Null)
       expect(@config.codec.class).to eq(Steno::Codec::Json)
 
-      expect(@config.sinks.size).to eq(2)
-      expect(@config.sinks).to contain_exactly(@mock_sink_file, @mock_sink_syslog)
+      expect(@config.sinks.size).to eq(1)
+      expect(@config.sinks).to contain_exactly(@mock_sink_file)
     end
 
     it 'works for symbolized keys' do
       @hash = {
         file: @log_path,
         level: 'debug2',
         default_log_level: 'warn',
-        syslog: 'test',
         max_retries: 5
       }
     end
@@ -47,7 +40,6 @@
         'file' => @log_path,
         'level' => 'debug2',
         'default_log_level' => 'warn',
-        'syslog' => 'test',
         'max_retries' => 5
       }
     end
@@ -113,19 +105,6 @@
       expect(config.sinks[0]).to eq(mock_sink)
     end
 
-    it "adds a syslog sink if the 'syslog' key is specified" do
-      write_config(@config_path, { 'syslog' => 'test' })
-      mock_sink = double('sink')
-      expect(mock_sink).to receive(:open).with('test')
-      expect(mock_sink).to receive(:codec=)
-
-      expect(Steno::Sink::Syslog).to receive(:instance).twice.and_return(mock_sink)
-
-      config = described_class.from_file(@config_path)
-      expect(config.sinks.size).to eq(1)
-      expect(config.sinks[0]).to eq(mock_sink)
-    end
-
     it 'adds an io sink to stdout if no sinks are explicitly specified in the config file' do
       write_config(@config_path, {})
       mock_sink = double('sink')
diff --git a/spec/isolated_specs/steno/unit/sink/syslog_spec.rb b/spec/isolated_specs/steno/unit/sink/syslog_spec.rb
diff --git a/spec/tasks/db_spec.rb b/spec/tasks/db_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,6 @@ class MigrateSchema < VCAP::Config`
`34`	`34`	`logging: {`
`35`	`35`	`level: String, # debug, info, etc.`
`36`	`36`	`file: String, # Log file to use`
`37`		`- syslog: String, # Name to associate with syslog messages (should start with 'vcap.')`
`38`	`37`	`optional(:stdout_sink_enabled) => bool`
`39`	`38`	`}`
`40`	`39`	`}`