Add codename in log file and stdout #17769

mkanoor · 2018-07-26T20:36:09Z

Our codename is not reflected in our logs or when
running it from console

In the log file it would show up as

  INFO -- : Codename:   Hammer

When running bin/rails s or bin/rails c it would show up as

  ManageIQ version: master codename: Hammer

mkanoor · 2018-07-26T20:36:33Z

@Fryguy @jrafanie
Please review

jrafanie · 2018-07-26T20:41:00Z

lib/vmdb/appliance.rb

@@ -10,6 +10,10 @@ def self.BUILD
      @EVM_BUILD ||= get_build
    end

+    def self.CODENAME
+      "Hammer".freeze


why didn't you think of this for Fine? It would have been a Fine codename.

I am trying to Hammer it in before its too late

@mkanoor Nailed it.

bdunne · 2018-07-27T13:53:06Z

config/application.rb

@@ -156,6 +156,7 @@ class Application < Rails::Application
    config.after_initialize do
      Vmdb::Initializer.init
      ActiveRecord::Base.connection_pool.release_connection
+      puts "ManageIQ version: #{Vmdb::Appliance.VERSION} codename: #{Vmdb::Appliance.CODENAME}"


_log.info?

@bdunne
When I use the log.info it dumps it into the log file but doesn't display it in stdout when you run bin/rails s

INFO -- : MIQ(Vmdb::Application.class:Application) ManageIQ version: master codename: H ammer

I was hoping to see in stdout like puma displays its version string when we run bin/rails s

Version 3.7.1 (ruby 2.4.4-p296), codename: Snowy Sagebrush

Should I add the log.info as well as puts for the stdout?

I have this in my database.yml...

puts "** ManageIQ #{evm_version}; Database: adapter=#{c["adapter"]}, name=#{c["database"]}, host=#{c["host"]}"

And we also have https://github.com/ManageIQ/manageiq/blob/master/config/initializers/session_store.rb#L43-L46 which gives me the following:

11:01:26 bdunne@localhost:~/projects/manageiq (master)$ rails c ** ManageIQ master; Database: adapter=postgresql, name=vmdb_development, host= ** Using session_store: ActionDispatch::Session::MemCacheStore Loading development environment (Rails 5.0.7) irb(main):001:0> exit 11:19:10 bdunne@localhost:~/projects/manageiq (master)$ rails s => Booting Puma => Rails 5.0.7 application starting in development on http://localhost:3000 => Run `rails server -h` for more startup options ** ManageIQ master; Database: adapter=postgresql, name=vmdb_development, host= ** Using session_store: ActionDispatch::Session::MemCacheStore I, [2018-07-27T11:19:28.512348 #26973] INFO -- : Initializing websocket worker! Puma starting in single mode... * Version 3.7.1 (ruby 2.4.3-p205), codename: Snowy Sagebrush * Min threads: 5, max threads: 5 * Environment: development * Listening on tcp://localhost:3000 Use Ctrl-C to stop

Maybe we can combine all of this information somewhere?

~~If you want it in Stdout, user Rails.logger instead.~~ Rails.logger doesn't work in this context, so puts is fine.

I thinking prefer the following text:

puts "** #{Vmdb::Application::PRODUCT_NAME} #{Vmdb::Appliance.VERSION}, codename: {Vmdb::Appliance.CODENAME}"

which would look like

** ManageIQ master, codename: Hammer

on upstream

Additionally, we may want to move this string into a Vmdb::Appliance.BANNER method, then here just do

puts "** #{Vmdb::Appliance.BANNER}"

Fryguy · 2018-07-27T15:32:35Z

I generally don't like this as we have the version already dumped to the log files via the VERSION file, and I don't want to maintain a second copy of this value. When we actually cut hammer (which we haven't yet), then that will be in the VERSION file. If you're concerned about development mode, then we should probably pull from branch information.

mkanoor · 2018-07-31T19:43:16Z

@Fryguy The code name changes twice a year compared to the versions which happen with every zstream.
(a) This approach also helps us memorialize the codename like other products do
(b) By looking at the codename in the log file developers would know which branch to use and dont have to map version number to releases (codenames)

Fryguy · 2018-08-06T15:06:55Z

@mkanoor I think you misunderstand me. I don't dislike writing it to the log, I dislike hardcoding the value in a second place. We can pull this from the VERSION file, and then the VERSION file is the one source of this information.

Fryguy · 2018-08-06T15:17:31Z

Talked with @mkanoor and the goal is to show the codename independent of the VERSION file because of downstream and dev purposes. I have a few comments on where the stuff will live, that I'll make inline, but otherwise I'm done with this approach.

Fryguy · 2018-08-07T18:19:01Z

We'll also need a change to the release_branch tool of https://github.com/ManageIQ/manageiq-release

Our codename is not reflected in our logs or when running it from console In the log file it would show up as INFO -- : Codename: Hammer When running bin/rails s or bin/rails c it would show up as ManageIQ version: master codename: Hammer

miq-bot · 2018-08-07T18:36:02Z

Some comments on commits mkanoor/manageiq@cd911d8~...67ebcd4

config/application.rb

⚠️ - 159 - Detected puts. Remove all debugging statements.

miq-bot · 2018-08-07T18:36:54Z

Checked commits mkanoor/manageiq@cd911d8~...67ebcd4 with ruby 2.3.3, rubocop 0.52.1, haml-lint 0.20.0, and yamllint 1.10.0
2 files checked, 3 offenses detected

config/application.rb

❗ - Line 159, Col 7 - Rails/Output - Do not write to stdout. Use Rails's logger if you want to log.

lib/vmdb/appliance.rb

❗ - Line 13, Col 14 - Naming/MethodName - Use snake_case for method names.
❗ - Line 17, Col 14 - Naming/MethodName - Use snake_case for method names.

carbonin · 2019-01-28T22:45:49Z

This breaks the region detection in the console.

ManageIQ/manageiq-appliance_console#80 is one way to fix it, but I'm wondering if there isn't some way for this output to be suppressed just for the rails runner case? Otherwise, I personally would rather remove this than add the hack to the console.

Thoughts @Fryguy @mkanoor

tjyang · 2019-02-08T21:14:46Z

Hi all
Any update on which approach to fix this issue ?

carbonin · 2019-02-11T15:02:58Z

I opened an alternative solution here to just not print the codename to STDOUT in production mode. #18444

jrafanie reviewed Jul 26, 2018

View reviewed changes

gmcculloug assigned jrafanie Jul 27, 2018

gmcculloug added the enhancement label Jul 27, 2018

bdunne reviewed Jul 27, 2018

View reviewed changes

mkanoor added 2 commits August 7, 2018 14:21

Add codename in log file and stdout

cd911d8

Our codename is not reflected in our logs or when running it from console In the log file it would show up as INFO -- : Codename: Hammer When running bin/rails s or bin/rails c it would show up as ManageIQ version: master codename: Hammer

Added BANNER function based on PR feedback

67ebcd4

mkanoor force-pushed the add_codename branch from ecd80cb to 67ebcd4 Compare August 7, 2018 18:32

Fryguy merged commit 19e608c into ManageIQ:master Aug 9, 2018

Fryguy added this to the Sprint 92 Ending Aug 13, 2018 milestone Aug 9, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add codename in log file and stdout #17769

Add codename in log file and stdout #17769

mkanoor commented Jul 26, 2018

mkanoor commented Jul 26, 2018

jrafanie Jul 26, 2018

mkanoor Jul 26, 2018

jrafanie Jul 27, 2018

bdunne Jul 27, 2018

mkanoor Jul 27, 2018

bdunne Jul 27, 2018

Fryguy Jul 27, 2018 •

edited

Loading

Fryguy Aug 7, 2018 •

edited

Loading

Fryguy Aug 7, 2018

Fryguy commented Jul 27, 2018

mkanoor commented Jul 31, 2018

Fryguy commented Aug 6, 2018

Fryguy commented Aug 6, 2018

Fryguy commented Aug 7, 2018

miq-bot commented Aug 7, 2018

miq-bot commented Aug 7, 2018

carbonin commented Jan 28, 2019

tjyang commented Feb 8, 2019

carbonin commented Feb 11, 2019

Add codename in log file and stdout #17769

Add codename in log file and stdout #17769

Conversation

mkanoor commented Jul 26, 2018

mkanoor commented Jul 26, 2018

jrafanie Jul 26, 2018

Choose a reason for hiding this comment

mkanoor Jul 26, 2018

Choose a reason for hiding this comment

jrafanie Jul 27, 2018

Choose a reason for hiding this comment

bdunne Jul 27, 2018

Choose a reason for hiding this comment

mkanoor Jul 27, 2018

Choose a reason for hiding this comment

bdunne Jul 27, 2018

Choose a reason for hiding this comment

Fryguy Jul 27, 2018 • edited Loading

Choose a reason for hiding this comment

Fryguy Aug 7, 2018 • edited Loading

Choose a reason for hiding this comment

Fryguy Aug 7, 2018

Choose a reason for hiding this comment

Fryguy commented Jul 27, 2018

mkanoor commented Jul 31, 2018

Fryguy commented Aug 6, 2018

Fryguy commented Aug 6, 2018

Fryguy commented Aug 7, 2018

miq-bot commented Aug 7, 2018

miq-bot commented Aug 7, 2018

carbonin commented Jan 28, 2019

tjyang commented Feb 8, 2019

carbonin commented Feb 11, 2019

Fryguy Jul 27, 2018 •

edited

Loading

Fryguy Aug 7, 2018 •

edited

Loading