search

parseablehq / console

Frontend Client for Parseable. Parseable is a cloud native log storage and management for Kubernetes, containerised workloads
https://parseable.com
GNU Affero General Public License v3.0
25 stars 35 forks source link
cloud-native containers docker hacktoberfest javascript kubernetes log-storage react

readme

Parseable Logo
Cloud native log analytics

[![Docker Pulls](https://img.shields.io/docker/pulls/parseable/parseable?logo=docker&label=Docker%20Pulls)](https://hub.docker.com/r/parseable/parseable) [![Slack](https://img.shields.io/badge/slack-brightgreen.svg?logo=slack&label=Community&style=flat&color=%2373DC8C&)](https://join.slack.com/t/parseable/shared_invite/zt-23t505gz7-zX4T10OvkS8RAhnme4gDZQ) [![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs) [![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions)

Parseable is a cloud native log analytics system. It ingests log data via HTTP POST calls and exposes a query API to search and analyze logs. Parseable is compatible with logging agents like FluentBit, LogStash, FileBeat among others.

This repository contains the source code for Parseable Console. Console is the web interface for Parseable. It allows you to view and analyze logs in real time.

Parseable Console is deeply integrated with Parseable server, and server binary has Console built-in. So, you don't need to build/run the Console separately.

For complete Parseable API documentation, refer to Parseable API workspace on Postman.

Parseable Console

:eyes: Live Demo

URL https://demo.parseable.com
Username admin
Password admin

Please do not store any sensitive data on this server as the data is openly accessible. We'll delete the data on this server periodically.

:trophy: Development and Contributing

If you're looking to develop or test Parseable Console, you can follow the steps below.

  1. Clone the repository.
  2. Create .env.development.local and copy the content of .env.example into it (Fill in the values). By default, the console points to the demo server.
  3. Run pnpm install to install all the dependencies.
  4. Run pnpm dev to start the console.
  5. Open http://localhost:3001 in your browser.

Enabling hot reload:

  1. Disable CORS on the server by setting P_CORS=false.
  2. Configure the following environment variables: 
    VITE_USE_BASIC_AUTH=true
VITE_USERNAME=username
VITE_PASSWORD=password

To test production build

  1. Run pnpm build:test to create a release build in test mode.
  2. Run pnpm start to start the console.
  3. Open http://localhost:3002 in your browser.

Also, please refer to the contributing guide here.

Our Contributors

Supported by

📓 License

Licensed under the GNU Affero General Public License, Version 3 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.gnu.org/licenses/agpl-3.0.txt