Skip to content
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

asgs-lint warn if length of INSTANCENAME + " " + ASGSADMIN exceeds a length that'd make the email subject > 99 (~51 chars) #1123

Closed
2 tasks
wwlwpd opened this issue May 7, 2023 · 4 comments
Assignees
Labels
documentation linter things to add to the linter metadata monitoring NEEDS: follow up reminder to check on the state of this case, its needs occasionally opendap question reliability

Comments

@wwlwpd
Copy link
Collaborator

wwlwpd commented May 7, 2023

  • Due to the discover that the subject length affects email reliability, we must warn (or die as critical) when INSTANCENAME + " " ASGSADMIN > 51 characters, which pushes the subject > 99 characters when NAM forcing is being used.

Also add:

  • a check ASGSADMIN_ID in asgs-lint

TODO - determine what's the limit when TROPICALCYCLONE is active?

@wwlwpd wwlwpd changed the title asgs-lint warn if length of INSTANCENAME + " " `ASGSADMIN exceeds a length that'd make the email subject > 99 (~51 chars) asgs-lint warn if length of INSTANCENAME + " " + `ASGSADMIN exceeds a length that'd make the email subject > 99 (~51 chars) May 7, 2023
@wwlwpd wwlwpd changed the title asgs-lint warn if length of INSTANCENAME + " " + `ASGSADMIN exceeds a length that'd make the email subject > 99 (~51 chars) asgs-lint warn if length of INSTANCENAME + " " + ASGSADMIN exceeds a length that'd make the email subject > 99 (~51 chars) May 7, 2023
@wwlwpd wwlwpd added linter things to add to the linter opendap labels May 7, 2023
@jasonfleming jasonfleming added documentation metadata reliability monitoring question NEEDS: follow up reminder to check on the state of this case, its needs occasionally labels May 8, 2023
@jasonfleming
Copy link
Collaborator

  1. For this particular case, can asgs-lint pre-construct the worst-case email subject line and issue a warning if it will be too long?
  2. In general, the interface between ASGS and data consumers has always been ad-hoc, for better or worse, with metadata being embedded in the
    1. thredds/nginx url path
    2. ASGS instance name
    3. email subject line for results notification
    4. netcdf global attributes and variable-level attributes
    5. ASGS instance status (asgs.instance.status.json) files
    6. initialization/nowcast/forecast cycle status (hook.status.json) files
    7. scenario status (scenario.status.json) files
    8. scenario metadata (run.properties)
  3. The ASGS Interface Guide wiki page is a nice start but it is incomplete and out of date

Is it possible to rationalize all these sources and channels of metadata so that we don't have to pack redundant metadata into e.g. an email subject line with a strict limit on the number of characters?

Is there interest in having an updated and definitive ASGS Interface Guide that can act as a contract between ASGS and data consumers?

@wwlwpd
Copy link
Collaborator Author

wwlwpd commented May 9, 2023

  1. For this particular case, can asgs-lint pre-construct the worst-case email subject line and issue a warning if it will be too long?

Yes, good idea.

2. In general, the interface between ASGS and data consumers has always been ad-hoc, for better or worse, with metadata being embedded in the
   
   1. thredds/nginx url path
   2. ASGS instance name
   3. email subject line for results notification
   4. netcdf global attributes and variable-level attributes
   5. ASGS instance status (`asgs.instance.status.json`) files
   6. initialization/nowcast/forecast cycle status (`hook.status.json`) files
   7. scenario status (`scenario.status.json`) files
   8. scenario metadata (`run.properties`)

3. The [ASGS Interface Guide](https://github.com/StormSurgeLive/asgs/wiki/ASGS-Interface-Guide) wiki page is a nice start but it is incomplete and out of date

Is it possible to rationalize all these sources and channels of metadata so that we don't have to pack redundant metadata into e.g. an email subject line with a strict limit on the number of characters?

The answer is yes, but this seems like it warrants a discussion to break this down and plan it out.

Is there interest in having an updated and definitive ASGS Interface Guide that can act as a contract between ASGS and data consumers?

Not sure what you mean, exactly - let's talk about this also. A problem (or advantage) ASGS has is its behavior is defined by the implementation, and not the other way around.

@jasonfleming
Copy link
Collaborator

Ok I've created a Discussion topic for this: #1127

@wwlwpd
Copy link
Collaborator Author

wwlwpd commented May 11, 2023

I am going to close this since the line length actually turned out to be a red herring. The max line has been updated to 120, which should be enough for anyone's current use.

@wwlwpd wwlwpd closed this as completed May 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation linter things to add to the linter metadata monitoring NEEDS: follow up reminder to check on the state of this case, its needs occasionally opendap question reliability
Projects
None yet
Development

No branches or pull requests

2 participants