Being bold and moving to Done. Feel free to revert if signoff is needed. Any changes to the clients should be handled as separate tasks

Being bold and moving to Done. Feel free to revert if sign off is needed

https://wikitech.wikimedia.org/wiki/Metrics_Platform/Contextual_attributes has been published and reviewed as part of T374742: Update Metrics Platform docs on required contextual attributes. The remaining issues brought up in this task are tracked in T372689: Follow up on duplicated and unused pages for Metrics Platform and T376841: Render human-readable schemas on schema.wikimedia.org. I'm being bold and resolving this task, but feel free to reopen!

Thats great news! Thanks, @Milimetric. I've opened T376841: Render human-readable schemas on schema.wikimedia.org for that discussion.

Hi @phuedx, I saw that you've been working on Metrics_Platform/Sampling, so I wanted to ask for your thoughts on this proposal

Scheduled a synchronous review meeting for next week with Mikhail

Hi @Milimetric, Would you be able to provide feedback on whether you think it's worth it to move forward with one of these options?

Sounds great! Thanks, @Sarai-WMF!

Thanks, @phuedx! This all works for me.

Perfect! Thanks, @phuedx!

@phuedx would you be able to review the three sections in the previous comment?

Thanks for these clarifications, @Sfaci! I've updated the guides that I previously edited, and I created a new page (https://wikitech.wikimedia.org/wiki/Metrics_Platform/Contextual_attributes) that lists the contextual attributes supported by each client, including which are added automatically and which can be enabled in the stream config, along with references to the code. Let me know what you think! Edits welcome

I agree that an entirely new bug reporting system isn't feasible, nor is listing every tool and its bug tracker on How to report a bug.

https://developer.wikimedia.org/get-started/new-dev/

@VirginiaPoundstone Please read through the task description and let me know what you think about this approach to the docs for the remainder of the docs project! Feedback is also welcome from anyone on the team

In order to resolve this task, I need review on the following three things:

This is good to know. I propose updating the docs to create a space to describe which contextual attributes are added by default by each client. Once the JS client library is updated to add agent_client_platform_family automatically, we can update the docs to remove agent_client_platform_family as being required in the config step.

Thanks for these comments, @Sfaci and @phuedx. It seems like there's some variation in which contextual attributes are added automatically by each of the clients. I think my question is: If I'm using a client that adds some contextual attribute automatically, but I don't list that attribute in my stream config, will things break? Will that attribute still appear in my event data? If it's possible to leave the clients to set fields on the agent property (as phuedx said) and not worry about adding them to the config, that would help simplify the docs.

Declining since Graphs is marked as a security risk

Confirmed that I'm no longer seeing Wikipedia banners on the API Portal. Thank you!

Thanks for looking into this, @Krinkle! This is really interesting.

Updates for review:

Thanks for these responses, @phuedx! This is really helpful. I've removed wikifunctions.ui and mediawiki.reference_previews from the instrument list, and added the new Growth instrument since I noticed it in the config file.

This should be fairly easy to generate from the schemas themselves as every field has inline documentation…