Skip to content
Swizec Teller - a geek with a hatswizec.com

Building a filterable log viewer with Downshift and match-sorter

This was a fun little build, but I wish I remembered to turn on my stream. It was kinda nice to just write some code, too πŸ˜‡

<LogViewer> takes a stream of server logs, or process logs, or any flat text file (let's be honest) and turns it into a searchable, filterable little thing. Type in the input box, find what you're looking for. Matched strings are highlighted so you know what you're doing.

The whole thing fits into 69 lines of beautifully rendered code and 1071 node_modules dependencies. You can see the code on GitHub ✌️

Try <LogViewer>

Here's how it works πŸ‘‡

<LogViewer> is built out of 2 main components:

  1. <LogViewer> renders a Downshift component and munches a text file into a list of logs
  2. <LogRow> takes care of individual lines and highlighting matched strings

LogViewer

We're using getDerivedStateFromProps to take our logs, which is a flat string, and turn it into an array of entries. Right now, that's just splitting by newlines, but we could perform contextual parsing and understand that a single log can span multiple lines.

Perhaps the parser function should come from props πŸ€”

The render method takes logs from state and returns a <Downshift> component. Downshift takes care of driving our input field and some other tidbits that are tedious to do ourselves.

Inside Downshift's render prop, we use matchSorter to filter logs based on user input. I don't know what string matching algorithm matchSorter uses, but it's really fast.

A+ library πŸ‘Œ

Finally, we render a <div> with an input field controlled by Downshift, a p with the count of matches, and a pre with all our logs in a loop. We render each log entry with <LogRow>, providing the current match and log to be rendered.

LogRow

The <LogRow> component renders a string of text, potentially highlighting a part of it.

We convert the matched string to lower case. Gonna use it to decide which part of the log to highlight.

Then we split our log on a regex using the provided match.

The result is an array of log fragments like this

match = 'cat'
log = 'my cat is grumpy'
chunks --> ['my ', 'cat', ' is grumpy']

When you split on regex and wrap your split point in parenthesis, (), it's preserved in your output. Perfect πŸ‘Œ for our purposes and pretty fast too.

Rendering is a matter of looping through our chunks array and returning either a flat string or the <Highlighted> styled component.

The <Highlighted> component is simplistic because I'm no designer.

const Highlight = styled.span`
color: red;
background: yellow;
`;

Red color, yellow background. High contrast.

Useful?

That was an MVP. Should I make it better? Should I open source it?

Anyone out there who'd use it? 🀨 Ping me on Twitter.

Did you enjoy this article?

Published on July 18th, 2018 in Front End, Technical

Learned something new?
Want to become a high value JavaScript expert?

Here's how it works πŸ‘‡

Leave your email and I'll send you an Interactive Modern JavaScript Cheatsheet πŸ“–right away. After that you'll get thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over my 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

Start with an interactive cheatsheet πŸ“–

Then get thoughtful letters πŸ’Œ on mindsets, tactics, and technical skills for your career.

"Man, love your simple writing! Yours is the only email I open from marketers and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. πŸ‘Œ"

~ Ashish Kumar

Join over 10,000 engineers just like you already improving their careers with my letters, workshops, courses, and talks. ✌️

Have a burning question that you think I can answer?Β I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

Ready to Stop copy pasting D3 examples and create data visualizations of your own? Β Learn how to build scalable dataviz components your whole team can understand with React for Data Visualization

Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first πŸ’° on the side with ServerlessReact.Dev

Want to brush up on your modern JavaScript syntax?Β Check out my interactive cheatsheet: es6cheatsheet.com

By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❀️