title: fragment/analytics/product_metrics/common
description: |-
  The schema defines the common fragment of Experiment Platform fields that
  we believe should be in all product metrics schemas.

  See https://wikitech.wikimedia.org/wiki/Experimentation_Lab for more detail.
$id: /fragment/analytics/product_metrics/common/2.1.0
$schema: 'https://json-schema.org/draft-07/schema#'
type: object
allOf:
  - $ref: /fragment/analytics/common/2.0.0#
required:
  - action
properties:
  action:
    type: string
    maxLength: 64
    description: |-
      The type of the action.

      The type is expected to be human-readable and controlled by the team(s)
      that author and/or maintain the analytics instrument.

  action_subtype:
    type: string
    maxLength: 64
    description: |-
      The subtype or secondary type of the action.

      The subtype can be used to subdivide the action, e.g. when an error
      occurs, `action` would be `"error"` and `action_subtype` would be one of
      a set of values that describe the various errors that the analytics
      instrument tracks.

      The subtype is expected to be human-readable and controlled by the
      team(s) that author and/or maintain the analytics instrument.

  action_source:
    type: string
    maxLength: 64
    description: |-
      The friendly name of the source of the action.

  # See wikitech:Test_Kitchen/Decision_Records/Increase_action_context_limit
  action_context:
    type: string
    maxLength: 320
    description: |-
      Supporting context for the action, if any.

  instrument_name:
    type: string
    maxLength: 255
    description: |-
      The unique identifier to distinguish instruments for filtering.