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

Proto to "report" different kinds of data. #962

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

boks1971
Copy link
Contributor

@boks1971 boks1971 commented Feb 4, 2025

Starting off with FeatureUsage with the one feature od
KRISP_NOISE_CANCELLATION.

boks1971 and others added 2 commits February 4, 2025 18:10
Starting off with `FeatureUsage` with the one feature od
`KRISP_NOISE_CANCELLATION`.
Copy link

changeset-bot bot commented Feb 4, 2025

🦋 Changeset detected

Latest commit: 0ef8aed

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "github.com/livekit/protocol" specified in the `fixed` option does not match any package in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

string participant_id = 6;
string track_id = 7;
google.protobuf.Timestamp started_at = 8;
google.protobuf.Timestamp ended_at = 9;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

A couple of notes/questions

  1. AnalyticsEvent message has a bunch of common fields like room_id, track_id, but I am making this standalone message fully self-contained. Is that okay?
  2. Talking about self-contained, this only has room_name, room_id, participant_identity and participant_id and it does not have full Room or ParticipantInfo. Is that okay? If full objects are needed, will have to get clients to submit it as the controller handling the report will not have all context.

Copy link
Contributor

Choose a reason for hiding this comment

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

this looks good

@@ -121,8 +121,9 @@ enum AnalyticsEventType {
SIP_CALL_INCOMING = 37;
SIP_CALL_STARTED = 38;
SIP_CALL_ENDED = 39;
REPORT = 40;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding an AnalyticsEvent to report different kinds of data to analytics. Open to a better name.

@@ -202,3 +204,24 @@ message AnalyticsNodeRooms {
google.protobuf.Timestamp timestamp = 3;
repeated AnalyticsRoom rooms = 4;
}

message ReportInfo {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Container for Report event data. Starting off a FeatureUsage to report Krisp usage.

}
}

message FeatureUsageInfo {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Making a generic feature usage message with an enum to indicate which feature. Thinking there will be more feature usage reports in the feature. So, made a generic FeatureUsage container with an enum.

@boks1971 boks1971 requested review from a team, shishirng, typester, lukasIO and bcherry February 4, 2025 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants