From 5e238fcb19f40310a14a115856d2532b75f0fdbd Mon Sep 17 00:00:00 2001
From: Yury Semikhatsky <yurys@chromium.org>
Date: Fri, 16 May 2025 10:27:17 -0700
Subject: [PATCH] docs: deprecate Logger api (#35978)

---
 docs/src/api/class-browsertype.md           |  5 +++--
 docs/src/api/class-logger.md                |  1 +
 docs/src/api/params.md                      |  2 ++
 packages/playwright-client/types/types.d.ts | 10 +++++++++-
 packages/playwright-core/types/types.d.ts   | 10 +++++++++-
 5 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md
index f970d4aef3..55014ad9a4 100644
--- a/docs/src/api/class-browsertype.md
+++ b/docs/src/api/class-browsertype.md
@@ -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.
@@ -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]>>
@@ -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.
diff --git a/docs/src/api/class-logger.md b/docs/src/api/class-logger.md
index 5ab4f3128a..bd32e7065d 100644
--- a/docs/src/api/class-logger.md
+++ b/docs/src/api/class-logger.md
@@ -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.
 
diff --git a/docs/src/api/params.md b/docs/src/api/params.md
index 2e448aeb68..d8278abd6a 100644
--- a/docs/src/api/params.md
+++ b/docs/src/api/params.md
@@ -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.
@@ -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.
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index 95b2fa6b15..8be78eea88 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index 95b2fa6b15..8be78eea88 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;
 
@@ -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;