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

base types for events package #1275

Merged
merged 10 commits into from
Jun 6, 2021
Merged

base types for events package #1275

merged 10 commits into from
Jun 6, 2021

Conversation

jimlambrt
Copy link
Collaborator

@jimlambrt jimlambrt commented Jun 3, 2021

This is first of 3 PRs to add the events package and they should be reviewed in order. After this one, then #1276 and #1277.

This PR will be merged into main after the last one in the series (#1277) has been approved.

BTW, none of these 3 PRs will affect any of the rest of Boundary. They are stand-alone infrastructure for eventing audits, errors, and observations. Subsequent PRs may change how some of this infrastructure works and we work to integrating the events package with the rest of Boundary and we continue to receive feedback from the Event Logging RFCs.

schristoff
schristoff previously approved these changes Jun 4, 2021
Copy link
Contributor

@schristoff schristoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor nits but nothing huge - thanks for laying this foundation :)

internal/observability/events/event.go Show resolved Hide resolved
internal/observability/events/event_audit.go Show resolved Hide resolved
internal/observability/events/event_audit.go Outdated Show resolved Hide resolved
internal/observability/events/event_type.go Outdated Show resolved Hide resolved
Copy link
Member

@mgaffney mgaffney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many (most?) of the exported types, functions, constant, etc are missing docs.

internal/observability/events/event.go Show resolved Hide resolved
internal/observability/events/eventer.go Show resolved Hide resolved
internal/observability/events/options.go Show resolved Hide resolved
@jimlambrt
Copy link
Collaborator Author

jimlambrt commented Jun 4, 2021

@mgaffney

Many (most?) of the exported types, functions, constant, etc are missing docs.
this will be addressed in a future PR. See my previous comment: #1275 (comment)

@jimlambrt
Copy link
Collaborator Author

@mgaffney @s-christoff added a commit with godoc comments for exported fields except for the unratified audit related fields and/or structs. Ty for the suggestion!

Copy link
Contributor

@vancluever vancluever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreeing with @mgaffney's points for sure re: comments and package naming (although some of these could be addressed now as I have not hit "refresh" yet 😜 )

Also some other things that need fixing including a test where an assertion seems to be getting missed.

internal/observability/events/event_audit.go Outdated Show resolved Hide resolved
internal/observability/events/event_audit_test.go Outdated Show resolved Hide resolved
internal/observability/events/event_error_test.go Outdated Show resolved Hide resolved
internal/observability/events/event_observation_test.go Outdated Show resolved Hide resolved
internal/observability/events/options.go Show resolved Hide resolved
Copy link
Collaborator

@louisruch louisruch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, I have a couple questions and comments, I see these PR's are getting some traction on reviews - I read through previous comments sorry in advance if I doubled up on any comment/question

go.mod Outdated Show resolved Hide resolved
internal/observability/event/event_audit.go Outdated Show resolved Hide resolved
internal/observability/event/event_audit.go Outdated Show resolved Hide resolved
internal/observability/event/id.go Outdated Show resolved Hide resolved
internal/observability/event/options.go Outdated Show resolved Hide resolved
@jimlambrt jimlambrt requested a review from louisruch June 4, 2021 21:02
@jimlambrt jimlambrt requested a review from vancluever June 4, 2021 21:18
louisruch
louisruch previously approved these changes Jun 4, 2021
Copy link
Collaborator

@louisruch louisruch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jimlambrt
Copy link
Collaborator Author

I've rolled back the directory name change for now... it will be reapplied before merging but it was causing all sorts of conflicts with the upstream PRs

vancluever
vancluever previously approved these changes Jun 4, 2021
Copy link
Contributor

@vancluever vancluever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

Just want to bring up as a minor point https://github.com/hashicorp/boundary/pull/1275/files#r645785137 (the thread over WithNow and how it might be better as WithTime since this option is not actually deriving or enforcing a current time.

@jimlambrt jimlambrt dismissed stale reviews from vancluever and louisruch via 6ba8327 June 6, 2021 11:56
@jimlambrt jimlambrt merged commit cc2c71a into main Jun 6, 2021
@jimlambrt jimlambrt deleted the jimlambrt-o11y-base-types branch June 6, 2021 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants