https://github.com/msantos/eventbot
A bot for generating and interacting with event streams using XMPP
https://github.com/msantos/eventbot
chatbot monitoring
Last synced: 2 months ago
JSON representation
A bot for generating and interacting with event streams using XMPP
- Host: GitHub
- URL: https://github.com/msantos/eventbot
- Owner: msantos
- Created: 2019-10-27T13:02:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-11T13:03:55.000Z (over 1 year ago)
- Last Synced: 2025-02-13T05:30:11.313Z (4 months ago)
- Topics: chatbot, monitoring
- Language: Elixir
- Size: 16.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eventbot
eventbot is a bot for generating and interacting with event streams using
XMPP.
## Concepts
### Runlets
`runlets` are a simple command language for generating, filtering and
performing flow control on a stream of events:
```
| |
```
Commands are chained together using the pipe operator (`|`).
A `source` command generates an event stream, usually by connecting to
an external service. A `source` typically will not terminate.
`filters` perform operations on the stream of events. Examples of filters
are selecting events or controlling the rate of events. For example,
the flow control filter discards events based on the rate. Zero or more
filters can be chained together.
A `sink` outputs the event stream. The default sink displays the results
of a stream in the channel where the request was made. Support for other
sinks is experimental.
### Processes
Each `runlet` runs in an isolated process. A job control language is
used to interact with the runlet.
## Installing a Release
1. Create a release for your platform.
2. Extract the tarball to /usr/local/lib/eventbot:
```bash
mkdir -p /usr/local/lib/eventbot
cd /usr/local/lib/eventbot
tar zxf /path/to/eventbot.tar.gz
```
3. Create the eventbot user:
```bash
useradd -r -c "event bot pseudo-user" -s /bin/false eventbot
```
4. Create the chroot and state directories.
By default, the directories will be created and symlink'ed under
/usr/local/lib/eventbot so state is not lost if eventbot is re-installed. The
directories can be manually created if you want to put them somewhere
else.
It is safe to re-run the postinstall script.
```bash
cd /usr/local/lib/eventbot
lib/eventbot-*/priv/bin/postinstall
```
5. command line: run the bot.
The bot is configured using environment variables. See `Configuration`
for details.
The bot will run as a daemon and be restarted on exit. See `Booting`
for other options.
```bash
sudo -u eventbot \
EVENTBOT_USERNAME="botname" \
EVENTBOT_PASSWORD="botpassword" \
EVENTBOT_JID="[email protected]" \
EVENTBOT_ALIAS="^" \
EVENTBOT_ROOMS="[email protected]:[email protected]" \
/usr/local/lib/eventbot/bin/eventbot start
```
6. systemd: run the bot as a systemd service.
Copy the systemd service file (`priv/bin/eventbot.service`) to
`/etc/systemd/system/eventbot.service`.
```bash
cp priv/bin/eventbot.service /etc/systemd/system/eventbot.service
```
Copy the example environment file and edit:
```bash
mkdir /etc/eventbot
cp priv/bin/eventbot.env /etc/eventbot
chown root:root /etc/eventbot/eventbot.env
chmod 640 /etc/eventbot/eventbot.env
vi /etc/eventbot/eventbot.env
```
Enable the service:
```bash
systemctl daemon-reload
systemctl start eventbot
systemctl status eventbot
```
7. Stopping the bot.
```bash
systemctl stop eventbot
```
## Configuration
EVENTBOT_USERNAME
: bot displayed name
EVENTBOT_PASSWORD
: bot XMPP password
EVENTBOT_JID
: fully qualified XMPP username
EVENTBOT_ALIAS
: The bot can be reference either by the name (EVENTBOT_USERNAME) or by a
short form alias. For example, if the name of the bot is "foo" and the
short form is "^", the following are equivalent:
```
foo: runtime
^runtime
```
EVENTBOT_ROOMS
: A list of ":"-separated conference rooms (MUCs):
```
[email protected]
[email protected]:[email protected]:muc3.conference.example.com
```
Default: no conference rooms
EVENTBOT_RIEMANN_HOST
: IP address/hostname of Riemann service
Default: localhost
EVENTBOT_RIEMANN_PORT
: Port of riemann HTML5 SSE web service
Default: 8080
EVENTBOT_TLS_SNI
: Hostname in TLS certificate of XMPP server.
Default: none (Mandatory: must be set)
EVENTBOT_RIEMANN_URL
: Query URL for Riemann
Default: /event/index?query=
EVENTBOT_PRX_ROOTDIR
: chroot directory for containerized Unix processes
Default: priv/root
EVENTBOT_PRX_EXEC
: Command to grant eventbot privileges to create a container. By default,
eventbot uses a setuid binary. To use `sudo`:
```bash
visudo -f /etc/sudoers.d/99_eventbot
eventbot ALL = NOPASSWD: /usr/local/lib/eventbot/lib/prx-*/priv/prx
EVENTBOT_PRX_EXEC="sudo -n"
```
Default: ""
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add `eventbot` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:eventbot, "~> 2.1.1"}]
end
```
2. Ensure `eventbot` is started before your application:
```elixir
def application do
[applications: [:eventbot]]
end
```
## Building a Release
1. Install dependencies:
```bash
sudo apt install build-essential automake autoconf git
libssl-dev libncurses5-dev libexpat1-dev
```
2. Install the [asdf](https://github.com/asdf-vm/asdf) language
runtime manager
See: https://asdf-vm.com/#/core-manage-asdf-vm
```bash
git clone https://github.com/asdf-vm/asdf.git ~/.asdf
echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.profile
echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.profile
. ~/.profile
```
3. Clone the eventbot repository.
4. Install the `erlang` and `elixir` compilers and runtime
```bash
cd eventbot
asdf install
```
5. Build the release:
```bash
# development
mix do deps.get, deps.compile, release
# prod
# clean up old releases:
rm -rf _build
MIX_ENV=prod mix do deps.get, deps.compile, release
```
6. Create the tarball:
```bash
#!/bin/bash
set -o errexit
set -o nounset
set -o pipefail
VERSION=$(grep "version:" mix.exs | grep -E -o "[0-9]+.[0-9]+.[0-9]+")
RELEASE=${RELEASE-_build/prod/rel/eventbot/}
ARCHIVE="eventbot-$VERSION+$(uname -m).tar.gz"
echo "Creating release archive"
(cd "$RELEASE" && tar zcvf - .) > "$ARCHIVE"
```