Skip to content

Review and update all internal events documentation to clarify SM event data collection since 18.0

Summary

Since GitLab 18.0, we collect event data from Self-Managed (SM) instances, not just aggregated metrics. We need to comprehensively review and update all internal events documentation and subpages to clarify this change.

Background

Previously, we only collected aggregated metrics from Self-Managed instances. Starting with version 18.0, we now collect individual event data from SM instances as well. This is a significant change that needs to be clearly documented across all relevant pages.

Related: #572704 - Banner implementation for event data collection opt-out

Primary Documentation to Review

Main page: https://docs.gitlab.com/development/internal_analytics/internal_event_instrumentation/

Related pages:

Tasks

  • Audit the main internal events instrumentation page for all mentions of SM data collection
  • Review all subpages under internal event instrumentation documentation
  • Update event data administration documentation (https://docs.gitlab.com/administration/settings/event_data/)
  • Add version information (18.0+) where appropriate
  • Ensure consistency across all documentation pages
  • Update any code examples or implementation guides that reference SM data collection
  • Review privacy and compliance sections for accuracy
  • Update developer guides and best practices documentation
  • Cross-reference with the event data collection banner documentation

Acceptance Criteria

  • All documentation clearly states that event data is collected from SM instances since 18.0
  • Version information (18.0+) is consistently applied
  • No conflicting or outdated information remains about SM data collection
  • Documentation aligns with the event data collection banner implementation

Labels

documentation devopsanalytics groupanalytics instrumentation sectionanalytics

Edited by 🤖 GitLab Bot 🤖