Set up telemetry service #125
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
Co-authored-by: Jonathon Herbert <jonathon.herbert@guardian.co.uk>
tjsilver
commented
Aug 27, 2020
Comment on lines
+75
to
+77
| const stubTelemetrySender = (event: ITyperighterTelemetryEvent) => | ||
| console.log(event); | ||
| const telemetryService = new TelemetryService(stubTelemetrySender); |
There was a problem hiding this comment.
This is here for testing.
| @@ -85,10 +88,18 @@ const Controls = ({ | |||
| const handleCheckDocumentButtonClick = (): void => { | |||
| if (!pluginIsActive) { | |||
| onToggleActiveState(); | |||
| telemetryService?.typerighterIsOpened({documentUrl: document.URL}) | |||
There was a problem hiding this comment.
This is the perfect use-case for optional chaining – love to see it.
jonathonherbert
approved these changes
Aug 27, 2020
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.
What does this change?
We will have an analytics client shortly, responsible for batching and submitting telemetry events. We'd like our Prosemirror plugin to send events when they occur, via that interface.
This PR implements an events service with prosemirror-typerighter that calls the appropriate code when events happen. The backend of the implementation logs to console for now.
How to test
Run the branch locally and check the console for details of events triggered. You should see a separate log entry for: