Skip to content

README.adoc

Latest commit

 

History

History
92 lines (66 loc) · 2.82 KB

README.adoc

File metadata and controls

92 lines (66 loc) · 2.82 KB

Browser User Interface for Teragrep

This project contains the web-based user interface for Teragrep. It’s used with zep_01 which is the server-side for Teragrep, but you can use it with your own back-end service as well.

Teragrep is a server-based software with a web interface. It has data collection features comparable to the leading central log management products, and its analytics features are powered by Apache Spark.

Features

  • Notebook based interface

  • Querying

  • Result data visualization

  • Collaborative editing

  • Versioning in notebooks

  • Notebook run scheduler

  • Report view

  • Light and dark modes

  • Sessions, login, logout

Documentation

See the official documentation on docs.teragrep.com.

How to Set-Up

Requirements

For installation, you need at least zep_01 to run the back-end.

For the local developing, you need the following:

Optionally, you can use adp_01 to fully replicate the back-end locally. The commands descriped in the local development guide are for using the fake-server which is included in ajs_01.

Installation

  1. Add pkg_01 repository

  2. Run

    dnf install com.teragrep-ajs_01

Local development

Build commands are described in package.json.

  1. Install yarn and required dependencies

    $ npm install -g yarn
$ yarn install

  2. Run the front-end application

    $ yarn run dev

    or run the development server

    $ yarn run fakeserver

    or run both instances parallel

    $ yarn run both

Custom Theme

You can customize the color scheme of Teregrep to match your own color palette or brand identity. Read more here.

Contributing

You can involve yourself with our project by opening an issue or submitting a pull request.

Contribution requirements:

  1. All changes must be accompanied by a new or changed test. If you think testing is not required in your pull request, include a sufficient explanation as why you think so.

  2. Security checks must pass

  3. Pull requests must align with the principles and values of extreme programming.

  4. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).

Read more in our Contributing Guideline.

Contributor License Agreement

Contributors must sign Teragrep Contributor License Agreement before a pull request is accepted to organization’s repositories.