search

y-scope / yscope-log-viewer

A tool that can be used to view logs compressed in CLP's IR Stream format.
Apache License 2.0
11 stars 12 forks source link

feat(formatter): Add YScope formatter for structured logs and remove Logback-style formatter. #123

Closed davemarco closed 1 week ago

davemarco commented 2 weeks ago

Description

Adds a new Yscope Formatter based on spec in notion.

The format string is parsed once in the formatter class constructor. For each placeholder, we create an object and store it in a class-level list. The object contains the field name, and a formatter for that field name. Each field formatter type has its own class. For now, we just have timestamp and round.

Afterwards, when log events are decoded, we iterate through array of placeholders to format the log event fields

Future Work

(1) We will need a way for users to see docs for new format string syntax in another PR. (2) Add support for default format string

Validation performed

Tested with test event in notion. 

{"@timestamp": 1427153388942,"level": "INFO","thread": 0,"latency_secs": 56.4,"a.bad.key{name}": "org.apache.hadoop.metrics2.impl.MetricsConfig: loaded properties from hadoop-metrics2.properties"}

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

This pull request introduces multiple changes across several files, primarily focusing on the transition from LogbackFormatter to YscopeFormatter in various decoder classes. The SettingsDialog component has an updated helperText to provide clearer guidance on JSON log event syntax. New utility functions and classes are introduced for handling Yscope format strings, including specific field formatters for rounding and timestamps. Additionally, the LogbackFormatter file has been removed, reflecting a shift in the logging formatting approach.

Changes

File Change Summary
src/components/modals/SettingsModal/SettingsDialog.tsx Updated helperText in CONFIG_FORM_FIELDS to provide a detailed description of JSON log event field placeholders and timestamp formatting.
src/services/decoders/ClpIrDecoder.ts Replaced LogbackFormatter with YscopeFormatter. Updated formatter instantiation and removed LogbackFormatter import.
src/services/decoders/JsonlDecoder/index.ts Replaced LogbackFormatter with YscopeFormatter. Updated formatter instantiation.
src/services/formatters/LogbackFormatter.ts Removed the entire LogbackFormatter file, including its class and associated methods.
src/typings/formatters.ts Replaced LogbackFormatterOptionsType with YscopeFormatterOptionsType. Introduced new interfaces and types for Yscope formatting, including regex patterns for parsing.
src/utils/config.ts Updated CONFIG_DEFAULT constant to modify the formatString property under CONFIG_KEY.DECODER_OPTIONS.
src/utils/js.ts Introduced getNestedJsonValue function to retrieve nested values from JSON objects based on a specified path.
src/services/formatters/YscopeFormatter/FieldFormatters/RoundFormatter.ts Added RoundFormatter class for formatting numerical values by rounding.
src/services/formatters/YscopeFormatter/FieldFormatters/TimestampFormatter.ts Added TimestampFormatter class for formatting timestamps based on a specified date-time pattern.
src/services/formatters/YscopeFormatter/index.ts Introduced YscopeFormatter class for formatting log events using YScope format strings.
src/services/formatters/YscopeFormatter/utils.ts Added utility functions for processing Yscope field formatting, including regex patterns and string manipulation functions.

Possibly related PRs

Suggested reviewers

[!WARNING]

Rate limit exceeded

@davemarco has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between c6c65a121cbc7396d4f2399350692fb0bf00e1df and 2bba5eea071a594bfc8586ad67d3f70c7e7e7038.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate unit testing code.` - `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
davemarco commented 1 week ago

Added support for edge case with an escaped backlash (double backslash) in front of a field placeholder. For example \\{placeholder} is a valid placeholder while \{placeholder} is not.

kirkrodrigues commented 1 week ago

Reminder to mention this fixes #86.