[O365_metrics] Add teams_user_activity datastream #12219
Conversation
ritalwar
added
Team:Obs-InfraObs
🚀 Benchmarks reportTo see the full report comment with |
|
💚 Build Succeeded
cc @ritalwar |
| required: false | ||
| show_user: false | ||
| default: | ||
| - o365.metrics.outlook.activity |
| value: "8.16.0" | ||
| - json: | ||
| field: teamsuseractivity | ||
| target_field: o365.metrics.teams.user.activity |
There was a problem hiding this comment.
Maybe add ignore_failure: true here so the pipeline doesn't break.
|
|
||
| ### Teams User Activity | ||
|
|
There was a problem hiding this comment.
Suggestion: Please add a one or two-line summary of what the dataset metrics are about.
| type: integer | ||
| description: | | ||
| The count of other user actions within Teams. | ||
| - name: private_chat_messages.count |
There was a problem hiding this comment.
As with the other datasets, kindly verify if the 2**31 value length is enough to hold the value received? If not enough, kindly choose a different field type.
There was a problem hiding this comment.
long would be a safe or an unsigned type would be a safe choice in general.
| type: date | ||
| description: | | ||
| The date when the report data was last updated. | ||
| - name: date |
There was a problem hiding this comment.
Is this different from the @timestamp field value ?
There was a problem hiding this comment.
Yes, details in this comment.
| - name: report | ||
| type: group | ||
| fields: | ||
| - name: period.day |
There was a problem hiding this comment.
Is this value same as the period configuration value?
There was a problem hiding this comment.
Yes, we can configure values such as D7, D30, etc., in the period, and it will display 7 and 30 accordingly.
| ignore_missing: true | ||
| - rename: | ||
| field: o365.metrics.teams.user.activity.report_date | ||
| target_field: o365.metrics.teams.user.activity.report.date |
There was a problem hiding this comment.
should we do a explicit date handling based on type using the date processor?
| source: | | ||
| String underscore(String s) { | ||
| String result = /[ -]/.matcher(s).replaceAll('_').toLowerCase(); | ||
| return /[\ufeff]/.matcher(result).replaceAll('') |
There was a problem hiding this comment.
Yes, there is a BOM character present in some fields, and I should update the pipeline comment to specify this as well.
| String result = /[ -]/.matcher(s).replaceAll('_').toLowerCase(); | ||
| return /[\ufeff]/.matcher(result).replaceAll('') | ||
| } | ||
|
|
| target_field: o365.metrics.teams.user.activity | ||
| - script: | ||
| lang: painless | ||
| description: Replace spaces and dashes in field names under o365.metrics.teams.user.activity. |
There was a problem hiding this comment.
I will mention, thanks!
| @@ -0,0 +1,83 @@ | |||
| { | |||
| "o365": { | |||
| "metrics": { | |||
There was a problem hiding this comment.
@ritalwar - Query related to the metrics association. Is there a way the teams user activity metrics could be associated with the user-id or name to understand from where the request originates. If the user enables this specific data stream for user activity, how do they identify for which user this metrics is related to?
There was a problem hiding this comment.
Is this a limitation in API response itself?
There was a problem hiding this comment.
Hi @muthu-mps , this data stream is primarily designed to retrieve the number of Microsoft Teams users categorized by activity type. The activity types include team chat messages, private chat messages, calls, and meetings. Refer to the documentation here.
I'll add such links to the README for each dataset to prevent similar confusion.
There was a problem hiding this comment.
When the API says user activity, I thought somehow they will link user to the activity type but this seems to be overall activity counts and not specific to a user.
There was a problem hiding this comment.
@ritalwar, is this data-stream going to be renamed to teams_user_activity_user_counts? I am working on teams_user_activity_user_detail here.
There was an agreement on creating data-streams viva_engage_device_usage_user_counts and viva_engage_groups_activity_group_details. I think we should continue the same norm here to avoid confusion for the users.
Proposed commit message
Add teams_user_activity datastream to O365_metrics package.
Checklist
changelog.ymlfile.How to test this PR locally
Related issues
Screenshots