From a4f52f5632f4f24a095c3bc7078d34ca67bc7fad Mon Sep 17 00:00:00 2001 From: Junhao Liao Date: Sun, 24 Nov 2024 22:03:05 -0500 Subject: [PATCH] Drop the "Generating IR Stream Logs", "How does it work?", and "Features in Development" sections in README.md. --- README.md | 39 --------------------------------------- 1 file changed, 39 deletions(-) diff --git a/README.md b/README.md index 321f218b..640bbd53 100644 --- a/README.md +++ b/README.md @@ -24,29 +24,6 @@ features. * To open an IR stream, drag and drop it onto the log viewer or use the open file dialog. -# Generating IR Stream Logs - -IR stream log files can currently be generated using these libraries: - -* [Log4j Logging Library][log4j1-appenders] -* [Logback Logging Library][logback-appenders] -* [Python Logging Library][clp-loglib-py] -* Golang Logging Library (in development) - -# How does it work? - -The log viewer is written using the ReactJS framework and uses the open source -[monaco-editor] and [clp-ffi-js]. - -The viewer spawns a worker to assist with computationally intensive tasks such -as: - -* Deserializing the file and creating an index of logs events. -* Paginating the indexed logs. -* Decoding the deserialized log events into plain text. - -Tasks are passed to the worker as needed and changes are rendered in the UI. - # Providing Feedback You can use GitHub issues to [report a bug][bug-report] or @@ -58,30 +35,14 @@ Join us on [Zulip][zulip] to chat with developers and other community members. See the docs in our [developer guide](docs/dev-guide). -# Features in Development - -* Pretty printing to enhance the readability of structured data in the logs. -* A dashboard to visualize the distribution of log types and log levels. -* Support for plain text, archived log files, and other requested formats. -* Searching within a file, multiple files, or within provided time ranges. -* Infinite scrolling instead of pagination. -* Log correlation with sync by timestamp across multiple editors. -* Automatic conversion of text log files to IR stream format in the browser. -* Deployment of components via NPM. - [bug-report]: https://github.com/y-scope/yscope-log-viewer/issues/new?labels=bug&template=bug-report.yml [bugs-shield]: https://img.shields.io/github/issues/y-scope/yscope-log-viewer/bug?label=bugs -[clp-ffi-js]: https://github.com/y-scope/clp-ffi-js -[clp-loglib-py]: https://github.com/y-scope/clp-loglib-py [clp-repo]: https://github.com/y-scope/clp [datasets]: https://docs.yscope.com/clp/main/user-guide/resources-datasets [bug-report]: https://github.com/y-scope/yscope-log-viewer/issues/new?labels=bug&template=bug-report.yml [feature-req]: https://github.com/y-scope/yscope-log-viewer/issues/new?labels=enhancement&template=feature-request.yml [feature-requests-shield]: https://img.shields.io/github/issues/y-scope/yscope-log-viewer/enhancement?label=feature-requests [hive-24hrs]: https://zenodo.org/records/7094921#.Y5JbH33MKHs -[log4j1-appenders]: https://github.com/y-scope/log4j1-appenders -[logback-appenders]: https://github.com/y-scope/logback-appenders -[monaco-editor]: https://microsoft.github.io/monaco-editor/ [online-demo]: https://y-scope.github.io/yscope-log-viewer/?filePath=https://yscope.s3.us-east-2.amazonaws.com/sample-logs/yarn-ubuntu-resourcemanager-ip-172-31-17-135.log.1.clp.zst [zulip]: https://yscope-clp.zulipchat.com/ [zulip-shield]: https://img.shields.io/badge/zulip-yscope--clp%20chat-1888FA?logo=zulip