Documentation / test-reporting / fetchAppAutomateLogs

Function: fetchAppAutomateLogs()

fetchAppAutomateLogs(app, session, sessionId, wanted): Promise<SessionLogs>

Defined in: test-reporting/src/linked-sessions.ts:187

Fetches the wanted log kinds for an App Automate session. Its logs live under the App Automate build id.

Parameters

Parameter	Type	Description
app	AppAutomateClient	-
session	{ appDetails: { appCustomId?: string; appFilename?: string; appName?: string; appUrl?: string; appVersion?: string; uploadedAt?: string; }; appiumLogsUrl?: string; browser: string | null; browserConsoleLogsUrl?: string; browserstackStatus: string; browserUrl: string; browserVersion: string; buildHashedId?: string; buildName: string; buildTerminalLogsUrl?: string; createdAt: string; device?: string; deviceLogsUrl?: string; duration: number; harLogsUrl?: string; hashedId: string; insights?: {[key: string]: unknown; }; logs: string; name: string; os: string; osVersion: string; projectName: string; publicUrl: string; realMobile?: boolean; reason: string; seleniumLogsUrl?: string; seleniumTelemetryLogsUrl?: string; sessionTerminalLogsUrl?: string; status: "done" | "running" | "timeout" | "failed" | "passed"; testPriority?: string | null; videoUrl: string; }	-
session.appDetails	{ appCustomId?: string; appFilename?: string; appName?: string; appUrl?: string; appVersion?: string; uploadedAt?: string; }	-
session.appDetails.appCustomId?	string	-
session.appDetails.appFilename?	string	File name of the uploaded app (verified live, e.g. WikipediaSample.apk).
session.appDetails.appName?	string	Package name of the app Example com.sample.loginapplication
session.appDetails.appUrl?	string	-
session.appDetails.appVersion?	string	-
session.appDetails.uploadedAt?	string	-
session.appiumLogsUrl?	string	URL to view the Appium logs Example https://api.browserstack.com/automate/builds/5343932818f9330c5d2b5c72aaf9dd8fde77b428/sessions/550709149fe79e949363b581e774d5ebffa1b8fe/appiumlogs
session.browser	string | null	Null for App Automate sessions (verified live), which have no browser. Example Chrome
session.browserConsoleLogsUrl?	string	URL to view browser console logs Example https://automate.browserstack.com/s3-upload/bs-selenium-logs-aps/s3.ap-south-1/550709149fe79e949363b581e774d5ebffa1b8fe/550709149fe79e949363b581e774d5ebffa1b8fe-console-logs-v2.txt
session.browserstackStatus	string	Execution status of the session. Observed live: done, failed, passed.
session.browserUrl	string	URL to view the session on Automate dashboard Example https://automate.browserstack.com/builds/5343932818f9330c5d2b5c72aaf9dd8fde77b428/sessions/550709149fe79e949363b581e774d5ebffa1b8fe
session.browserVersion	string	Example 80.0
session.buildHashedId?	string	Hashed ID of the Automate build this session belongs to. This is the Automate build id, not the Test Reporting build id. Example 5a2325a471c829812cd32ed5e63fdc5f8d2c0250
session.buildName	string	Name of the build Example pricing_project_build
session.buildTerminalLogsUrl?	string	Presigned URL of the build's terminal logs.
session.createdAt	string	Timestamp at which the session started executing Example 2020-03-11T10:14:36.000Z
session.device?	string	Example null
session.deviceLogsUrl?	string	URL of the device logs.
session.duration	number	Duration of session execution Example 10
session.harLogsUrl?	string	URL to view browser logs Example https://automate.browserstack.com/s3-upload/bs-selenium-logs-euw/s3.eu-west-1/550709149fe79e949363b581e774d5ebffa1b8fe/550709149fe79e949363b581e774d5ebffa1b8fe-har-logs.txt
session.hashedId	string	Hashed ID of the session Example 4207442b2b0567368956dba064c22a3235a76214
session.insights?	{[key: string]: unknown; }	Time breakdown for the session (totals, BrowserStack vs user time, and optimisation links).
session.logs	string	Link to the session logs Example https://automate.browserstack.com/builds/5343932818f9330c5d2b5c72aaf9dd8fde77b428/sessions/550709149fe79e949363b581e774d5ebffa1b8fe/logs
session.name	string	Name of your session Example pricing_project_build
session.os	string	Example Windows
session.osVersion	string	Example 10
session.projectName	string	Name of the project Example pricing_project
session.publicUrl	string	URL to view the session publicly Example https://automate.browserstack.com/builds/5343932818f9330c5d2b5c72aaf9dd8fde77b428/sessions/550709149fe79e949363b581e774d5ebffa1b8fe?auth_token=01df4e51ba67eb743484a08b024a44601a2ae0399c5c011a68d9564147be1387
session.realMobile?	boolean	Example null
session.reason	string	Reason for test status Example CLIENT_STOPPED_SESSION
session.seleniumLogsUrl?	string	URL to view selenium logs Example https://automate.browserstack.com/s3-upload/bs-selenium-logs-euw/s3.eu-west-1/550709149fe79e949363b581e774d5ebffa1b8fe/550709149fe79e949363b581e774d5ebffa1b8fe-selenium-logs.txt
session.seleniumTelemetryLogsUrl?	string	URL to view telemetry logs if it is enabled in your Selenium 4 session Example https://automate.browserstack.com/s3-upload/bs-selenium-logs-euw/s3.eu-west-1/550709149fe79e949363b581e774d5ebffa1b8fe/550709149fe79e949363b581e774d5ebffa1b8fe-selenium-logs.txt
session.sessionTerminalLogsUrl?	string	Presigned URL of the session's terminal logs.
session.status	"done" | "running" | "timeout" | "failed" | "passed"	Outcome of the session. Observed live on Automate and App Automate: passed, failed. running and timeout are documented but not yet observed; done is a browserstack_status value, not a status.
session.testPriority?	string | null	Priority label set on the session, if any.
session.videoUrl	string	URL to view session video Example https://automate.browserstack.com/sessions/550709149fe79e949363b581e774d5ebffa1b8fe/video
sessionId	string	-
wanted	LogKind[]	-

Returns

Promise<SessionLogs>