|
| 1 | +<p align="center"><img src="docs/images/logo_small.png?raw=true"></p> |
| 2 | + |
| 3 | +<center> |
| 4 | + |
1 | 5 | [](https://app.circleci.com/pipelines/github/observIQ/stanza) |
2 | 6 | [](https://codecov.io/gh/observIQ/stanza) |
3 | 7 | [](https://goreportcard.com/report/github.com/observIQ/stanza) |
4 | 8 | [](https://github.com/observIQ/stanza/license) |
5 | 9 | [](https://github.com/observIQ/stanza/actions/workflows/gosec.yml) |
6 | 10 |
|
| 11 | +</center> |
7 | 12 |
|
8 | | -<p align="center"><img src="https://github.com/observIQ/stanza/blob/master/docs/images/logo_small.png?raw=true"></p> |
| 13 | +# About Stanza |
9 | 14 |
|
10 | | -# Stanza is moving to OpenTelemetry |
| 15 | +Stanza is a fast and lightweight log transport and processing agent. It's designed as a modern replacement for Fluentd, Fluent Bit, and Logstash and can run as a standalone agent on all major operating systems. Stanza is also highly integrated to perform seamlessly with the applications in Google Cloud Platform (GCP) based production environments. |
| 16 | + |
| 17 | +## OpenTelemetry |
11 | 18 |
|
12 | 19 | Stanza has been contributed to the [OpenTelemetry](https://opentelemetry.io/) project and will be intergrated into the [OpenTelemetry collector](https://github.com/open-telemetry/opentelemetry-collector). |
13 | | - |
14 | 20 |
|
15 | | -# About Stanza |
| 21 | +# Features |
16 | 22 |
|
17 | | -Stanza is a fast and lightweight log transport and processing agent. It's designed as a modern replacement for Fluentd, Fluent Bit, and Logstash. Stanza can run as a standalone agent on all major operating systems, or it can be embedded directly into any Golang application. |
| 23 | +- Flexible |
| 24 | + - Supports many different input types such as file, journald, windows events, tcp / udp, and external APIs (cloudwatch, azure log analytics) as well as parsing with json and regex. |
| 25 | + - Easily extended by writing an "operator" or "plugin" which is just a unit of code that performs a task such as reading data from a source, parsing data, or shipping data. |
| 26 | +- Pre-built Plugins |
| 27 | + - Over 80 Plugins have been pre-built and are ready to be configured. |
| 28 | +- Lightweight with low resource consumption |
| 29 | + - Uses next to no resource while idling. It does not pollute the system with tons of clutter, it exists strictly in /opt/observiq/stanza with just a few files. |
| 30 | +- Written in pure Go |
| 31 | + - Everything is self contained into a single binary, there are no external dependencies. |
| 32 | +- High Performance |
| 33 | + - Stanza is proven to be significantly faster than fluentd and more stable at high throughput than fluentbit. |
18 | 34 |
|
| 35 | +## Supported Plugins |
19 | 36 |
|
20 | | -# Quick Start |
| 37 | +Utilize Plugins to get up and running quickly. Some of our top Plugins include: |
| 38 | +- Kubernetes |
| 39 | +- NGINX |
| 40 | +- Apache |
| 41 | +- Windows Events |
| 42 | +- Syslog |
| 43 | +- MySQL |
| 44 | +- SQL Server |
| 45 | +- PostgreSQL |
| 46 | +- VMWare ESXI |
| 47 | +- Redis |
21 | 48 |
|
22 | | -Want to get started right away? Check out our [Quick Start Guide](./docs/README.md)! |
| 49 | + Here are many of the Plugins supported by Stanza, with more being developed all the time. |
23 | 50 |
|
| 51 | +<p align="center"><img src="docs/images/stanza_plugins.png?raw=true"></p> |
24 | 52 |
|
25 | | -## Community |
| 53 | +# Documentation |
26 | 54 |
|
27 | | -Stanza is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](./CONTRIBUTING.md) and [developer guide](./docs/development.md). We look forward to building with you. |
| 55 | +## [Quick Start](./docs/README.md) |
| 56 | + |
| 57 | +### Installation |
28 | 58 |
|
| 59 | +To install Stanza, we recommend using our single-line installer provided with each release. Stanza will automatically be running as a service upon completion. |
29 | 60 |
|
30 | | -## Roadmap |
| 61 | +#### Linux/macOS |
| 62 | +```shell |
| 63 | +sh -c "$(curl -fsSlL https://github.com/observiq/stanza/releases/latest/download/unix-install.sh)" unix-install.sh |
| 64 | +``` |
| 65 | +#### Windows |
| 66 | +```pwsh |
| 67 | +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 ; Invoke-Expression ((New-Object net.webclient).DownloadString('https://github.com/observiq/stanza/releases/latest/download/windows-install.ps1')); Log-Agent-Install |
| 68 | +``` |
31 | 69 |
|
32 | | -Stanza uses GitHub [projects](https://github.com/observIQ/stanza/projects) to organize future work. There's a lot to do, and more use cases are identified almost daily. We'll keep it organized and moving forward the best we can, but we're always looking for great ideas and contributions of all sizes. |
| 70 | +For more details on installation and configuration, check out our full [Quick Start Guide](./docs/README.md)! |
33 | 71 |
|
| 72 | +# Community |
| 73 | + |
| 74 | +Stanza is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](./CONTRIBUTING.md) and [developer guide](./docs/development.md). We look forward to building with you. |
34 | 75 |
|
35 | 76 | ## Code of Conduct |
36 | 77 |
|
37 | 78 | Stanza follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). Please report violations of the Code of Conduct to any or all [maintainers](MAINTAINERS.md). |
38 | 79 |
|
39 | 80 |
|
40 | | -## Other questions? |
| 81 | +# Other questions? |
41 | 82 |
|
42 | 83 | Check out our [FAQ](/docs/faq.md), or open an issue with your question. We'd love to hear from you. |
0 commit comments