# ilagent

ilagent comes as a single binary with a small footprint and is available for all major platforms. We also provide an official Docker image.

## Features

* [Send events and heartbeats from the command line](https://docs.ilert.com/developer-docs/client-libraries/ilagent/cli)
* [Run a local HTTP proxy server with a retry queue for events and heartbeats](https://docs.ilert.com/developer-docs/client-libraries/cli#http-proxy)
* [Consume and forward MQTT messages to ilert](https://docs.ilert.com/developer-docs/client-libraries/ilagent/mqtt)
* [Consume and forward Apache Kafka messages to ilert](https://docs.ilert.com/developer-docs/client-libraries/ilagent/kafka)
* [Map and filter consumer messages to ilert events](https://docs.ilert.com/developer-docs/client-libraries/ilagent/event-mapping)
* [Sync escalation policy levels from external systems](https://docs.ilert.com/developer-docs/client-libraries/ilagent/escalation-policies)

## Installing

### Docker

```sh
docker run ilert/ilagent --help
```

### Compile from source

> Requires Rust to be installed, see <https://rustup.rs>

```sh
git clone git@github.com:iLert/ilagent.git
cd ilagent
cargo build --release
./target/release/ilagent --help
```

### Install script (macOS / Linux)

```sh
curl -sL https://raw.githubusercontent.com/iLert/ilagent/master/install.sh | bash -
```

Pre-compiled binaries are available on the [releases page](https://github.com/iLert/ilagent/releases).

## Quick reference

* The proxy exposes the same API as `https://api.ilert.com/api` — see the [API docs](https://api.ilert.com/api-docs/#tag/Events)
* In `daemon` mode, provide `-b il1hbt123...` to monitor ilagent's uptime via heartbeats
* Adjust the log level with multiple `-v` flags (default: error, `-v` warn, `-v -v` info)
* ilagent buffers events locally using SQLite3 (except in Kafka mode) and requires file system access in `daemon` mode

## Source code

The ilagent source code is open source and managed on GitHub: <https://github.com/iLert/ilagent>

{% hint style="info" %}
Missing a feature? Let us [know](https://github.com/iLert/docs/blob/master/developer-docs/contact.md)
{% endhint %}