aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2025-06-30 01:30:59 +0700
committerShulhan <ms@kilabit.info>2025-06-30 01:41:45 +0700
commitd1d6a4f8857d67ec698fc887e7481560e8709e9e (patch)
treed109633539f20cc3eb3e8ef8afbfc52de618422c
parent26a3ccad0912510dbbf108285b113dfa02274ad1 (diff)
downloadhaminer-d1d6a4f8857d67ec698fc887e7481560e8709e9e.tar.xz
_doc: merge index.md into README.md
Also, make the README as index for project page.
-rw-r--r--README.md21
-rw-r--r--_doc/index.adoc68
l---------_doc/index.md (renamed from _doc/README.md)0
3 files changed, 16 insertions, 73 deletions
diff --git a/README.md b/README.md
index 1a78ccf..8e403fa 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# haminer
-Library and program to parse and forward HAProxy logs.
+`haminer` is a library and program to parse and forward HAProxy HTTP logs.
The HTTP logs is HTTP request that received by HAProxy frontend and forwarded
to backend.
@@ -218,11 +218,23 @@ $ sudo systemctl start haminer
```
+## Development
+
+<https://git.sr.ht/~shulhan/haminer>:: Link to the source code.
+
+<https://lists.sr.ht/~shulhan/haminer>:: Link to development
+and discussion.
+
+<https://todo.sr.ht/~shulhan/haminer>:: Link to submit an issue,
+feedback, or request for new feature.
+
+[Changelog](https://kilabit.info/project/haminer/CHANGELOG.html):: History
+of each release.
+
+
## License
-```
-haminer - Library and program to parse and forward HAProxy logs.
-Copyright (C) 2018-2024 M. Shulhan <ms@kilabit.info>
+Copyright (C) 2018-2025 M. Shulhan &lt;ms@kilabit.info&gt;
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
@@ -236,4 +248,3 @@ details.
You should have received a copy of the GNU General Public License along with
this program.
If not, see <http://www.gnu.org/licenses/>.
-```
diff --git a/_doc/index.adoc b/_doc/index.adoc
deleted file mode 100644
index 7ced570..0000000
--- a/_doc/index.adoc
+++ /dev/null
@@ -1,68 +0,0 @@
-= haminer
-
-`haminer` is a library and program to parse and forward HAProxy HTTP logs.
-
-The HTTP logs is HTTP request that received by HAProxy frontend and forwarded
-to backend.
-In default format, it looks like these (split into multi lines, for
-readability):
-
-----
-<158>Sep 4 17:08:47 haproxy[109530]: 185.83.144.103:46376
- [04/Sep/2022:17:08:47.264] www~ be_kilabit/kilabit-0.0/0/1/2/3 200 89 - -
- ---- 5/5/0/0/0 0/0 "GET / HTTP/1.1"
-----
-
-See
-https://www.haproxy.com/documentation/hapee/1-8r1/onepage/#8.2.3[HTTP log format documentation]
-for more information.
-
-Currently, there are several database where haminer can forward the parsed
-log: Influxdb, Questdb, and Postgresql.
-Haminer support Influxdb v1 and v2.
-
-----
- +---------+ UDP +---------+ +-----------+
- | HAProxy |------>| haminer |----->| Influxdb |
- +---------+ +---------+ | / Questdb |
- +-----------+
-----
-
-In Influxdb, the log are stored as measurement called `haproxy`.
-In Questdb, the log are stored as table called `haproxy`.
-
-The following fields are stored as tags (in Influxdb) or symbol (in Questdb):
-host, server, backend, frontend, http_method, http_url, http_query,
-http_proto, http_status, term_state, client_ip, client_port.
-
-And the following fields are stored as fields (in Influxdb) or values (in
-Questdb): time_req, time_wait, time_connect, time_rsp, time_all,
-conn_active, conn_frontend, conn_backend, conn_server, conn_retries,
-queue_server, queue_backend, bytes_read.
-
-Once the log has been accumulated, we can query the data.
-For example, with Questdb we can count each visited URL using the following
-query,
-
-----
-select backend, http_url, count(*) as visit from 'haproxy'
-group by backend, http_url
-order by visit desc;
-----
-
-
-== Documentation
-
-link:CHANGELOG.html[CHANGELOG^]:: History of each release.
-
-link:README.html[README^]:: User manual page for haminer.
-
-== Development
-
-https://git.sr.ht/~shulhan/haminer[Repository^]:: Link to the source code.
-
-https://lists.sr.ht/~shulhan/public-inbox[Mailing list^]:: Link to development
-and discussion.
-
-https://todo.sr.ht/~shulhan/haminer[Issues^]:: Link to submit an issue,
-feedback, or request for new feature.
diff --git a/_doc/README.md b/_doc/index.md
index 32d46ee..32d46ee 120000
--- a/_doc/README.md
+++ b/_doc/index.md