{"id":16627895,"url":"https://github.com/soorajshankar/logscreen","last_synced_at":"2025-04-05T00:05:51.196Z","repository":{"id":221348917,"uuid":"754120153","full_name":"soorajshankar/logScreen","owner":"soorajshankar","description":"Piping logs, visualising on a web app – just suffix \"| npx logscreen\" ","archived":false,"fork":false,"pushed_at":"2024-03-12T12:36:05.000Z","size":383,"stargazers_count":452,"open_issues_count":4,"forks_count":16,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-13T04:28:40.901Z","etag":null,"topics":["logs","piping","react","web"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soorajshankar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"soorajshankar","patreon":null,"open_collective":null,"ko_fi":"soorajshankar","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2024-02-07T12:48:00.000Z","updated_at":"2024-08-08T16:13:56.000Z","dependencies_parsed_at":"2024-03-05T09:30:29.770Z","dependency_job_id":"cec0a1da-767c-469b-96cd-9e95e033e10e","html_url":"https://github.com/soorajshankar/logScreen","commit_stats":null,"previous_names":["soorajshankar/logscreen"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soorajshankar%2FlogScreen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soorajshankar%2FlogScreen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soorajshankar%2FlogScreen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soorajshankar%2FlogScreen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soorajshankar","download_url":"https://codeload.github.com/soorajshankar/logScreen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247266562,"owners_count":20910836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["logs","piping","react","web"],"created_at":"2024-10-12T04:28:38.262Z","updated_at":"2025-04-05T00:05:51.166Z","avatar_url":"https://github.com/soorajshankar.png","language":"JavaScript","readme":"# LogScreen\n\n💻 Hard to search logs?\n\nLogScreen simplifies the process. Piping logs, visualizing in a web app – it's that easy! \n\n\u003e This tool has been generated entirely with ChatGPT and hence it is also a demonstration of how useful products can be developed with collaborative reiteration with GPTs. \n\n## Usage\n\nAfter installation, you can use LogScreen to view command outputs in a browser:\n\n```bash\ncommand | npx logscreen\n```\n\nReplace `command` with the actual command you want to execute. LogScreen will start a local server and open the logs in your default web browser.\n\n![alt text](image.png)\n\nHere are some examples:\n\n### Example 1: Viewing Docker Logs\n\n```bash\n  docker-compose up | npx logscreen\n```\n\nThis example pipes the logs from a Docker Compose service into LogScreen, providing a more readable and interactive log view.\n\n### Example 2: Monitoring NPM Start Script\n\n```bash\n  npm start | npx logscreen\n```\n\nIf you have a Node.js project with an \\`npm start\\` script, you can use LogScreen to monitor and navigate through the logs as your application runs.\n\n### Example 3: Tail Command Output\n\n```bash\n  tail -f /var/log/syslog | npx logscreen\n```\n\nFor Linux users, you can use LogScreen with the \\`tail\\` command to follow and visualize real-time updates in system logs.\n\n#### Monitoring Remote Server Logs\n\n```bash\nssh user@remote-server 'tail -f /path/to/logs' | npx logscreen\n```\n\nSSH into a remote server and tail logs in real-time using logscreen for diagnosing issues on a production server.\n\n#### Monitoring Nginx Access Logs\n\n```bash\ntail -f /var/log/nginx/access.log | npx logscreen\n```\n\nTail Nginx access logs to observe incoming requests, response codes, and other relevant information.\n\n#### Tail Apache Error Logs\n\n```bash\ntail -f /var/log/apache2/error.log | npx logscreen\n```\n\nMonitor Apache error logs to identify issues with your web server.\n\n#### Google Cloud Functions Logging:\n\nUse logscreen to monitor logs from Google Cloud Functions, gaining insights into function executions, errors, and overall performance.\n\n```bash\ngcloud functions logs read \u003cfunction-name\u003e | npx logscreen\n```\n\n#### Kubernetes Logs\n\n```bash\nkubectl logs -f \u003cpod-name\u003e | npx logscreen\n```\n\n#### AWS lambda\n\n```bash\naws logs tail /aws/lambda/\u003cfunction-name\u003e | npx logscreen\n```\n\n#### EC2 Instance\n\n```bash\nssh -i \u003cprivate-key.pem\u003e ec2-user@\u003cinstance-ip\u003e 'tail -f /var/log/\u003cyour-log-file\u003e' | npx logscreen\n```\n\n#### Monitoring Heroku Postgres Queries:\n\nTail logs related to database queries on a Heroku Postgres database for performance analysis and optimization.\n\n```bash\nheroku pg:psql --app \u003cyour-app-name\u003e -c \"tail -f /var/log/postgresql/postgresql.log\" | npx logscreen\n```\n\n---\n\nReplace the commands above with your specific use case to leverage the benefits of LogScreen's web-based log viewer.\n\n## Features\n\n- **Web-Based Log Viewer**: Get a cleaner and more organized view of command outputs.\n- **Real-Time Updates**: Logs are displayed in real-time as the command executes.\n- **Interactive Interface**: Search, filter, and navigate through logs easily. // TODO\n\n## Options\n\n- **Port**: By default, LogScreen uses port 3000. You can specify a different port using the `-p` or `--port` option:\n\n  ```bash\n  command | npx logscreen --port 8080\n  ```\n\n## Acknowledgments\n\n- [Socket.io](https://socket.io/) for real-time communication.\n- [Express](https://expressjs.com/) for the web server.\n","funding_links":["https://github.com/sponsors/soorajshankar","https://ko-fi.com/soorajshankar"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoorajshankar%2Flogscreen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoorajshankar%2Flogscreen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoorajshankar%2Flogscreen/lists"}