v1.4 - event logging for metrics

[mjstealey]

FABRIC Metrics Logging

Enable event logging that is output to a file as defined in section 3.3

• FABRIC Metrics Collection (credentials required)

Event logging format

Events are logged to a rotating log file defined by the metricsLogger logging object. Format outlined below:

Event message   ::= <Datetime> <Preamble> <Identifier> <Event details>
Datetime        ::= <Date and Time in UTC>

Preamble        ::= User event | Project event | Publication event

Identifier      ::= <User> | <Project> | <Publication>
User            ::= usr:<UUID>[:<User email>]
Project         ::= prj:<UUID>
Publication     ::= pub:<UUID>

Event details   ::= <Verb> [ <Attribute name> <Attribute value>] [by <User>]
Verb            ::= create | modify | modify-add | modify-remove | delete
Attribute name  ::= <string>
Attribute value ::= <string> | '<string>'
UUID            ::= <uuid string>

Events are broken into areas related to granular API interactions and are not aggregate in nature

API endpoints

• Announcements - facility and maintenance announcements
• People - user and user profile information
• Projects - project and project profile information
• Publications - publication data (TBD)
• SSH Keys - bastion and sliver public key information
• Testbed Info - JSON testbed information (free form)
• Version - fabric-core-api version
• Who Am I - base user information/status (name, email, uuid, vouch_expiry, active, enrolled)

---

Announcements

People

• [x] User was created
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 create
• [x] User role added
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify-add role ROLE
• [x] User role removed
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify-remove role ROLE
• [x] User display_name modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify display_name NAME by usr:0000-0000-0000-0001
• [x] User preferred_email modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify preferred_email EMAIL by usr:0000-0000-0000-0001
• [x] User preference modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify PREF BOOL by usr:0000-0000-0000-0001
• [x] User bio modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify bio 'BIO' by usr:0000-0000-0000-0001
• [x] User cv modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify cv 'URL' by usr:0000-0000-0000-0001
• [x] User job modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify job 'JOB' by usr:0000-0000-0000-0001
• [x] User pronouns modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify pronouns 'PRONOUNS' by usr:0000-0000-0000-0001
• [x] User website modified
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify website 'URL' by usr:0000-0000-0000-0001
• [x] User personal_page added
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify-add personal_page 'PAGE' by usr:0000-0000-0000-0001
  • 'PAGE' --> 'url=URL, type=TYPE'
• [x] User personal_page removed
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify-remove personal_page 'PAGE' by usr:0000-0000-0000-0001
  • 'PAGE' --> 'url=URL, type=TYPE'
• [x] User other_identity added
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify-add other_identity 'IDENTITY' by usr:0000-0000-0000-0001
  • 'IDENTITY' --> 'identity=IDENT, type=TYPE'
• [x] User other_identity removed
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 modify-remove other_identity 'IDENTITY' by usr:0000-0000-0000-0001
  • 'IDENTITY' --> 'identity=IDENT, type=TYPE'

Projects

• [x] Project was created
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef create by usr:0000-0000-0000-0002
• [x] Project tag was added
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-add tag 'TAG' by usr:0000-0000-0000-0002
• [x] Project tag was removed
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-remove tag 'TAG' by usr:0000-0000-0000-0002
• [x] Project member was added
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-add member usr:0000-0000-0000-0001 by usr:0000-0000-0000-0002
• [x] Project member was removed
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-remove member usr:0000-0000-0000-0001 by usr:0000-0000-0000-0002
• [x] Project owner was added
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-add owner usr:0000-0000-0000-0001 by usr:0000-0000-0000-0002
• [x] Project owner was removed
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-remove owner usr:0000-0000-0000-0001 by usr:0000-0000-0000-0002
• [x] Project was deleted
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef delete by usr:0000-0000-0000-0002
• [x] Project description modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify description 'DESC' by usr:0000-0000-0000-0002
• [x] Project is_public modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify is_public BOOL by usr:0000-0000-0000-0002
• [x] Project name modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify name 'NAME' by usr:0000-0000-0000-0002
• [x] Project preference modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify PREF BOOL by usr:0000-0000-0000-0002
• [x] Project award_information modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify award_information 'INFO' by usr:0000-0000-0000-0002
• [x] Project goals modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify goals 'GOALS' by usr:0000-0000-0000-0002
• [x] Project keyword added
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-add keyword 'KEYWORD' by usr:0000-0000-0000-0002
• [x] Project keyword removed
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-remove keyword 'KEYWORD' by usr:0000-0000-0000-0002
• [x] Project project_status modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify project_status 'STATUS' by usr:0000-0000-0000-0002
• [x] Project purpose modified
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify purpose 'PURPOSE' by usr:0000-0000-0000-0002
• [x] Project references added
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-add reference 'REFERENCE' by usr:0000-0000-0000-0002
  • 'REFERENCE' --> 'description=DESC, url=URL'
• [x] Project references removed
  • 2022-09-06 19:45:56,022 Project event prj:dead-beef-dead-beef modify-remove reference 'REFERENCE' by usr:0000-0000-0000-0002
  • 'REFERENCE' --> 'description=DESC, url=URL'

Publications

SSH Keys

• [x] User SSH Key created
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 create sshkey KEYTYPE key:feed-beef-feed-beef
• [x] User SSH Key deactivated
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 deactivate sshkey KEYTYPE key:feed-beef-feed-beef
• [x] User SSH Key deleted
  • 2022-09-06 19:45:56,022 User event usr:0000-0000-0000-0001 delete sshkey KEYTYPE key:feed-beef-feed-beef

Testbed Info

[mjstealey]

deployed in v1.4.0 #15