Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OMON-753] Update docs for reading metrics from Kafka #340

Merged
merged 3 commits into from
Feb 7, 2024
+17 −5
Merged

[OMON-753] Update docs for reading metrics from Kafka #340

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b56beca
[OMON-753] Update docs for reading metrics from Kafka
awegrzyn Feb 7, 2024
a4a07b8
Run time params
awegrzyn Feb 7, 2024
88c230f
Update oses
awegrzyn Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,15 @@ This guide explains manual installation. For `ansible` deployment see [AliceO2Gr
## Receiving metrics from Monitoring system (development instructions)

### Requirements
- CS8 or CC7 with `devtoolset-9`
- Boost >= 1.70
- Ubuntu, RHEL9, RHEL8, CS8, macOS, or CC7 with `devtoolset-9`
- Boost >= 1.83, CMake

### Compile Monitoring library with Kafka backend

#### Manually
- Compile `librdkafka`
```bash
git clone -b v1.8.2 https://github.com/edenhill/librdkafka && cd librdkafka
git clone -b v2.3.0 https://github.com/edenhill/librdkafka && cd librdkafka
cmake -H. -B./_cmake_build -DENABLE_LZ4_EXT=OFF -DCMAKE_INSTALL_LIBDIR=lib -DRDKAFKA_BUILD_TESTS=OFF -DRDKAFKA_BUILD_EXAMPLES=OFF -DCMAKE_INSTALL_PREFIX=~/librdkafka_install
cmake --build ./_cmake_build --target install -j
```
Expand All @@ -223,6 +225,11 @@ This guide explains manual installation. For `ansible` deployment see [AliceO2Gr
cmake --build ./_cmake_build --target install -j
```

#### aliBuild
- Modify `monitoring.sh`: add `- librdkafka` to "requires"
- Compile Monitoring: `aliBuild build Monitoring --defaults o2-dataflow --always-prefer-system`
- Add `Monitoring` as dependency of your project

### Look for Monitoring library in your CMake
As `librdkafka` is optional dependency of Monitoring it is not handled by CMakeConfig, therefore you need:
```cmake
Expand All @@ -237,8 +244,8 @@ And then, link against `AliceO2::Monitoring` target.
#include "Monitoring/MonitoringFactory.h"
...

std::vector<std::string> topics = {"topic-to-subscribe"};
auto client = MonitoringFactory::GetPullClient("kafka-server:9092", topics);
std::vector<std::string> topics = {"<topic-to-subscribe>"};
auto client = MonitoringFactory::GetPullClient("<kafka-server:9092>", topics, "<client-id>");
for (;;) {
auto metrics = client->pull();
if (!metrics.empty()) {
Expand All @@ -248,5 +255,10 @@ for (;;) {
}
```

Run-time parameters:
- `<topic-to-subscribe>` - List of topics to subscribe
- `<kafka-server:9092>` - Kafka broker (staging or production)
- `<client_id>` - unique, self-explainable string describing the client, eg. `dcs-link-status` or `its-link-status`.

### Data format
Native data format is [Influx Line Protocol](https://docs.influxdata.com/influxdb/latest/reference/syntax/line-protocol/) but metrics can be converted into any format listed in here: https://docs.influxdata.com/telegraf/latest/data_formats/output/
Loading