feat(core-interfaces): Add info and essential log levels to LogLevel by MarioJGMsoft · Pull Request #26947 · microsoft/FluidFramework

MarioJGMsoft · 2026-04-06T22:40:19Z

Description

Adds two new named log levels to the LogLevel constant in @fluidframework/core-interfaces:

info (20) — Session-level information that may be omitted in some sessions if needed (e.g. to reduce overall telemetry volume), but if any are collected in a session, all should be.
essential (30) — Essential information about the operation of Fluid that should always be collected, even in production, for diagnostic purposes.

The existing default and error entries are preserved with their original numeric values but marked @deprecated, pointing callers toinfo and essential respectively. Because the numeric values are unchanged, existing callers that pass LogLevel.default or LogLevel.error will continue to work without modification.

Internal usages of the deprecated values have been updated; call sites now reference LogLevel.info and LogLevel.essential directly.

Expected Future Timeline

Removal of LogLevel.default and LogLevel.error is tracked in #26969 (expected in v3.0).

Reviewer Guidance

The review process is outlined on this wiki page.

The numeric values of the deprecated entries (default: 20, error: 30) are unchanged, so existing callers are unaffected.
No logger implementations are updated in this PR — only the LogLevel constant is extended.
Note: The @deprecated tags on default and error are not currently being picked up by the API reports, but they are detected by IntelliSense. Reviewers should keep this in mind when evaluating the API surface changes.

…pdate

Copilot

Pull request overview

Extends @fluidframework/core-interfaces’ LogLevel constant to introduce clearer named levels (info, essential) while keeping backward compatibility via deprecated aliases (default, error).

Changes:

Add LogLevel.info (20) and LogLevel.essential (30) with expanded documentation.
Deprecate LogLevel.default and LogLevel.error while preserving their numeric values.

jason-ha

This doesn't trigger a lot of deprecation warnings/errors in FF codebase?
I would expect this change to retain more of the changes you had in #26789. How much of that can you keep without changing ITelemetryLoggerExt?

jason-ha · 2026-04-07T21:14:36Z

+	/**
+	 * Value to assume when not otherwise given.
+	 * @see {@link (LogLevel:variable).info}
+	 * @deprecated Use {@link (LogLevel:variable).info} to preserve prior treatment.


Deprecations should have an associated issue. These look like they should be associated with 3.0 breaks to note removal timeframe.
See https://github.com/microsoft/FluidFramework/wiki/API-Deprecation

Updated the file to follow the deprecation docs properly.

markfields · 2026-04-09T18:34:30Z

 	private shouldFilterOutEvent(event: ITelemetryBaseEvent, logLevel?: LogLevel): boolean {
-		const eventLogLevel = logLevel ?? LogLevel.default;
-		const configLogLevel = this.baseLogger.minLogLevel ?? LogLevel.default;
+		const eventLogLevel = logLevel ?? LogLevel.essential;


Let's leave this as info in this PR so there's no behavior change. A follow-up PR can make the one-line switch.

Applied change

markfields · 2026-04-09T18:34:56Z

 	 */
 	public send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void {
-		if ((logLevel ?? LogLevel.default) >= this.minLogLevel) {
+		if ((logLevel ?? LogLevel.essential) >= this.minLogLevel) {


Let's leave this as info for this PR to avoid behavior change, and include this one-line change in a follow-up

Applied change

markfields · 2026-04-09T18:35:29Z

 		event: ITelemetryPerformanceEventExt,
 		error?: unknown,
-		logLevel: typeof LogLevel.verbose | typeof LogLevel.default = LogLevel.default,
+		logLevel?: typeof LogLevel.verbose | typeof LogLevel.info,


You're going to restore this default value of info right?

Yes, I restored it

markfields · 2026-04-09T18:36:03Z

+								configValue: JSON.stringify(parsed),
+							}),
+						},
+						LogLevel.essential,


I'd leave this behavior change out of this PR

Applied change

markfields · 2026-04-09T18:36:54Z

 		content.details = event.details;
 	}
-	log(`[${logLevel ?? LogLevel.default}]`, content);
+	log(`[${logLevel ?? "unspecified"}]`, content);


Is this change necessary? What's the intent?

This was something that was brought up in the previous PR, where Jason pointed out that this change could be done: Original comment. I'll make it's own PR for it

Actually, this change needs to go in this PR because it's using LogLevel.default

markfields · 2026-04-09T18:37:13Z

+				eventName: "DeviceSpec",
+				...getDeviceSpec(),
+			},
+			LogLevel.essential,


I'd avoid any behavior change in this PR

Applied change

markfields · 2026-04-09T18:37:41Z

+			count: blobManagerLoadInfo.ids?.length ?? 0,
+			redirectTable: blobManagerLoadInfo.redirectTable?.length,
+		},
+		undefined,


nit: add comment with param name

markfields · 2026-04-09T18:38:25Z

+						message:
+							"Legacy document, SharedMap is masquerading as SharedDirectory in DataObject",
+					},
+					LogLevel.essential,


Behavior change - do in subsequent PR

Applied change

markfields

Once you remove all behavior changes and leave this PR as rename-only (including updating function signatures is ok) I'll approve. Then a very small scoped PR with all the behavior changes can come right after and we can more easily reason over those changes.

markfields · 2026-04-09T23:05:18Z

 	 * @param logLevel - optional level of the log. It category of event is set as error,
 	 * then the logLevel will be upgraded to be an error.
+	 *
+	 * @remarks The default value for logLevel will be updated to {@link @fluidframework/core-interfaces#LogLevel.essential} once issue #26910 is resolved.


I really believe we can update the default of the implementation without touching the API, and thus don't need to wait on that issue. But I don't mind if you put this comment here anyway, just saying.

I removed the issue part of the comment but I still think I should leave the remark to let people know that the change is happening and they should be aware of it.

markfields

Ship it!

github-actions · 2026-04-10T17:33:38Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  278943 links
    1879 destination URLs
    2124 URLs ignored
       0 warnings
       0 errors

Josmithr

Docs and API changes look good!

…ogLevel" (#27005) Reverts #26947 because it broke the integration pipeline. Need to stage the change somehow.

…icrosoft#26947) ## Description Adds two new named log levels to the `LogLevel` constant in `@fluidframework/core-interfaces`: - **`info` (20)** — Session-level information that may be omitted in some sessions if needed (e.g. to reduce overall telemetry volume), but if any are collected in a session, all should be. - **`essential` (30)** — Essential information about the operation of Fluid that should always be collected, even in production, for diagnostic purposes. The existing `default` and `error` entries are preserved with their original numeric values but marked `@deprecated`, pointing callers to`info` and `essential` respectively. Because the numeric values are unchanged, existing callers that pass `LogLevel.default` or `LogLevel.error` will continue to work without modification. Internal usages of the deprecated values have been updated; call sites now reference `LogLevel.info` and `LogLevel.essential` directly. ### Expected Future Timeline Removal of `LogLevel.default` and `LogLevel.error` is tracked in microsoft#26969 (expected in v3.0). ## Reviewer Guidance The review process is outlined on [this wiki page](https://github.com/microsoft/FluidFramework/wiki/PR-Guidelines#guidelines). - The numeric values of the deprecated entries (`default: 20`, `error: 30`) are unchanged, so existing callers are unaffected. - No logger implementations are updated in this PR — only the `LogLevel` constant is extended. - **Note:** The `@deprecated` tags on `default` and `error` are not currently being picked up by the API reports, but they are detected by IntelliSense. Reviewers should keep this in mind when evaluating the API surface changes.

…ogLevel" (microsoft#27005) Reverts microsoft#26947 because it broke the integration pipeline. Need to stage the change somehow.

…icrosoft#26947) ## Description Adds two new named log levels to the `LogLevel` constant in `@fluidframework/core-interfaces`: - **`info` (20)** — Session-level information that may be omitted in some sessions if needed (e.g. to reduce overall telemetry volume), but if any are collected in a session, all should be. - **`essential` (30)** — Essential information about the operation of Fluid that should always be collected, even in production, for diagnostic purposes. The existing `default` and `error` entries are preserved with their original numeric values but marked `@deprecated`, pointing callers to`info` and `essential` respectively. Because the numeric values are unchanged, existing callers that pass `LogLevel.default` or `LogLevel.error` will continue to work without modification. Internal usages of the deprecated values have been updated; call sites now reference `LogLevel.info` and `LogLevel.essential` directly. ### Expected Future Timeline Removal of `LogLevel.default` and `LogLevel.error` is tracked in microsoft#26969 (expected in v3.0). ## Reviewer Guidance The review process is outlined on [this wiki page](https://github.com/microsoft/FluidFramework/wiki/PR-Guidelines#guidelines). - The numeric values of the deprecated entries (`default: 20`, `error: 30`) are unchanged, so existing callers are unaffected. - No logger implementations are updated in this PR — only the `LogLevel` constant is extended. - **Note:** The `@deprecated` tags on `default` and `error` are not currently being picked up by the API reports, but they are detected by IntelliSense. Reviewers should keep this in mind when evaluating the API surface changes.

MarioJGMsoft added 2 commits April 6, 2026 18:28

feat: added new info and essential values to LogLevel

39098a7

Merge remote-tracking branch 'origin/main' into marioja/LogLevelBaseU…

6b94dcf

…pdate

Copilot AI review requested due to automatic review settings April 6, 2026 22:40

Copilot started reviewing on behalf of MarioJGMsoft April 6, 2026 22:41 View session

Copilot AI reviewed Apr 6, 2026

View reviewed changes

Comment thread packages/common/core-interfaces/src/logger.ts Outdated

feat: updated api.md's

ece7c02

MarioJGMsoft requested a review from a team as a code owner April 6, 2026 22:56

docs: fixed unnecesarry comment

23ebb02

jason-ha reviewed Apr 7, 2026

View reviewed changes

Merge branch 'main' into marioja/LogLevelBaseUpdate

d94c06f

MarioJGMsoft mentioned this pull request Apr 7, 2026

Remove deprecated LogLevel.default and LogLevel.error #26969

Open

MarioJGMsoft marked this pull request as draft April 7, 2026 23:11

MarioJGMsoft added 8 commits April 7, 2026 23:21

feat: added new logLevel values

cc3386f

fix: fixed failing build

01f622e

fix: removed unnecessary call to LogLevel

118fd64

docs: reverted default comment

836a899

Merge branch 'main' into marioja/LogLevelBaseUpdate

c52caa9

fix: change minLogLevel from essential to info for compat reasons

404e8dd

fix: updated default to .info for compatibility purposes

59d4bb7

test: updated test

7324872

markfields reviewed Apr 9, 2026

View reviewed changes

Merge branch 'main' into marioja/LogLevelBaseUpdate

13d82d6

MarioJGMsoft added 3 commits April 9, 2026 19:03

feat: turned PR into naming only PR

48d6b82

docs: updated comments based on feedback

9d79c1e

Merge branch 'main' into marioja/LogLevelBaseUpdate

d2fafda

markfields approved these changes Apr 9, 2026

View reviewed changes

MarioJGMsoft added 3 commits April 9, 2026 14:15

Merge branch 'main' into marioja/LogLevelBaseUpdate

e53642d

feat: updated comments, changeset and LogLevel.default call places

43b1680

feat: removed logLevel from new places and added changeset

4aa890f

MarioJGMsoft marked this pull request as ready for review April 9, 2026 22:50

MarioJGMsoft requested a review from a team as a code owner April 9, 2026 22:50

MarioJGMsoft marked this pull request as draft April 9, 2026 22:50

MarioJGMsoft added 2 commits April 9, 2026 22:53

docs: updated comments

06d316c

docs: updated comments for future plans

aa5af96

markfields reviewed Apr 9, 2026

View reviewed changes

markfields approved these changes Apr 9, 2026

View reviewed changes

docs: updated comments

ca62e2a

MarioJGMsoft marked this pull request as ready for review April 10, 2026 17:00

Josmithr reviewed Apr 10, 2026

View reviewed changes

Comment thread .changeset/tender-poems-float.md Outdated

Josmithr reviewed Apr 10, 2026

View reviewed changes

Comment thread packages/common/core-interfaces/src/logger.ts Outdated

docs: updated comments

c6ae5e7

Josmithr approved these changes Apr 10, 2026

View reviewed changes

MarioJGMsoft merged commit 61e9b50 into microsoft:main Apr 10, 2026
35 checks passed

MarioJGMsoft deleted the marioja/LogLevelBaseUpdate branch April 10, 2026 20:43

github-actions bot mentioned this pull request Apr 10, 2026

Upcoming Release: FluidFramework v2.100.0 #22101

Open

alexvy86 mentioned this pull request Apr 13, 2026

Revert "feat(core-interfaces): Add info and essential log levels to LogLevel" #27005

Merged

alexvy86 added a commit that referenced this pull request Apr 13, 2026

Revert "feat(core-interfaces): Add info and essential log levels to L…

db787d8

…ogLevel" (#27005) Reverts #26947 because it broke the integration pipeline. Need to stage the change somehow.

Conversation

MarioJGMsoft commented Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Expected Future Timeline

Reviewer Guidance

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

jason-ha left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

markfields left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

markfields left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 10, 2026

linkcheck output

Uh oh!

Josmithr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

MarioJGMsoft commented Apr 6, 2026 •

edited

Loading