github.com/siglens/siglens@v0.0.0-20240328180423-f7ce9ae441ed/README.md (about)

     1  <p align="center">
     2  <img src="https://github.com/siglens/siglens/assets/604069/7dab105b-2102-4a32-85c7-02fbb4604217" width="300">
     3  </p>
     4  
     5  ---
     6  <div align="center">
     7  
     8    [![Build Status](https://github.com/siglens/siglens/workflows/siglens-docker-release/badge.svg)](https://github.com/siglens/siglens/actions/workflows/publish-prod-images.yml)
     9    [![Go Report Card](https://goreportcard.com/badge/github.com/siglens/siglens)](https://goreportcard.com/report/github.com/siglens/siglens)
    10    [![GoDoc](https://godoc.org/github.com/siglens/siglens?status.svg)](https://pkg.go.dev/github.com/siglens/siglens)
    11    [![codecov](https://codecov.io/gh/siglens/siglens/graph/badge.svg?token=MH8S9B0EIK)](https://codecov.io/gh/siglens/siglens)
    12  </div>
    13  <div align="center">
    14  
    15    [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40SigLensHQ)](https://twitter.com/SigLensHQ)
    16    [![RSS](https://img.shields.io/badge/RSS-Subscribe-orange?style=social&logo=rss)](https://www.siglens.com/blog/blog-rss.xml)
    17    [![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=social&logo=linkedin)](https://www.linkedin.com/company/siglens-com)
    18  </div>
    19  
    20  English | [įŽ€äŊ“中文](README_ZH_CN.md)
    21  
    22  <p align="center">
    23    
    24  
    25    <p align="left">Open Source Observability that is đŸ’ĨđŸ’Ĩ <b>100x</b> đŸ’ĨđŸ’Ĩ more efficient than Splunk </p>
    26    <p align="left"><b>Single binary</b> for Logs đŸŽ¯, Metrics đŸŽ¯ and Traces đŸŽ¯.</p>
    27    <p align="left">Cut down your Splunk bill by ⚡ ⚡ <b>90%</b> ⚡ ⚡ </p>
    28  
    29  </p>
    30  
    31  
    32  
    33  # Why SigLens:
    34  Our experience servicing 10,000+ engineers with Observability tools taught us a few things:
    35  
    36  - Developers have to jump through different tools for logs, metrics, traces
    37  - Splunk, DataDog, NewRelic are very expensive 💸 💸 💸 
    38  - ElasticSearch takes too many machines, cluster maintenance is hard 👩‍đŸ’ģ👩‍đŸ’ģ
    39  - Grafana Loki has slow query performance 🐌🐌
    40  
    41  
    42  Armed with decades of experience in monitoring domain, we set out to build a observability DB from the ground up, uniquely suited for logs, metrics and traces with **`zero`** external dependencies. A **`single binary`** that you can run on your laptop and process **`8 TB/day`**.  
    43  <br /><br />
    44  
    45  
    46  # Setup
    47  ## Installation
    48  
    49  ### &emsp; <a href="https://siglens.github.io/siglens-docs/installation/git" target="_blank">Git</a> &emsp; | &emsp; <a href="https://siglens.github.io/siglens-docs/installation/docker" target="_blank">Docker</a> &emsp;| &emsp; <a href="https://siglens.github.io/siglens-docs/installation/helm" target="_blank">Helm</a>
    50  
    51  ## Documentation
    52  ### &emsp; <a href="https://siglens.github.io/siglens-docs" target="_blank">Docs</a> &emsp;
    53  
    54  
    55  # Differentiators
    56  
    57  ### SigLens v/s Splunk,Elastic,Loki  
    58  Check out this <a href="https://www.siglens.com/blog/petabyte-of-observability-data.html" target="_blank">blog</a> where SigLens ingested data at 1 PB/day rate for 24 hours on a mere `32 EC2 instances` compared to `3000 EC2 instances` required for Splunk, Elastic, Grafana Loki
    59  
    60  ### SigLens v/s Elasticsearch 
    61  Check out this <a href="https://www.siglens.com/blog/siglens-1025x-faster-than-elasticsearch" target="_blank">blog</a> where SigLens is **`1025x`** Faster than Elasticsearch 🚀🚀
    62  
    63  ### SigLens v/s ClickHouse 
    64  Check out this <a href="https://www.siglens.com/blog/siglens-54x-faster-than-clickhouse.html" target="_blank">blog</a> where SigLens is **`54x`** Faster than ClickHouse 🚀🚀
    65  
    66  
    67  <br />
    68  
    69  # Features:
    70  
    71  1. Multiple Ingestion formats: Open Telemetry, Elastic, Splunk HEC, Loki
    72  2. Multiple Query Languages: Splunk SPL, SQL and Loki LogQL
    73  3. Simple architecture, easy to get started.
    74  
    75  
    76  ## Join our Community
    77  
    78  Have questions, ask them in our community <a href="https://www.siglens.com/slack" target="_blank">Slack</a> 👋
    79  
    80  <br />
    81  
    82  
    83  # Contributing
    84  
    85  Please read [CONTRIBUTING.md](CONTRIBUTING.md) to get started with making contributions to SigLens.
    86  
    87  # How-Tos
    88  
    89  #### Searching Logs
    90  ![Searching Logs](./static/assets/readme-assets/log-searching.png)
    91  
    92  #### Tracing
    93  ![Tracing](./static/assets/readme-assets/tracing.png)
    94  
    95  #### Creating Dashboards
    96  ![Creating Dashboards](./static/assets/readme-assets/dashboards.png)
    97  
    98  #### Creating Alerts
    99  ![Creating Alerts](./static/assets/readme-assets/alerting.png)
   100  
   101  #### Live Tail
   102  ![Live Tail](./static/assets/readme-assets/live-tail.png)
   103  
   104  #### Minion Searches
   105  ![Minion Searches](./static/assets/readme-assets/minion-searches.png)
   106  
   107  
   108  ## Code of Conduct
   109  Please review our [code of conduct](https://github.com/siglens/siglens?tab=coc-ov-file#siglens-code-of-conduct) before contributing.
   110  
   111  ## Thanks to all contributors for their efforts
   112  
   113  <a href="https://github.com/siglens/siglens/graphs/contributors" target="_blank">
   114    <img src="https://contrib.rocks/image?repo=siglens/siglens" />
   115  </a>