Visitar URL original
SplunkLayout - Restore SplunkEvents but as obsolete by snakefoot · Pull Request #5950 · NLog/NLog · GitHub
Skip to content

SplunkLayout - Restore SplunkEvents but as obsolete - #5950

Merged
snakefoot merged 1 commit into
NLog:devfrom
snakefoot:splunk_obsolete
Jul 27, 2025
Merged

SplunkLayout - Restore SplunkEvents but as obsolete#5950
snakefoot merged 1 commit into
NLog:devfrom
snakefoot:splunk_obsolete

Conversation

@snakefoot

@snakefoot snakefoot commented Jul 27, 2025

Copy link
Copy Markdown
Contributor

Followup to #5940 + #5926

@snakefoot snakefoot added enhancement Improvement on existing feature network/NLogViewer-target labels Jul 27, 2025
@coderabbitai

coderabbitai Bot commented Jul 27, 2025 •
edited
Loading

Copy link
Copy Markdown

Walkthrough

Multiple obsolete members across various classes and enums were updated by adding the [EditorBrowsable(EditorBrowsableState.Never)] attribute to hide them from IntelliSense and editor browsing tools. Additionally, a new obsolete property SplunkEvents was added as an alias to SplunkFields in SplunkLayout. No other logic or control flow changes were made.

Changes

File(s) Change Summary
src/NLog.Targets.Network/Layouts/SplunkLayout.cs Added obsolete property SplunkEvents as an alias for SplunkFields, with [Obsolete], [ArrayParameter], and [EditorBrowsable] attributes.
src/NLog.Targets.WebService/WebServiceTarget.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete property EscapeDataRfc3986.
src/NLog/Config/RequiredParameterAttribute.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to RequiredParameterAttribute class.
src/NLog/Config/StackTraceUsage.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete enum member WithoutSource.
src/NLog/Config/XmlLoggingConfiguration.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to three obsolete constructors accepting XmlReader.
src/NLog/LayoutRenderers/FuncLayoutRenderer.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete property RenderMethod.
src/NLog/LayoutRenderers/ScopeContextTimingLayoutRenderer.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete property ScopeBeginTime.
src/NLog/LayoutRenderers/Wrappers/WrapperLayoutRendererBuilderBase.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete class WrapperLayoutRendererBuilderBase.
src/NLog/Layouts/LayoutRenderOptions.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete enum member ThreadSafe.
src/NLog/Layouts/SimpleLayout.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete static method Escape(string).
src/NLog/LogEventInfo.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete members: UserStackFrame, UserStackFrameNumber, and SetStackTrace.
src/NLog/LogManager.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete static method AddHiddenAssembly.
src/NLog/MappedDiagnosticsContext.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete static class MappedDiagnosticsContext.
src/NLog/MappedDiagnosticsLogicalContext.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete static class MappedDiagnosticsLogicalContext.
src/NLog/NestedDiagnosticsContext.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete static class NestedDiagnosticsContext.
src/NLog/NestedDiagnosticsLogicalContext.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete static class NestedDiagnosticsLogicalContext.
src/NLog/Targets/ConsoleTarget.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete property WriteBuffer.
src/NLog/Targets/FileTarget.cs Added [EditorBrowsable(EditorBrowsableState.Never)] to obsolete properties ArchiveDateFormat and ArchiveNumbering.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

Obsolete whispers softly hide away,
From IntelliSense’s bright display.
SplunkEvents hops with alias cheer,
While hidden marks make code more clear.
A rabbit’s nod to tidy code,
As old paths gently unload.
🐇✨🥕

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cdf404e and fc26577.

📒 Files selected for processing (18)
  • src/NLog.Targets.Network/Layouts/SplunkLayout.cs (2 hunks)
  • src/NLog.Targets.WebService/WebServiceTarget.cs (1 hunks)
  • src/NLog/Config/RequiredParameterAttribute.cs (2 hunks)
  • src/NLog/Config/StackTraceUsage.cs (2 hunks)
  • src/NLog/Config/XmlLoggingConfiguration.cs (3 hunks)
  • src/NLog/LayoutRenderers/FuncLayoutRenderer.cs (2 hunks)
  • src/NLog/LayoutRenderers/ScopeContextTimingLayoutRenderer.cs (2 hunks)
  • src/NLog/LayoutRenderers/Wrappers/WrapperLayoutRendererBuilderBase.cs (2 hunks)
  • src/NLog/Layouts/LayoutRenderOptions.cs (2 hunks)
  • src/NLog/Layouts/SimpleLayout.cs (1 hunks)
  • src/NLog/LogEventInfo.cs (2 hunks)
  • src/NLog/LogManager.cs (1 hunks)
  • src/NLog/MappedDiagnosticsContext.cs (2 hunks)
  • src/NLog/MappedDiagnosticsLogicalContext.cs (2 hunks)
  • src/NLog/NestedDiagnosticsContext.cs (2 hunks)
  • src/NLog/NestedDiagnosticsLogicalContext.cs (2 hunks)
  • src/NLog/Targets/ConsoleTarget.cs (1 hunks)
  • src/NLog/Targets/FileTarget.cs (3 hunks)
✅ Files skipped from review due to trivial changes (11)
  • src/NLog/MappedDiagnosticsLogicalContext.cs
  • src/NLog/LayoutRenderers/Wrappers/WrapperLayoutRendererBuilderBase.cs
  • src/NLog/LayoutRenderers/ScopeContextTimingLayoutRenderer.cs
  • src/NLog/Config/RequiredParameterAttribute.cs
  • src/NLog/NestedDiagnosticsContext.cs
  • src/NLog/LogManager.cs
  • src/NLog/Targets/ConsoleTarget.cs
  • src/NLog.Targets.WebService/WebServiceTarget.cs
  • src/NLog/Targets/FileTarget.cs
  • src/NLog/Config/XmlLoggingConfiguration.cs
  • src/NLog/Layouts/LayoutRenderOptions.cs
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/NLog.Targets.Network/Layouts/SplunkLayout.cs
🔇 Additional comments (8)
src/NLog/NestedDiagnosticsLogicalContext.cs (1)

37-37: LGTM: Properly hiding obsolete class from IntelliSense

The addition of the System.ComponentModel using statement and [EditorBrowsable(EditorBrowsableState.Never)] attribute correctly hides this obsolete class from editor tooling while maintaining backward compatibility.

Also applies to: 48-48

src/NLog/Config/StackTraceUsage.cs (1)

37-37: LGTM: Consistently hiding obsolete enum member

The System.ComponentModel using directive and [EditorBrowsable(EditorBrowsableState.Never)] attribute are correctly applied to hide the obsolete WithoutSource enum member from editor tooling.

Also applies to: 74-74

src/NLog/MappedDiagnosticsContext.cs (1)

38-38: LGTM: Consistent application of EditorBrowsable pattern

The changes correctly add the necessary using statement and hide the obsolete MappedDiagnosticsContext class from IntelliSense, consistent with the broader effort to improve developer experience with deprecated APIs.

Also applies to: 49-49

src/NLog/Layouts/SimpleLayout.cs (1)

210-210: LGTM: Properly hiding obsolete static method

The [EditorBrowsable(EditorBrowsableState.Never)] attribute is correctly applied to hide the obsolete Escape method from editor tooling, maintaining the consistent pattern across the codebase.

src/NLog/LayoutRenderers/FuncLayoutRenderer.cs (1)

37-37: LGTM: Hiding mistaken public API property

The addition of System.ComponentModel using statement and [EditorBrowsable(EditorBrowsableState.Never)] attribute correctly hides the obsolete RenderMethod property that was acknowledged as a public API mistake.

Also applies to: 80-80

src/NLog/LogEventInfo.cs (3)

264-264: LGTM - Correctly hiding obsolete property from IntelliSense.

The [EditorBrowsable(EditorBrowsableState.Never)] attribute is properly applied to the obsolete UserStackFrame property, which will hide it from editor suggestions while maintaining backward compatibility.

272-272: LGTM - Correctly hiding obsolete property from IntelliSense.

The [EditorBrowsable(EditorBrowsableState.Never)] attribute is properly applied to the obsolete UserStackFrameNumber property, which will hide it from editor suggestions while maintaining backward compatibility.

605-605: LGTM - Correctly hiding obsolete method from IntelliSense.

The [EditorBrowsable(EditorBrowsableState.Never)] attribute is properly applied to the obsolete SetStackTrace method overload, which will hide it from editor suggestions while maintaining backward compatibility.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@snakefoot snakefoot closed this Jul 27, 2025
@snakefoot snakefoot reopened this Jul 27, 2025
@snakefoot snakefoot closed this Jul 27, 2025
@snakefoot snakefoot reopened this Jul 27, 2025
@sonarqubecloud

sonarqubecloud Bot commented Jul 27, 2025

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@snakefoot
snakefoot merged commit abc9507 into NLog:dev Jul 27, 2025
@snakefoot snakefoot added this to the 6.0.3 milestone Aug 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement Improvement on existing feature network/NLogViewer-target size/M

Projects

None yet

Milestone

6.0.3

Development

Successfully merging this pull request may close these issues.

1 participant

@snakefoot