mishankov/web-tail

📖 Web based log monitoring tool

Web tail

Web application to view lines from file on local system or on remote server built with Svelte

Installation

Download and unpack web-tail-x.x.x-[platform].zip from latest release

Configuration

In unpacked folder edit web-tail.config.toml file

• port - Port that Web tail will run on. Defaults value is 4444
• openBrowserOnStart - automatically open tab with Web tail in your default browser on start. Default value is false
• servers - reusable servers configuration
  • name - name of server to use in sources configs
  • host - host of remote server. Mandatory field for source types ssh:*
  • port - port of remote server. Mandatory field for source types ssh:*
  • username - username for ssh connection to remote server. Mandatory for source types ssh:*
  • password - password to authenticate on remote server. Either this or privateKeyPath is mandatory for source types ssh:*
  • privateKeyPath - path to file with private key to authenticate on remote server. Either this or password is mandatory for source types ssh:*
• sources - list of sources to tail lines from
  • name - name of source. Mandatory field
  • type - type of source. Possible values: local:file, local:docker, ssh:file, ssh:docker. Mandatory field
  • path - path to file. Mandatory field for source types *:file
  • serverName - name of a server from servers list
  • containerId - Docker container ID. Mandatory field for source types *:docker
  • host - host of remote server. Mandatory field for source types ssh:*
  • port - port of remote server. Mandatory field for source types ssh:*
  • username - username for ssh connection to remote server. Mandatory for source types ssh:*
  • password - password to authenticate on remote server. Either this or privateKeyPath is mandatory for source types ssh:*
  • privateKeyPath - path to file with private key to authenticate on remote server. Either this or password is mandatory for source types ssh:*

Run

Launch executable for your platform: macOS, Windows or Linux

Or you can download source code and run commands

npm install
npm run build
npm run start

Usage

Options from left to right:

• Dropdown to select one of sources from web-tail.config.toml
• Search field. Matching results will be selected. Search is case insensitive by default
• Filter toggle. If enabled only lines with matching results are shown
• .* toggle. If enabled treats text in search field as regular expression
• Aa toggle. If enabled makes search case sensitive
• Reverse toggle. If enabled latest lines shown on top
• Max lines field. How much lines will be shown

web-tail's Issues

Fix 'Unexpected any. Specify a different type.' issue in src\server\models\sources\sftp.ts

CodeFactor found an issue: Unexpected any. Specify a different type.

It's currently on:
src\server\models\sources\sftp.ts:48

open browser window on start

https://github.com/sindresorhus/open

• Config option not to do it

Tail logs with `docker logs -f container_name` command on local and over ssh

Option to split lines with regex instead of `\n`

• Move line breaks splits to LogLine component

web-tail/src/client/pages/Logs.svelte

Line 28 in 0118c26

for (let line of event.data.split("\n")) {

Validate web-tail.config.toml content

Generate regex

Use https://github.com/pemistahl/grex to generate regex from user input in "Search field"

Fix 'Unexpected any. Specify a different type.' issue in src\client\stores\settings.ts

CodeFactor found an issue: Unexpected any. Specify a different type.

It's currently on:
src\client\stores\settings.ts:29

proper search highlights display

Long lines wthout spaces overflows from screen

Docker container

ui for sources modifications

Remove unused dependency

web-tail/package.json

Line 47 in 0118c26

"express-ws": "^5.0.2",

there can be multiple exact the same log lines which breaks this keyed each

web-tail/src/client/components/LogLines.svelte

Line 22 in 93878fb

{#each filteredLogs as logLine(logLine)}

hardcoded full config path

web-tail/src/server/index.ts

Line 15 in 9ee31ba

let raw = fs.readFileSync('/Users/mishankov/Documents/Git/web-tail/dist/config.json');

change buffer length without data loss

web-tail/src/client/types/CircularBuffer.ts

Line 28 in aff025c

setLength(newLength: number) {

Add tryKeyboard to SSH config params

web-tail/src/server/models/sources/ssh.ts

Line 54 in 97b0cc3

const connectionParams: SSHConnectionParams = {

Group sources by server

Send stderr from ssh:* sources

keyfile auth option for sftp

Reverse button does not work?

sftp line splited in 16384 max length chunks

ignore case option for search

get logWindow lines from source on connect

Ignore lines by pattern

checkboxes are 2px shorter than text inputs

optional (or not) reverse order of logs

PWA

https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable

refactor settings to store in json

source name as page title