Skip to content

docs: deprecate Logger api #35978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/src/api/class-browsertype.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ can see what is going on. Defaults to 0.
### option: BrowserType.connect.logger
* since: v1.14
* langs: js
* deprecated: The logs received by the logger are incomplete. Please use tracing instead.
- `logger` <[Logger]>

Logger sink for Playwright logging. Optional.
Expand Down Expand Up @@ -201,10 +202,9 @@ A CDP websocket endpoint or http url to connect to. For example `http://localhos
### option: BrowserType.connectOverCDP.endpointURL
* since: v1.14
* langs: js
* deprecated: Use the first argument instead.
- `endpointURL` <[string]>

Deprecated, use the first argument instead. Optional.

### option: BrowserType.connectOverCDP.headers
* since: v1.11
- `headers` <[Object]<[string], [string]>>
Expand All @@ -221,6 +221,7 @@ can see what is going on. Defaults to 0.
### option: BrowserType.connectOverCDP.logger
* since: v1.14
* langs: js
* deprecated: The logs received by the logger are incomplete. Please use tracing instead.
- `logger` <[Logger]>

Logger sink for Playwright logging. Optional.
Expand Down
1 change: 1 addition & 0 deletions docs/src/api/class-logger.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# class: Logger
* since: v1.8
* langs: js
* deprecated: This class is deprecated. The logs pumped through this class are incomplete. Please use tracing instead.

Playwright generates a lot of logs and they are accessible via the pluggable logger sink.

Expand Down
2 changes: 2 additions & 0 deletions docs/src/api/params.md
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,7 @@ Emulates `'prefers-contrast'` media feature, supported values are `'no-preferenc

## context-option-logger
* langs: js
* deprecated: The logs received by the logger are incomplete. Please use tracing instead.
- `logger` <[Logger]>

Logger sink for Playwright logging.
Expand Down Expand Up @@ -1084,6 +1085,7 @@ You can also provide a path to a custom [`policies.json` file](https://mozilla.g

## browser-option-logger
* langs: js
* deprecated: The logs received by the logger are incomplete. Please use tracing instead.
- `logger` <[Logger]>

Logger sink for Playwright logging.
Expand Down
10 changes: 9 additions & 1 deletion packages/playwright-client/types/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9882,6 +9882,7 @@ export interface Browser {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -15018,6 +15019,7 @@ export interface BrowserType<Unused = {}> {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -15372,6 +15374,7 @@ export interface BrowserType<Unused = {}> {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -16774,6 +16777,7 @@ export interface AndroidDevice {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -21775,6 +21779,7 @@ export interface LaunchOptions {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -21824,7 +21829,7 @@ export interface LaunchOptions {

export interface ConnectOverCDPOptions {
/**
* Deprecated, use the first argument instead. Optional.
* @deprecated Use the first argument instead.
*/
endpointURL?: string;

Expand All @@ -21835,6 +21840,7 @@ export interface ConnectOverCDPOptions {

/**
* Logger sink for Playwright logging. Optional.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -21876,6 +21882,7 @@ export interface ConnectOptions {

/**
* Logger sink for Playwright logging. Optional.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -22158,6 +22165,7 @@ export interface BrowserContextOptions {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down
10 changes: 9 additions & 1 deletion packages/playwright-core/types/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9882,6 +9882,7 @@ export interface Browser {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -15018,6 +15019,7 @@ export interface BrowserType<Unused = {}> {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -15372,6 +15374,7 @@ export interface BrowserType<Unused = {}> {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -16774,6 +16777,7 @@ export interface AndroidDevice {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -21775,6 +21779,7 @@ export interface LaunchOptions {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -21824,7 +21829,7 @@ export interface LaunchOptions {

export interface ConnectOverCDPOptions {
/**
* Deprecated, use the first argument instead. Optional.
* @deprecated Use the first argument instead.
*/
endpointURL?: string;

Expand All @@ -21835,6 +21840,7 @@ export interface ConnectOverCDPOptions {

/**
* Logger sink for Playwright logging. Optional.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -21876,6 +21882,7 @@ export interface ConnectOptions {

/**
* Logger sink for Playwright logging. Optional.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down Expand Up @@ -22158,6 +22165,7 @@ export interface BrowserContextOptions {

/**
* Logger sink for Playwright logging.
* @deprecated The logs received by the logger are incomplete. Please use tracing instead.
*/
logger?: Logger;

Expand Down
Loading