Links and examples
These pages explain Patrol. The list below is the source material behind them.
The library
Section titled “The library”| What | Where | Answers |
|---|---|---|
| API reference | pkg.go.dev/github.com/kataras/patrol | Every exported symbol with its godoc, generated from the released tag |
| Source | github.com/kataras/patrol | What a function actually does, which is the last word when a doc page and the code disagree |
| Release notes | HISTORY.md, rendered on our changelog | What changed in a version, and what a caller has to do about it |
| Issues | github.com/kataras/patrol/issues | A bug, or a destination that is missing |
| License | BSD 3-Clause | Whether you may ship it. You may |
Install with go get github.com/kataras/patrol@latest. Go 1.27 or newer.
The example programs
Section titled “The example programs”The programs under _examples build against the working tree rather than against a release. basic/program, basic/server and sql are each their own Go module, replacing the dependency with the checkout beside them; basic/client belongs to the library’s own module.
| Example | What it shows |
|---|---|
basic/program |
Four flushers at once, each loaded from its own YAML file, with producer.Test at startup |
basic/server |
A patrol.Server with both credential forms, delivering to an email inbox |
basic/client |
Two producers with different project names posting to that server with one bearer token |
sql |
100,000 events through one Postgres flusher |
Every example reads a *.example.yml you copy and fill in. The filled-in copy is gitignored, which is the habit worth taking into your own repository.
From a checkout, ./.github/scripts/setup_examples_test.bash builds and vets all of them at once, which is also what the library’s CI runs.
The code on these pages
Section titled “The code on these pages”Every Go block in this documentation is checked against the library on each build. A block either quotes a numbered line range from a file in the checkout, and has to match it, or it is a complete file that is compiled with go vet against the released version. A snippet here is either taken from working code or is working code.
This site
Section titled “This site”| What | Where |
|---|---|
| Plans and limits | Pricing |
| How events travel and what is stored | Security |
| Every release | Changelog |
| The hosted service | Patrol Cloud |
| A short machine-readable index | llms.txt, llms-full.txt |
| Questions not answered here | Contact |