Skip to content

Latest commit

 

History

History
109 lines (85 loc) · 3.49 KB

integration-with-pmtelemetryd.md

File metadata and controls

109 lines (85 loc) · 3.49 KB

Table of Content

Introduction

The following paragraphs outline the steps necessary to integrate the gRPC dial-out data collection functionality into pmacct/pmtelemetryd. I've included a minimal set of configuration snippets that can serve to verify the installation as well as act as a starting point for more intricate scenarios.

Testing Environment

$ sudo cat /etc/os-release

PRETTY_NAME="Debian GNU/Linux 11 (bullseye)"
NAME="Debian GNU/Linux"
VERSION_ID="11"
VERSION="11 (bullseye)"
VERSION_CODENAME=bullseye
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"

Compile/Install gRPC dial-out library/Header for pmtelemetryd

sudo /bin/sh -c "$(curl -fsSL https://github.com/network-analytics/mdt-dialout-collector/raw/main/install.sh)" -- -l -v current

(sh install.sh -l) explained

  • The gRPC framework source code is cloned by default under the "/root" folder:
  • The gRPC framework is compiled and installed under the "/root/.local/{bin,include,lib,share}" folders:
  • The gRPC dial-out source code is cloned/compiled under the "/opt/mdt-dialout-collector" folder:
  • The building process is generating both the library and the header file required to build pmtelemetryd with gRPC dial-out support:
/usr/local/lib/libgrpc_collector.la
/usr/local/include/grpc_collector_bridge/grpc_collector_bridge.h

Compile/Install pmtelemetryd with gRPC dial-out support enabled

sudo apt install libzmq3-dev libjansson-dev librdkafka-dev

cd /opt
sudo git clone https://github.com/pmacct/pmacct.git
cd /opt/pmacct
sudo ./autogen.sh
sudo ./configure --enable-debug --enable-zmq --enable-jansson --enable-kafka --enable-grpc-collector
sudo make -j
sudo make install

pmtelemetryd's minimal configuration snippet

$ sudo cat /root/etc/pmtelemetryd.conf

! ### Generic Settings
core_proc_name: pmtelemetryd-grpc
pidfile: /root/var/run/pmtelemetryd-grpc
logfile: /root/var/log/pmacct/pmtelemetryd.log
!
! ### gRPC dial-out Settings
telemetry_daemon_decoder: json
telemetry_daemon_grpc_collector_conf: /root/etc/pmtelemetryd-grpc-dialout.conf
!
! ### Kafka Settings
telemetry_daemon_msglog_output: json
telemetry_daemon_msglog_kafka_topic: kafka.topic
telemetry_daemon_msglog_kafka_config_file: /root/etc/kafka.conf


$ sudo cat /root/etc/kafka.conf

global, compression.type, snappy
global, queue.buffering.max.messages, 10000000
global, batch.size, 2147483647
global, batch.num.messages, 1000000
global, linger.ms, 200
global, client.id, debian
global, security.protocol, plaintext
global, metadata.broker.list, 192.168.100.1:9092

gRPC's dial-out minimal configuration snippet

$ cat /root/etc/pmtelemetryd-grpc-dialout.conf

iface = "enp1s0";
ipv4_socket_cisco = "192.168.100.254:10001";
data_delivery_method = "zmq";

spdlog_level = "debug";

enable_cisco_gpbkv2json = "false";
enable_cisco_message_to_json_string = "true";