-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add configurable alert to print log statement warning of missing TIMs deposits #106
base: dev
Are you sure you want to change the base?
Conversation
…-ingest-log-alerts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just a few questions!
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/traveler/TimDepositController.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This all looks great! I just had a couple of questions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The solution looks good overall, and the unit tests are passing! I just left a comment about a mismatch between the environment variable names in sample.env and docker-compose.yml, along with a suggestion to handle the empty string case for the variable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
PR Details
Description
We have added support for logging WARN level messages to indicate when we have not received any TIMs messages through our TimDepositController. The monitoring and the interval at which the monitor runs are both configurable via environment variables. I have also marked the executable scripts (like mvnw) as executable in the git index so that developers don't need to chmod +x the scripts whenever they want to run them.
Related Issue
No relevant GitHub Issue, but there is one for CDOT:
Modify ODE to log warning upon not receiving data for a configurable duration
https://dev.azure.com/SOC-OIT/CDOT/_workitems/edit/229495
Motivation and Context
As developers and maintainers of the ODE systems, we want a way to detect when we have lost connectivity or are not receiving data via the TimsDepositController. This will help us identify connectivity issues with WZDX and be proactive about resolving these issues.
How Has This Been Tested?
Unit tests were added where feasible to confirm code functions as intended. Where unit tests were not feasible, like in the case of log messages being emitted, local tests were run to simulate TIMs deposits and view the appropriate log messages. See the following screenshots of logs for more information:
Types of changes
Checklist:
ODE Contributing Guide