Referência do Evento do Serviço de Uso

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Informações sobre as propriedades da versão 2 do evento do serviço de uso

Not for use with personal data

Este artigo contém informações de referência sobre:

  • Os dados do evento que são enviados para o serviço de uso (versão 2 do objeto de evento, EventV2)
  • Seu objeto applicationProperties contido
  • O objeto testResults (contido dentro do objeto applicationProperties) quando AXE_INCLUDE_TEST_RESULTS é definido como true

Evento da Versão 2

A interface TypeScript a seguir define um evento da versão 2:

interface EventV2 {
  version: 'v2'
  productName: string
  productComponent: string
  productComponentVersion: string
  event: string
  dateTime: Date
  keycloakId?: string
  distinctId: string
  userId?: string
  organization?: string
  department?: string
  application?: string
  devInstance?: boolean
  sessionId?: string
  userStatus?: string
  loggedIn?: boolean
  applicationProperties?: Record<string, any>
  userJobRole?: string
  actor?: 'human' | 'automation'
  teams?: { id: string; name: string }[]
}
Nome Descrição
ator Se uma pessoa (human) ou um pipeline automatizado (automation) executou o teste. Definido pela CLI, pelas APIs Node.js e pela API Ruby. Veja ator.
application A aplicação que criou este evento
applicationProperties applicationProperties definido abaixo
dateTime Data e hora (até o milissegundo) no formato ISO-8601, fuso UTC
department O departamento do usuário dentro da organização
devInstance Se este uso é considerado uma instância do desenvolvedor e provavelmente deve ser filtrado
distinctId O uuid distinto do usuário
event Tipo de evento como uma string, geralmente valores "analyze" ou "uri: analyze"
keycloakId O ID do Keycloak do usuário
loggedIn Se o usuário está logado
organization A organização do usuário
productComponent Definido pelas APIs para indicar diferentes integrações, como Playwright
productComponentVersion Uma string indicando a versão do componente do produto
productName Definido pelas APIs para indicar a integração que você está usando
sessionId Um uuid identificando a sessão (para permitir a agrupação de eventos)
equipes As equipes que executam o teste, como um array de objetos { id, name }. Definido pela CLI, pelas APIs Node.js e pela API Ruby. Veja equipes.
userId O ID do usuário
userJobRole A função do trabalho do usuário
userStatus O status do usuário
versão Uma string especificando a versão do evento, sempre 'v2'

distinctId

O valor distinctId é um uuid que é definido por usuário sempre que as métricas são registradas. Ele deve ser estável ao longo do tempo porque é definido na primeira execução do CLI ou do código que utiliza as APIs. Está armazenado no arquivo .deque/distinct_id no diretório home de cada usuário.

ator

A CLI, as APIs Node.js e a API Ruby definem actor para automation quando uma dessas variáveis de ambiente é definida para um valor diferente de false ou 0: CI, BUILD_NUMBER, BUILDKITE, CIRCLECI, CODEBUILD_BUILD_ID, GITHUB_ACTIONS, GITLAB_CI, JENKINS_URL, TEAMCITY_VERSION, TF_BUILD ou BITBUCKET_BUILD_NUMBER. Caso contrário, actor é human. Defina a variável de ambiente AXE_ACTOR para human ou automation para substituir a detecção. O pacote @axe-devtools/browser não consegue ler variáveis de ambiente quando é executado em um navegador, então ele relata human lá.

equipes

O array teams registra as equipes cujos membros executaram o teste. A CLI, as APIs Node.js e a API Ruby sempre o enviam, como um array vazio ([]) quando nenhuma equipe é definida. Você mesmo fornece as equipes, com a variável de ambiente AXE_TEAMS, a opção --set-teams da CLI, o método setTeams da sua API Node.js ou a cláusula for_teams ou propriedade de configuração teams da API Ruby. Cada equipe é um objeto com propriedades string id e name:

[{ "id": "1", "name": "Web" }]

Entradas sem uma string id e name são descartadas. Um valor que não pode ser lido ou não é um array JSON é ignorado, e o evento ainda é enviado.

applicationProperties

O objeto applicationProperties contém informações de contagem sobre a execução do teste, como exemplo abaixo mostra:

  applicationProperties: {
    advancedRules: { enabled: false, value: 'disabled', source: 'unavailable' },
    target: 'https://broken-workshop.dequelabs.com/',
    targetMedium: 'text/html',
    urlCount: 1,
    engineVersion: '4.14.0',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,label',
    failedItemCount: 5,
    criticalIssueCount: 3,
    seriousIssueCount: 2,
    moderateIssueCount: 0,
    minorIssueCount: 0,
    needsReviewItemCount: 4,
    inapplicableRuleCount: 39,
    incompleteRuleCount: 2,
    passedRuleCount: 21,
    testResults: {}
  },
Propriedade Descrição
regrasAvançadas Se regras avançadas foram executadas. A CLI, as APIs Node.js e a API Ruby nunca executam regras avançadas, então isso é sempre { enabled: false, value: 'disabled', source: 'unavailable' }.
comando O comando CLI que executou a varredura, como spec ou bulk-spec. Enviado apenas pelo CLI.
contagemProblemasCríticos Número de elementos com impacto crítico que falharam
versãoEngine A versão do axe-core usada para teste
contagemItensFalhos Número total de erros de acessibilidade encontrados na página
contagemRegrasFalhas Número de regras que falharam na página
nomesRegrasFalhas String separada por vírgula com os nomes das regras que falharam
contagemRegrasInaplicáveis Número de regras que não foram aplicadas
contagemProblemasMenores Número de elementos com impacto menor que falharam
contagemProblemasModerados Número de elementos com impacto moderado que falharam
contagemItensNecessitamRevisão Número de elementos que precisam de revisão
contagemRegrasIncompletas Número de regras que estavam incompletas
contagemRegrasPassadas Número de regras que passaram
contagemProblemasSérios Número de elementos com impacto sério que falharam
alvo URL testada
meioAlvo Tipo MIME do alvo. Denominado target_medium antes da versão 4.14.0.
testResults O objeto testResults, veja a próxima seção para mais informações
contagemURLs Número de URLs distintas analisadas. Uma página de especificação CLI cujas ações navegam e analisam novamente relatam mais de 1.

testResults

O objeto testResults é definido como um objeto axeResults (definido pelo axe-core). Ele só é configurado quando você define a variável de ambiente AXE_INCLUDE_TEST_RESULTS como true, que é suportado apenas pelo CLI e pelas APIs do Node.js.

interface AxeResults extends EnvironmentData {
  toolOptions: RunOptions;
  passes: Result[];
  violations: Result[];
  incomplete: Result[];
  inapplicable: Result[];
}

Abaixo está um exemplo de um objeto testResults:

{
  testEngine: {
    name: "axe-core",
    version: "4.4.1"
  },
  testRunner: {
    name: "axe"
  },
  testEnvironment: {
    userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML,like Gecko) Version/16.0 Safari/605.1.15",
    windowWidth: 1280,
    windowHeight: 720
  },
  timestamp: "2023-02-02T20:09:04.785Z",
  url: "https://broken-workshop.dequelabs.com/",
  toolOptions: {
    reporter: "v1"
  },
  inapplicable: [],
  passes: [],
  incomplete: [],
  violations: []
}

Para brevidade, os arrays inapplicable, passes, incomplete e violations, que normalmente contêm objetos Result, não foram incluídos.

Você pode ver as definições de TypeScript desses objetos no repositório do GitHub do axe-core.

Veja Também

Para tutoriais que demonstram como usar o serviço de uso, veja Introdução ao Serviço de Uso e às APIs e Introdução ao Serviço de Uso e ao CLI.

Para informações gerais sobre o serviço de uso, veja O Axe DevTools para o Serviço de Uso Web.