Add entry for codec-pretty #1967
Conversation
🤖 GitHub commentsJust comment with:
|
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the codec-pretty plugin to the Logstash codec plugins documentation. The change integrates the new codec into the existing plugin listing in alphabetical order between plain and protobuf.
Key changes:
- Added
codec-prettyentry to the plugins table with description and GitHub repository link - Added include statement for the pretty codec documentation following the same pattern as other codecs
- Minor wording improvement to the Support Matrix reference line (changed "please consult" to "check out")
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | <<plugins-codecs-netflow,netflow>> | Reads Netflow v5 and Netflow v9 data | https://github.com/logstash-plugins/logstash-codec-netflow[logstash-codec-netflow] | ||
| | <<plugins-codecs-nmap,nmap>> | Reads Nmap data in XML format | https://github.com/logstash-plugins/logstash-codec-nmap[logstash-codec-nmap] | ||
| | <<plugins-codecs-plain,plain>> | Reads plaintext with no delimiting between events | https://github.com/logstash-plugins/logstash-codec-plain[logstash-codec-plain] | ||
| | <<plugins-codecs-pretty,pretty>> | Prints your event data using the Ruby Awesome Print library | https://github.com/logstash-plugins/logstash-codec-pretty[logstash-codec-pretty] |
There was a problem hiding this comment.
The description "Prints your event data using the Ruby Awesome Print library" is very similar to the rubydebug codec's description "Applies the Ruby Awesome Print library to Logstash events" on line 37. These descriptions suggest both plugins do the same thing, which may confuse users. Consider clarifying how the pretty codec differs from rubydebug, or use a more distinctive description that highlights the unique features or use cases of the pretty codec.
| | <<plugins-codecs-pretty,pretty>> | Prints your event data using the Ruby Awesome Print library | https://github.com/logstash-plugins/logstash-codec-pretty[logstash-codec-pretty] | |
| | <<plugins-codecs-pretty,pretty>> | Formats event data in a human-friendly, colorized layout for console output, ideal for development and debugging | https://github.com/logstash-plugins/logstash-codec-pretty[logstash-codec-pretty] |
There was a problem hiding this comment.
This is cool, but I don't know if it is technically correct.
There was a problem hiding this comment.
I think I'd be inclined to leave it as it is. The existing description is the one taken from the plugin docs
There was a problem hiding this comment.
IIUC, your recommendation is using my original text, and not implementing the Copilot suggestion. Did I get that right?
There was a problem hiding this comment.
New plan after discussions with @robbavey: Add this plugin to skiplist (@karenzone)
The new docs system requires every file to be linked, and this approach should keep codec-pretty out of the generated output.
2 participants
No description provided.