This is an app that allows user to retrieve lines, most recent first, from a file in /var/log directory. It is developed using NodeJs and ReactJs with Koa used as the web framework and server.
- User can stream a file by specifying a file name
- User can search the last n lines of a file
- User can search keywords in a file
- The API is event based and pushes data to the client via event-stream
Prerequisite: The app was developed using Node 20.11.0. Please download
latest version of NodeJs before running
clone the repo, and in the working directory run
sh run_app.sh
To run unit tests
npm run test
Additionally, a postman collection is provided in the test_scripts directory
A basic UI is provied for the demo purpose. It allows user to search logs files in /var/logs by specifying fileName, keyword, and limit. The maximum number of logs can be returned is 500000. UI might stop functioning beyong that limit because events are pushed in a high rate and high volume which will cause UI to freeze or run out of memory. To improve the performance, some form of the rate limit should be implemented to allow user to control the speed of flow of logs.
The REST API is described below.
GET /v1/streaming/logs
curl --location 'http://127.0.0.1:8181/v1/streaming/logs'
filter: A scim style query string that contains the filter to filter the logs. This is a required field.
fileName filter is a required field that is used to specify the name of a file in /var/log. keyword
filter is option and is used for search specific text in the file.
Example: filter=(fileName eq "abc.txt" and keyword eq "01/02/2024")
limit: An integer that represents the number of last entries to be returned. The maximum allowed is 500000.
Example: limit=10
HTTP/1.1 200 OK
Date: Thu, 24 Feb 2011 12:36:30 GMT
Status: 200 OK
Cache-Control: no-cache
Connection: keep-alive
Content-Type: text/event-stream
Transfer-Encoding: chunked
data: {"logs":["B02942,2017-04-01 00:21:58,,,"],"count":1,"requestId":"2ef72aa8-3260-4005-a0e8-01f85beadb5c"}\n\n
- A brief description of the design of this application: https://docs.google.com/document/d/1hVqFm-HP4maUlXLuWN438JxQ-PHpyDYeQL_A1Oajpyg/edit
- A brief description of the design of the bonus qeustion: https://docs.google.com/document/d/1ORNcGmf3dumybolWGdMK32xwYdI52ibsXrHJP64dz7k/edit?usp=sharing
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent