Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maksimryndin committed Feb 25, 2024
1 parent 39e1ec0 commit 160184b
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/site/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Overview](./overview.md)
- [System requirements](./system-requirements.md)
- [Installation](./installation.md)
- [Setup](./setup.md)
- [Setup](./setup.md)
- [Services](./services.md)
- [General](./general.md)
- [Healthcheck](./healthcheck.md)
Expand Down
Binary file added .github/site/src/images/goral.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions .github/site/src/installation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Installation

You can install Goral with
You can install (or update) Goral with

```sh
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/maksimryndin/goral/0.1.3rc22/.github/site/install.sh | sh
curl --proto '=https' --tlsv1.2 -sSf https://maksimryndin.github.io/goral/install.sh | sh
sudo mv goral /usr/local/bin/goral
```

Expand Down
3 changes: 2 additions & 1 deletion .github/site/src/overview.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# Overview
![Goral](images/goral.png)
*generated with [Imagine](https://www.imagine.art/)*
2 changes: 1 addition & 1 deletion .github/site/src/system-requirements.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# System requirements

* Memory: RSS 30M, 900M for virtual memory. An actual requirement may be different - as it depends on the amount of data, scrape and push intervals (see below for each [service](./services.md))
* Memory: RSS 30M. An actual requirement may be different - as it depends on the amount of data, scrape and push intervals (see below for each [service](./services.md))
* Binary size is around 15 Mb
* Platforms: Linux (`x86-64` or `aarch64`). Other platforms - namely MacOS (M1 `arm`) and Windows - will probably work also.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ Observability toolkit for small projects. Easy-to-use and compatible with indust
Goral is a simple observability daemon developed with the following idea in mind: when you have your favorite application in its infantry, you usually don't need a full-blown observability toolkit (which require much more setup, maintenance and resources) around as the amount of data is not so huge. It is especially true for pet projects when you just want to test an idea and deploy the app at some free-tier commodity VPS.

So Goral provides the following features being deployed next to your app(s):
* Periodic healthchecks (aka [liveness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/))
* Metrics collection (fully compatible with Prometheus to be easily replaced with more advanced stack as your project grows)
* [Periodic healthchecks](https://maksimryndin.github.io/goral/healthcheck.html) (aka [liveness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/))
* [Metrics collection](https://maksimryndin.github.io/goral/metrics.html) (fully compatible with Prometheus to be easily replaced with more advanced stack as your project grows)
* Logs collection (importing logs from stdout/stderr of the target process)
* System telemetry (CPU, Memory, Free/Busy storage space etc)
* A general key-value appendable log storage (see [the user case](#kv))
* Features are modular - all [services](#services) are switched on/off in the configuration.
* You can observe several instances of the same app or different apps on the same host with a single Goral daemon (except logs as logs are collected via stdin of Goral - see [below](#logs))
* You can configure different messengers and/or channels for every [service](#services) to get notifications on errors, liveness updates, system resources overlimit etc
* [System telemetry](https://maksimryndin.github.io/goral/system.html) (CPU, Memory, Free/Busy storage space etc)
* A general key-value appendable log storage (see [the user case](https://maksimryndin.github.io/goral/kv-log.html))
* Features are modular - all [services](https://maksimryndin.github.io/goral/services.html) are switched on/off in the configuration.
* You can observe several instances of the same app or different apps on the same host with a single Goral daemon (except logs as logs are collected via stdin of Goral - see [Logs](https://maksimryndin.github.io/goral/logs.html))
* You can configure different messengers and/or channels for every [service](https://maksimryndin.github.io/goral/services.html) to get notifications on errors, liveness updates, system resources overlimit etc
* All the data collected is stored in Google Sheet with an automatic quota and limits checks and automatic data rotation - old data is deleted with a preliminary notification via configured messenger (see below). That way you don't have to buy a separate storage or overload your app VPS with Prometheus, ELK etc. Just a lean process next to your brilliant one which just sends app data in batches to Google Sheets for your ease of use. Google Sheets allow you to build your own diagrams over the metrics and analyse them, analyse liveness statistics and calculate uptime etc.
* You can configure different spreadsheets and messengers for every service
* You can configure [rules](#rules) for notifications by messenger for any data.
* You can configure [rules](https://maksimryndin.github.io/goral/rules.html) for notifications by messenger for any data.

## Licence

Expand Down

0 comments on commit 160184b

Please sign in to comment.