91828: Create general monitor classes #19078
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
va-vfs-bot
temporarily deployed
to
91828-create-general-monitors/main/main
va-vfs-bot
temporarily deployed
to
91828-create-general-monitors/main/main
va-vfs-bot
temporarily deployed
to
91828-create-general-monitors/main/main
| def track_request(message, metric, form_type = 'Unknown Form Type', user_account_uuid = nil, call_location: nil) | ||
| function, file, line = parse_caller(call_location) | ||
|
|
||
| StatsD.increment(metric) |
There was a problem hiding this comment.
Should we leave the metric to whatever the team wants or should we add a bit more structure so they can only pass in the prefix?
i.e. {STATS_KEY}.error
There was a problem hiding this comment.
For these functions I would let the metric be passed to the function. Also, possibly the 'log level' [info, warn, error] unless you want to split out or specify that it will log as an error in the function name.
Generated by 🚫 Danger |
There was a problem hiding this comment.
There is a confusing overlap with the ZSF monitor. Arguments for and against this logging module being agnostic versus inheriting ZSF.
I thought this library was going to live under lib/common?
Your thoughts/opinion on making a subclass to controller and sidekiq for saved_claim (since there are things which are not saved_claim which could potentially want to use this library)?
| @@ -7,6 +7,8 @@ module Burials | |||
| # Monitor functions for Rails logging and StatsD | |||
| # | |||
| class Monitor < ::ZeroSilentFailures::Monitor | |||
| include Logging::Monitor | |||
There was a problem hiding this comment.
will this cause issues since there would now be 2 constructors? and also a double include/inherit
| # frozen_string_literal: true | ||
|
|
||
| module Logging | ||
| class Monitor < ::ZeroSilentFailures::Monitor |
There was a problem hiding this comment.
probably should not inherit the ZSF monitor. try and keep this a module/include/mixin with standalone functions
i think this will cause confusion too with 'circular inheritance'
| def track_request(message, metric, form_type = 'Unknown Form Type', user_account_uuid = nil, call_location: nil) | ||
| function, file, line = parse_caller(call_location) | ||
|
|
||
| StatsD.increment(metric) |
There was a problem hiding this comment.
For these functions I would let the metric be passed to the function. Also, possibly the 'log level' [info, warn, error] unless you want to split out or specify that it will log as an error in the function name.
| # @param form_type [String] | ||
| # @param user_account_uuid [User] | ||
| # | ||
| def track_request(message, metric, form_type = 'Unknown Form Type', user_account_uuid = nil, call_location: nil) |
There was a problem hiding this comment.
instead of form_type have it be 'context' so what ever gets sent will just be appended to the logger payload.
also probably will need to allow 'tags' to be given, but those should be required
| FactoryBot.create( | ||
| :pensions_module_pension_claim, | ||
| form: { | ||
| veteranFullName: { | ||
| first: 'Test', | ||
| last: 'User' | ||
| }, | ||
| email: 'foo@foo.com', | ||
| veteranDateOfBirth: '1989-12-13', | ||
| veteranSocialSecurityNumber: '111223333', | ||
| veteranAddress: { | ||
| country: 'USA', | ||
| state: 'CA', | ||
| postalCode: '90210', | ||
| street: '123 Main St', | ||
| city: 'Anytown' | ||
| }, | ||
| statementOfTruthCertified: true, | ||
| statementOfTruthSignature: 'Test User' | ||
| }.to_json | ||
| ) |
There was a problem hiding this comment.
try to avoid using a specific form to test (i recently added a basic generic SaveClaim factory in my pr)
minimally - why not just FactoryBot.build(:pension_module_pension_claim)?
| # frozen_string_literal: true | ||
|
|
||
| require 'rails_helper' | ||
| require 'zero_silent_failures/monitor' |
| private | ||
|
|
||
| attr_reader :service |
There was a problem hiding this comment.
inherited private functions should be callable from the subclass
Create a general monitor class for vets-api for overall general tracking and sidekiq jobs with claims involved.
Summary
Logging::Monitorclass to hold simple request trackingLogging::Monitor::Sidekiqfor general Claim-based Sidekiq jobsincludegeneral classes to Pensions and BurialsRelated issue(s)
Testing done
What areas of the site does it impact?
N/a just new logging classes