Make contextual attributes information more clear in the metrics platform documentation
Open, LowPublic
Actions

Assigned To

None

Authored By

	VirginiaPoundstone
	May 21 2024, 12:48 PM

Description

Description

We need to answer user questions about contextual attributes in our metrics platform documentation:

Are they still called contextual attributes in the current version of Metrics Platform?
Where can one look to know what are the currently-supported contextual attributes?
Should https://wikitech.wikimedia.org/wiki/Metrics_Platform/Event_Schema be marked as deprecated or just updated?

See slack thread for additional information: https://wikimedia.slack.com/archives/C01DFMX6QLB/p1716256483547319

Acceptance Criteria

questions are clearly answered in our metrics platform docs: https://wikitech.wikimedia.org/wiki/Metrics_Platform
if any pages should be deprecated they are clearly marked with a template banner.

Required

Review from at least one other engineer
Published and slack thread is updated announcing the clarifications. https://wikimedia.slack.com/archives/C01DFMX6QLB/p1716256483547319

Event Timeline

VirginiaPoundstone created this task.May 21 2024, 12:48 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 21 2024, 12:48 PM

I'd also recommend making sure there are definitions documented for contextual attributes where it may be unclear.

For example, the definition of performer_active_browsing_session_token is currently unclear to me as there are various session type tokens defined in current instruments. I believe it's the same as the activity session defined in this data hub entry but it would be helpful to confirm.

VirginiaPoundstone triaged this task as Low priority.Wed, May 29, 3:27 PM

VirginiaPoundstone edited projects, added Data Products; removed Data Products (Data Products Sprint 14).Thu, Jun 20, 8:34 PM

VirginiaPoundstone moved this task from Incoming to Data Products Sprint 16 on the Data Products board.Fri, Jun 21, 4:28 PM

VirginiaPoundstone edited projects, added Data Products (Data Products Sprint 16); removed Data Products.

Make contextual attributes information more clear in the metrics platform documentationOpen, LowPublicActions

Description

Description

Acceptance Criteria

Required

Event Timeline

Make contextual attributes information more clear in the metrics platform documentation
Open, LowPublic
Actions