Takes JSON-formatted logrus log messages as input and prints them back out in a more human readable format.
go build -o plr main.goPut the plr executable somewhere on your PATH.
kubectl logs <pod> | plrUsage together with pod-id
Pod-id is a small utility to get the pod id from a partial pod name.
It lets you look up pods by a partial name, like this:
kubectl logs $(podid my-app)This shell alias is useful for combining podid and plr:
alias klogs='kubectl logs $(podid $1) | plr'To also be able to pass arguments to plr, replace the alias with this function:
klogs () {
local pod_id
pod_id=$(podid "$1")
shift
kubectl logs "$pod_id" | plr "$@"
}
# Usage examples:
klogs my-app # prints the logs from the pod where the name contains "my-app".
klogs my-app --field trace.id # pretty-logrus arguments work as expected.Note: The
klogsfunction does not forward arguments to pod-id. If you need to pass arguments to pod-id, you can use the full command:kubectl logs $(podid my-app <args here>) | plr.
--multi-line | -M: Print output on multiple lines with log message and level first and then each data field on separate lines.--no-data: Don't show any logged data fields.--level <level> | -L: Only show log messages matching this level. Values (logrus levels):trace|debug|info|warning|error|fatal|panic--fields <field>(,<field>) | -F: Only show specific data field(s). Several field names can be separated by comma. Field name can have leading and/or trailing wildcard*.--except <field>(,<field>) | -E: Don't show this particular field or fields separated by comma. Field name can have leading and/or trailing wildcard*.--trunc <field>=<num chars or substr>: Truncate the content of this field by an index or substring.--where <field>=<value> | -W: Only show log messages where the value occurs.--highlight-key <field> | -K: Highlight the key of the field in the output. Field name can have leading and/or trailing wildcard*. By default, this is displayed in bold red text. Styles can be overridden in the configuration file.--highlight-value <field value> | -V: Highlight the value of the field in the output. Field value can have leading and/or trailing wildcard*. By default, this is displayed in bold red text. Styles can be overridden in the configuration file.
--trunc message=50: Print the first 50 characters in the message field--trunc message="\n": Print everything up until the first line break in the message field--trunc message="\t": Print everything up until the first tab character in the message field--trunc message=mytext: Print everything up until the first occurrence of the phrase 'mytext' in the message field.--trunc message="stop it": Print everything up until the first occurrence of the phrase 'stop it' in the message field.--trunc message=" ": Print everything up until the first empty space in the message field.
--where <field>=<value>: Only show log messages where the specific field has the given value--where <field>=<value>,<field>=<value>: Specify multiple conditions separated by comma--where <value>: Only show log messages where the value occurs in any data field or the message field. Value can be a partial phrase or text.
Several flags support the wildcard * in their values to match several things at once:
--fields--except--highlight-key--highlight-value
Usage:
- Leading:
--arg "*foo"will match phrases ending with "foo" (case sensitive). - Trailing:
--arg "foo*"will match phrases starting with "foo" (case sensitive). - Both:
--arg "*foo*"will match phrases containing "foo" (case sensitive).
Gotcha 1: You might need to quote the string:
--arg labels.* might give the output zsh: no matches found: labels.* whereas
--arg "labels.*" will filter on fields beginning with the phrase "labels.".
Gotcha 2: it's case sensitive. For example when searching for values with --highlight-value like --highlight-value "my-service*", "my-service" will be matched as-is.
See the configuration spec for how to set up the configuration file.
🛠️ - Enhancements, improvements
✨ - New features, additions
🐛 - Bug fixes
💥 - Breaking changes
✂️ - Remove features, deletions
📆 2024-05-28
- 💥 Removed the
--fieldflag. Use--fieldsinstead. There is no difference in usage, except--fieldscan do more than--fieldcould and as such it was redundant having two really similar args. The-Fshorthand alias has also been moved to--fields. - 🛠️ Added default colors for all logrus log levels. The colors can be overridden in the configuration file.
- 🛠️ Added
-Eshorthand alias for the--exceptarg.
📆 2024-05-26
- 🐛 use
path.Join()when reading config.json to avoid OS-related file path issues. - 🐛 misc refactoring and cleanup.
📆 2024-05-26
- 🛠️ Add shorthand aliases to some CLI arguments.
- 🐛 Fix various style-related bugs.
📆 2024-05-24
- ✨ Added a configuration file to customize various aspects of the app, like the text styles. See the configuration file spec for more information.
- ✨ Added
--highlight-keyand--highlight-valueflags to highlight specific fields or values in the output.
☝️ Highlighting the key trace.id (--highlight-key trace.id).
☝️ Highlighting all values containing abc (--highlight-value "*abc*").
📆 2024-05-24
- 🛠️ Fields are sorted alphabetically.
- 🛠️ Include (
--field,--fields) and exclude (--except) flags can now take a wildcard*to match several fields at once.
📆 2024-04-08
✨ Added --where flag to filter log messages based on field values. Example: --where trace.id=1234. See usage examples above for more variations.
📆 2023-03-13
- 🛠️ Support tailing like
kubectl logs -f | plr
📆 2022-10-24
- 🛠️ A field named
labelswill be treated as a map of other sub-fields and each sub-field under labels will be printed aslabels.<subfield>=[<value>]. Example:
Before
labels=[map[string]struct{ foo: "bar", abc: "def" }]
After
labels.foo=[bar] labels.abc=[def]
📆 2022-10-06
- 🐛 If a log line cannot be parsed (i.e. if it's not a line with JSON on the expected logrus format), it will be printed as-is instead of being ignored by the error handler.
📆 2022-10-04
- 🛠️ Truncate flag now supports substrings, newline and tab characters in addition to a character index.
📆 2022-10-04
- ✨ Added
--truncflag to limit the output length of a certain field. The value of the given field name will be cut off at the given character index. Only one field can be truncated at a time. Example:--trunc service.name=10. - 🐛 Fixed a bug where long lines would be skipped entirely and the line would be lost without any warning or information.
No changelog at this time