IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector

Subclasses indiretas conhecidas AtraceCollector, AtraceRunMetricCollector, BaseDeviceMetricCollector, BluetoothConnectionLatencyCollector, BluetoothConnectionStateCollector, BluetoothHciSnoopLogCollector, BugreportzOnFailureCollector, BugreportzOnTestCaseFailureCollector, ClangCodeCoverageCollector, CodeCoverageCollector, CountTestCasesCollector, DebugHostLogOnFailureCollector, DeviceTraceCollector, FilePullerDeviceMetricCollector, FilePullerLogCollector e mais 16. AtraceCollector Um IMetricCollector que executa um rastreamento durante um teste e coleta o resultado e o registro para a invocação.  AtraceRunMetricCollector Coleta os traces de todos os diretórios de teste no diretório especificado do dispositivo de teste, registra o diretório de teste e pós-processa os arquivos de trace no diretório de teste e agrega as métricas.  BaseDeviceMetricCollector Implementação básica de IMetricCollector que permite iniciar e interromper a coleta em onTestRunStart(DeviceMetricData) e onTestRunEnd(DeviceMetricData,Map).  BluetoothConnectionLatencyCollector O coletor vai enviar uma configuração de métrica de duração do statsd predefinida para os dispositivos e coletar a duração da conexão Bluetooth de cada perfil.  BluetoothConnectionStateCollector Esse coletor vai coletar métricas BluetoothConnectionStateChanged e registrar o número de estados de conexão para cada perfil.  BluetoothHciSnoopLogCollector Coletor para ativar o registro de rastreamento do HCI Bluetooth no DUT e coletar o registro de cada teste.  BugreportzOnFailureCollector Coleta um bugreportz quando um caso de teste falha.  BugreportzOnTestCaseFailureCollector Coletar um bugreportz quando um caso de teste em uma execução falhar.  ClangCodeCoverageCollector Um BaseDeviceMetricCollector que extrai as medições de cobertura do Clang do dispositivo e as registra como artefatos de teste.  CodeCoverageCollector Um BaseDeviceMetricCollector que vai extrair medições de cobertura nativa e Java do dispositivo e as registrar como artefatos de teste.  CountTestCasesCollector Conta e informa o número de casos de teste para um determinado IRemoteTest.  DebugHostLogOnFailureCollector Coletor que vai reunir e registrar os registros do lado do host quando ocorrer uma falha no caso de teste.  DeviceTraceCollector Coletor que inicia o rastreamento do Perfetto quando uma execução de teste começa e registra o arquivo de rastreamento no final.  FilePullerDeviceMetricCollector Um BaseDeviceMetricCollector que detecta a chave de métricas do dispositivo e as extrai como um arquivo.  FilePullerLogCollector Registrador do arquivo informado pelo lado do dispositivo.  GcovCodeCoverageCollector Um BaseDeviceMetricCollector que vai extrair as medições de cobertura do gcov do dispositivo e registrá-las como artefatos de teste.  GcovKernelCodeCoverageCollector Um BaseDeviceMetricCollector que extrai as medições de cobertura do kernel gcov do debugfs e do dispositivo e, por fim, as registra como artefatos de teste.  HostStatsdMetricCollector Um IMetricCollector que coleta métricas do statsd do lado do host usando comandos do utilitário statsd.  JavaCodeCoverageCollector Um BaseDeviceMetricCollector que extrai medições de cobertura do Java do dispositivo e as registra como artefatos de teste.  LogcatOnFailureCollector Coletor que captura e registra um logcat quando um caso de teste ou uma execução de teste falha.  LogcatTimingMetricCollector Um coletor de métricas que coleta informações de tempo (por exemplo, tempo de troca de usuário) do logcat durante um ou vários testes repetidos usando padrões regex específicos para analisar sinais de início e fim de um evento das linhas do logcat.  ModuleLogcatCollector Versão do coletor logcat, mas para o módulo.  ModulePerfettoCollector Coletor que inicia o rastreamento do perfetto quando um módulo de teste começa e termina e o dispositivo é reiniciado.  PerfettoFilePullerCollector Um coletor que extrai arquivos de rastreamento do Perfetto do dispositivo, compacta-os (opcionalmente) e os adiciona aos registros de teste.  PerfettoPullerMetricCollector Essa classe foi descontinuada. Use PerfettoFilePullerCollector e ERROR(/PerfettoTracePostProcessor) em vez disso.  RebootReasonCollector Coletor que coleta reinicializações de dispositivos durante o teste e as informa por motivo e contagem.  RuntimeRestartCollector Coletor que coleta carimbos de data/hora de reinicializações de tempo de execução (falhas do servidor do sistema) durante a execução do teste, se houver.  ScreenRecordOnFailureCollector Coletor que captura e registra uma gravação de tela quando um caso de teste falha.  ScreenshotOnFailureCollector Coletor que captura e registra uma captura de tela quando um caso de teste falha.  ShowmapPullerMetricCollector Implementação básica de FilePullerDeviceMetricCollector que permite extrair os arquivos showmap do dispositivo e coletar as métricas dele.  TraceCmdCollector Um IMetricCollector que coleta rastreamentos durante o teste usando trace-cmd e os registra na invocação.

---

Essa interface será adicionada como um decorador ao informar os resultados dos testes para coletar métricas correspondentes.

Essa interface não pode ser usada como um , mesmo que estenda ITestInvocationListener. A verificação de configuração vai rejeitá-lo. Ele precisa ser usado como um "metrics_collector".

Não é esperado que os coletores mantenham um estado interno, já que podem ser reutilizados em vários lugares. Se um estado interno realmente precisar ser usado, ele deverá ser limpo em init(IInvocationContext,ITestInvocationListener).

Resumo

Métodos públicos
default boolean	captureModuleLevel() Indica se o coletor é aplicável à captura no nível do módulo e precisa ser inicializado.
default boolean	doesModuleContainFailure() Retorna "true" se o módulo atual tiver falhas em casos de teste ou execuções de teste.
default void	enableDefaultMetricCollection() Permite que os coletores ativem a coleta de métricas padrão.
default IMetricCollector.MetricCollectionLevel	getAlwaysOnCollectionLevel()
abstract List<IBuildInfo>	getBuildInfos() Retorna a lista de informações de build disponíveis na invocação.
abstract List<ITestDevice>	getDevices() Retorna a lista de dispositivos disponíveis na invocação.
abstract ITestInvocationListener	getInvocationListener() Retorna o ITestInvocationListener original para onde estamos encaminhando os resultados.
default IMetricCollector.MetricCollectionLevel	getOnFailureCollectionLevel()
abstract ITestInvocationListener	init(IInvocationContext context, ITestInvocationListener listener) Inicialização do coletor com o contexto atual e onde encaminhar os resultados.
default boolean	isDefaultMetricCollectionEnabled() Indica se o coletor está coletando métricas como parte da coleta de métricas padrão.
abstract void	onTestAssumptionFailure(DeviceMetricData testData, TestDescription test) Callback quando um caso de teste falha devido a uma falha de proposição.
abstract void	onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test) Callback quando um caso de teste é encerrado.
abstract void	onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics) Callback quando um caso de teste é encerrado.
abstract void	onTestFail(DeviceMetricData testData, TestDescription test) Callback quando um caso de teste falha.
default void	onTestModuleEnded() Permite capturar o evento de término do módulo.
default void	onTestModuleStarted() Permite capturar o evento de início do módulo.
abstract void	onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics) Callback quando a execução de um teste é encerrada.
abstract void	onTestRunStart(DeviceMetricData runData) Callback quando a execução de um teste é iniciada.
default void	onTestRunStart(DeviceMetricData runData, int testCount) Callback quando a execução de um teste é iniciada.
default void	onTestRunStartBlocking() Callback explícito para iniciar um coletor manualmente, se ele for compatível.
abstract void	onTestStart(DeviceMetricData testData) Callback quando um caso de teste é iniciado.
default void	setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level) Define o nível em que o coletor deve coletar registros, independentemente de falhas.
default void	setModuleContainsFailure() Define se o módulo teve falhas (caso de teste, execução de teste).
default void	setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level) Define o nível em que o coletor deve coletar registros durante falhas.

Métodos públicos

captureModuleLevel

public boolean captureModuleLevel ()

Indica se o coletor é aplicável à captura no nível do módulo e precisa ser inicializado.

Retorna
boolean

doesModuleContainFailure

public boolean doesModuleContainFailure ()

Retorna "true" se o módulo atual tiver falhas em casos de teste ou execuções de teste.

Retorna
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

Permite que os coletores ativem a coleta de métricas padrão. Quando a coleta de métricas padrão está ativada, o coletor só coleta no nível especificado.

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

Retorna
IMetricCollector.MetricCollectionLevel

getBuildInfos

public abstract List<IBuildInfo> getBuildInfos ()

Retorna a lista de informações de build disponíveis na invocação.

Retorna
List<IBuildInfo>

getDevices

public abstract List<ITestDevice> getDevices ()

Retorna a lista de dispositivos disponíveis na invocação.

Retorna
List<ITestDevice>

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

Retorna o ITestInvocationListener original para onde estamos encaminhando os resultados.

Retorna
ITestInvocationListener

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

Retorna
IMetricCollector.MetricCollectionLevel

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

Inicialização do coletor com o contexto atual e onde encaminhar os resultados. Será chamado apenas uma vez por instância, e o coletor deverá atualizar o contexto e o listener internos. Init nunca será chamado durante um teste, sempre antes.

Não substitua, a menos que você saiba o que está fazendo.

Parâmetros
context	IInvocationContext: o IInvocationContext da invocação em andamento.
listener	ITestInvocationListener: o ITestInvocationListener onde colocar os resultados.

Retorna
ITestInvocationListener	o novo listener envolvendo o original.

Gera
DeviceNotAvailableException

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

Indica se o coletor está coletando métricas como parte da coleta de métricas padrão.

Retorna
boolean

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Callback quando um caso de teste falha devido a uma falha de proposição.

Parâmetros
testData	DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste.
test	TestDescription: o TestDescription do caso de teste em andamento.

Gera
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, 
                TestDescription test)

Callback quando um caso de teste é encerrado. Esse é o momento de fazer a limpeza.

Parâmetros
testData	DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste. Será o mesmo objeto em onTestStart(DeviceMetricData).
currentTestCaseMetrics	Map: o mapa atual de métricas transmitidas para testEnded(TestDescription,Map).
test	TestDescription: o TestDescription do caso de teste em andamento.

Gera
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

Callback quando um caso de teste é encerrado. Esse é o momento de fazer a limpeza.

Parâmetros
testData	DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste. Será o mesmo objeto em onTestStart(DeviceMetricData).
currentTestCaseMetrics	Map: o mapa atual de métricas transmitidas para testEnded(TestDescription,Map).

Gera
DeviceNotAvailableException

onTestFail

public abstract void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Callback quando um caso de teste falha.

Parâmetros
testData	DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste.
test	TestDescription: o TestDescription do caso de teste em andamento.

Gera
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

Permite capturar o evento de término do módulo.

Gera
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

Permite capturar o evento de início do módulo.

Gera
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunEnd

public abstract void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

Callback quando a execução de um teste é encerrada. Esse é o momento de fazer a limpeza.

Parâmetros
runData	DeviceMetricData: o DeviceMetricData que contém os dados da execução. Será o mesmo objeto em onTestRunStart(DeviceMetricData).
currentRunMetrics	Map: o mapa atual de métricas transmitidas para testRunEnded(long,Map).

Gera
DeviceNotAvailableException

onTestRunStart

public abstract void onTestRunStart (DeviceMetricData runData)

Callback quando a execução de um teste é iniciada.

Parâmetros
runData	DeviceMetricData: o DeviceMetricData que contém os dados da execução.

Gera
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData, 
                int testCount)

Callback quando a execução de um teste é iniciada.

Parâmetros
runData	DeviceMetricData: o DeviceMetricData que contém os dados da execução.
testCount	int: o número de casos de teste nesta execução de teste.

Gera
DeviceNotAvailableException

onTestRunStartBlocking

public void onTestRunStartBlocking ()

Callback explícito para iniciar um coletor manualmente, se ele for compatível. Isso garante que estamos fora de algum ciclo de vida de teste assíncrono.

Gera
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

Callback quando um caso de teste é iniciado.

Parâmetros
testData	DeviceMetricData: o DeviceMetricData que contém os dados do caso de teste.

Gera
DeviceNotAvailableException

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Define o nível em que o coletor deve coletar registros, independentemente de falhas.

O nível NULL não resulta em coleta.

Parâmetros
level	IMetricCollector.MetricCollectionLevel: MetricCollectionLevel em que os registros serão coletados.

setModuleContainsFailure

public void setModuleContainsFailure ()

Define se o módulo teve falhas (caso de teste, execução de teste).

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Define o nível em que o coletor deve coletar registros durante falhas.

O nível NULL não resulta em coleta.

Parâmetros
level	IMetricCollector.MetricCollectionLevel: MetricCollectionLevel em que os registros serão coletados.