[OPIK-130] Add anonymous usage information #316
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thiagohora
force-pushed
the
OPIK-130/add_anonymous_usage_information
branch
from
8a3afe6
to
0f4c577
Compare
thiagohora
force-pushed
the
OPIK-130/add_anonymous_usage_information
branch
from
0f4c577
to
d278247
Compare
Nimrod007
requested changes
Sep 26, 2024
.../opik-backend/src/main/java/com/comet/opik/infrastructure/bi/ApplicationStartupListener.java
Outdated
Show resolved
Hide resolved
Nimrod007
requested changes
Sep 26, 2024
thiagohora
force-pushed
the
OPIK-130/add_anonymous_usage_information
branch
from
6468b7e
to
414e280
Compare
thiagohora
force-pushed
the
OPIK-130/add_anonymous_usage_information
branch
from
dd525e8
to
a57e678
Compare
andrescrz
requested changes
Sep 27, 2024
There was a problem hiding this comment.
This is a functional implementation, but there are a few things to polish and others to discuss before moving forward.
Additionally, we need to make sure that this would work perfectly fine if it was enabled in our environments by counting them as installations. This won't be the case, but ensures a robust installation.
Finally, the implementation has to make clear that the inner tables are just for functionality purposes such as tracking if the event was sent or not and to persist the anonymous ID once it's generated the first time. So it should be clear that the real usage isn't and can't be tracked on those tables and that it's actually in the server receiving the client events.
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/OpikConfiguration.java
Outdated
Show resolved
Hide resolved
.../opik-backend/src/main/java/com/comet/opik/infrastructure/bi/ApplicationStartupListener.java
Outdated
Show resolved
Hide resolved
.../opik-backend/src/main/java/com/comet/opik/infrastructure/bi/ApplicationStartupListener.java
Outdated
Show resolved
Hide resolved
.../opik-backend/src/main/java/com/comet/opik/infrastructure/bi/ApplicationStartupListener.java
Outdated
Show resolved
Hide resolved
.../opik-backend/src/main/java/com/comet/opik/infrastructure/bi/ApplicationStartupListener.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/UsageReportDAO.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/UsageReportDAO.java
Outdated
Show resolved
Hide resolved
.../resources/liquibase/db-app-state/migrations/000002_create_usage_usage_information_table.sql
Show resolved
Hide resolved
.../resources/liquibase/db-app-state/migrations/000002_create_usage_usage_information_table.sql
Show resolved
Hide resolved
thiagohora
force-pushed
the
OPIK-130/add_anonymous_usage_information
branch
from
b99925f
to
1ae8e20
Compare
Nimrod007
requested changes
Sep 30, 2024
Nimrod007
previously approved these changes
Sep 30, 2024
andrescrz
reviewed
Sep 30, 2024
apps/opik-backend/src/main/java/com/comet/opik/OpikApplication.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/InstallationReportService.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/InstallationReportService.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/InstallationReportService.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/InstallationReportService.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/Metadata.java
Outdated
Show resolved
Hide resolved
apps/opik-backend/src/main/java/com/comet/opik/infrastructure/bi/OpikStartupEvent.java
Outdated
Show resolved
Hide resolved
.../resources/liquibase/db-app-state/migrations/000002_create_usage_usage_information_table.sql
Show resolved
Hide resolved
| } | ||
|
|
||
| if (appContextConfig.usageReportEnabled()) { | ||
| list.add("usageReport.enabled: true"); |
There was a problem hiding this comment.
I believe this shouldn't be hardcoded to true.
...k-backend/src/test/java/com/comet/opik/infrastructure/bi/ApplicationStartupListenerTest.java
Outdated
Show resolved
Hide resolved
|
I left my previous review. Things we have to check and agree on before moving forward:
Everything else is minor and not a blocker. |
Nimrod007
previously approved these changes
Sep 30, 2024
andrescrz
previously approved these changes
Sep 30, 2024
| try { | ||
| lockService.executeWithLock(lock, tryToReportStartupEvent(eventType)) | ||
| .subscribeOn(Schedulers.boundedElastic()) | ||
| .block(); |
There was a problem hiding this comment.
Minor: maybe in this case it's recommended to have a timeout. We don't in resource calls as we have both REST server side and client side timeouts, but this call path is different.
thiagohora
dismissed stale reviews from andrescrz and Nimrod007
via
50652fd
Nimrod007
approved these changes
Sep 30, 2024
andrescrz
approved these changes
Sep 30, 2024
dsblank
pushed a commit
that referenced
this pull request
Oct 4, 2024
* [OPIK-130] Add anonymous usage information * PR review * Add body check * Update config.yml * Update ApplicationStartupListener.java * Fix response * Add services and DAO and extracting installation report to a service * Address PR review comments * Add documentation and timeout
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
Add a log table to report the first start-up as a BI event.
Issues
OPIK-130
Resolves #
Testing
Via automated tests
Documentation
By default, the report is enabled, but the user can disable it via
OPIK_REPORTING_ENABLED