EADR - vets-api & Datadog log updates

[bramleyjl]

Issue Description

In order to deliver the appropriate external data metrics to VA leadership, the following changes to vets-api Rails log & Datadog metrics should be made. Datadog widgets and boards should also be updated.

• The affected logs & metrics should all be updated to ensure they include client_id and type attributes.
• The sign_in object that is generated in both SSOe & SiS should be updated to include client_id
• SSOe logs & sign_in object should be updated to use SiS terminology: client_id over application, type over credential_used || service_name
• EADR widgets in Datadog should all be filtered to only vets-website & VA mobile clients

Datadog Query Definitions

"Active Users" - success only

• SSOe log:
  • LOGIN_STATUS_SUCCESS - has context (type), client_id will be populated by sign_in object change, icn to be added
• SiS log:
  • [V0::SignInController] callback - success only, includes type, client_id, icn
  • [V0::SignInController] refresh - covers SiS mobile users that haven't re-authenticated, includes client_id, type & icn to be added

    "Total Authentications" - success only

• SSOE metric:
  • auth_login_success StatsD metric - includes context (type), client_id will be populated by sign_in object change
• SiS metric:
  • api_sis_callback_success StatsD metric - includes type, client_id

    "Credential Usage - Total Authentications" - success only

• SSOE metric:
  • auth_login_success StatsD metric - includes context (type), client_id will be populated by sign_in object change
• SiS metric:
  • api_sis_callback_success StatsD metric - includes type, client_id,

Tasks

Changes

SiS

• [x] Include type, icn in /refresh log payload

SSOe

• [x] Update SAMLTracker to use vaweb instead of a null value for its default application (client_id) value
• [x] include client_id in UserIdentity sign_in object
• [x] include icn in LOGIN_STATUS_SUCCESS log
• [x] update auth_login_success Datadog log tag context to standard CSP type

Datadog

• [x] Update widgets to match Datadog query definitions above

Documentation

• [x] update query documentation to reflect the update queries & log/metric generation locations in vets-api.

[bramleyjl]

api_auth_new has been updated with this PR and the type tag is now showing up on it in staging.

[bramleyjl]

Updates to StatsD Metrics

'api_auth_login_success'

updates

• context => type

  monitors

  app.ddog-gov.com/monitors/169075,"Identity - Prod External: MHV USiP Monitor is below 45%" app.ddog-gov.com/monitors/169277,"Identity - Prod External: MyVAHealth USiP Monitor is below 45%" app.ddog-gov.com/monitors/169276,"Identity - Prod External: VA Mobile USiP Monitor is below 45%" app.ddog-gov.com/monitors/169275,"Identity - Prod External: VA OCC Mobile USiP Monitor is below 45%" app.ddog-gov.com/monitors/89111,"Identity - Production Inbound ISAM SSOe Percent Error Threshold Crossed" app.ddog-gov.com/monitors/89113,"Identity - Production Outbound SSOe Percent Error Threshold crossed" app.ddog-gov.com/monitors/115836,"Identity - Production Outbound SSOe Percent Error Threshold crossed DSLOGON"

  'api_auth_login_failure'

  updates

• context => type

  monitors

  app.ddog-gov.com/monitors/169075,"Identity - Prod External: MHV USiP Monitor is below 45%" app.ddog-gov.com/monitors/169277,"Identity - Prod External: MyVAHealth USiP Monitor is below 45%" app.ddog-gov.com/monitors/169276,"Identity - Prod External: VA Mobile USiP Monitor is below 45%" app.ddog-gov.com/monitors/169275,"Identity - Prod External: VA OCC Mobile USiP Monitor is below 45%" app.ddog-gov.com/monitors/89111,"Identity - Production Inbound ISAM SSOe Percent Error Threshold Crossed" app.ddog-gov.com/monitors/89113,"Identity - Production Outbound SSOe Percent Error Threshold crossed" app.ddog-gov.com/monitors/115836,"Identity - Production Outbound SSOe Percent Error Threshold crossed DSLOGON"

  'api_auth_latency'

  updates

• context => type

  'api_auth_new'

  updates

• context => type

  monitors

  app.ddog-gov.com/monitors/119917,"Identity - Prod External: DSLogon authentication success rate is < 20% in the past 15 minutes" app.ddog-gov.com/monitors/119914,"Identity - Prod External: ID.me authentication success rate is < 20% in the past 15 minutes" app.ddog-gov.com/monitors/120105,"Identity - Prod External: Login.gov authentication success rate is < 20% in the past 15 minutes" app.ddog-gov.com/monitors/119915,"Identity - Prod External: MHV authentication success rate is < 20% in the past 15 minutes" app.ddog-gov.com/monitors/169075,"Identity - Prod External: MHV USiP Monitor is below 45%" app.ddog-gov.com/monitors/169277,"Identity - Prod External: MyVAHealth USiP Monitor is below 45%" app.ddog-gov.com/monitors/169276,"Identity - Prod External: VA Mobile USiP Monitor is below 45%" app.ddog-gov.com/monitors/169275,"Identity - Prod External: VA OCC Mobile USiP Monitor is below 45%" app.ddog-gov.com/monitors/89111,"Identity - Production Inbound ISAM SSOe Percent Error Threshold Crossed" app.ddog-gov.com/monitors/89113,"Identity - Production Outbound SSOe Percent Error Threshold crossed" app.ddog-gov.com/monitors/115836,"Identity - Production Outbound SSOe Percent Error Threshold crossed DSLOGON"

  'api_auth_saml_request'

  updates

• context normalized to string from 'authn' array
• client_id

  'api_auth_saml_response'

  updates

• client_id

  'api_auth_saml_callback'

  updates

• type
• client_id

  monitors

  app.ddog-gov.com/monitors/119917,"Identity - Prod External: DSLogon authentication success rate is < 20% in the past 15 minutes" app.ddog-gov.com/monitors/119914,"Identity - Prod External: ID.me authentication success rate is < 20% in the past 15 minutes" app.ddog-gov.com/monitors/120105,"Identity - Prod External: Login.gov authentication success rate is < 20% in the past 15 minutes" app.ddog-gov.com/monitors/119915,"Identity - Prod External: MHV authentication success rate is < 20% in the past 15 minutes"

[bramleyjl]

Query documentation has been updated.

https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/products/identity/External%20Auth%20Data%20Reporting/Working_docs/Queries_for_data.md