Ponmon [my NoDeny Wiki]

Ця сторінка доступна тільки для перегляду. Ви можете продивитися вихідний текст, але не можете змінювати його. Якщо ви вважаєте, що це не вірно, зверніться до адміністратора.
====== Ponmon ======

===== Модуль моніторингу PON обладнання =====
<WRAP round important 100%>
  * Модуль написаний для особистого використання і з моєї доброти буде доступний до покупки!
  * Підтримується тільки те обладнання, яке було в наявності або доступне до тестування!
  * Функціонал та підтримка нового обладнання нарощуватиметься, але не швидко ;)

</WRAP>

===== Функціонал =====
<WRAP round info 60%>
"+" - готове

"-" - Не готово
</WRAP>

  * + Пошук ОНУ за ОЛТ та занесення її до БД білінгу
  * + Моніторинг стану та згасання ОНУ
  * + Графіки загасання ОНУ
  * + Отримання FDB таблиці ОЛТ та зіставлення з ОНУ
  * + Відображення у картці абонента за якою ОНУ він сидить (динамічно). Це не прив'язка і не факт, що за ОНУ немає свіча))
  * + Пошук ОНУ за серійним номером або за МАКом
  * + Фільтр ОНУ по дереву
  * - **Прив'язка ОНУ до абонента \ точки топології **
  * - **Пошук по ТКД**
  * - **Фільтр загасання РХ**
  * - //можливість винести на окрему базу даних//
  * - Моніторинг стану ОЛТ
  * - Інформація про ПОН СФП
  * Інші вендори
буде доповнюватись! поки все що згадав)

===== Backend =====
Модуль складається з трьох основних елементів:
=== Модуль ядра ===
  ./kermel/ponmon.pm
елемент займається створенням потоків моніторингу для кожної ОЛТ, збиранням результатів повернутих від ОЛТ, зіставленням та занесенням змін до БД, зіставленням авторизацій абонентів з таблицею FDB
=== Модуль вендора ===
  ./nod/Pon/Bdcom.pm
Збірник оідів та функцій по роботі з даним вендором.
При отриманні завдання від модуля ядра, залежно від **кроку**, виконує функції отримання та конвертування даних у єдину структуру та повертає хеш із готовими даними модулю ядра.
<WRAP left round important 100%>
Якщо ім'я функції починається з "_" нижнього підкреслення, то ця функція локальна і не повинна викликатися з-за, а використовується виключно самим модулем вендора.

Якщо ім'я починається з літери (поки таких немає, зачепив на майбутнє), то цю функцію можна викликати з-за, наприклад з Інтернету для ребута ОНУ
</WRAP>
Для отримання даних з SNMP використовує модуль ./nod/snmptool.pm
=== Модуль SNMP ===
  ./nod/snmptool.pm
Модуль роботи з протоколу SNMP
На вхід отримує ХЕШ параметрів ОЛТ, ХЕШ оідів, ім'я команди (walk/get/set)
На виході віддає отриманий результат

=== snmp.pl ===
У поставці з головним модулем буде файл snmp.pl (аналог системного snmpwalk), за допомогою якого можна побачити структуру з якою працює головний модуль, щоб покращити або додати модулі вендорів
===== Frontend =====
**stat.pl?a=ponmon** - центральна сторінка модуля ПОН. Відображає список ОНУ без сортування за ОЛТ, пошук ОНУ за серійним номером (gpon) або маком (epon). Також звідси вхід на сторінку бінда ОНУ+ОЛТ де відображено інформацію про ОНУ, графік та функції з ОНУ.

**stat.pl?a=op&op=list&act=olt_list** - сторінка управління ОЛТ

На сторінці картки абонента під основним блоком відображається блок PON якщо абонент за ОНУ

===== Модулі вендорів PON моніторингу =====
Оскільки модуль моніторингу сам по собі не вміє нічого моніторити, йому потрібні модулі вендорів!
Така структура була придумана для універсальності, і для кожного вендора можуть бути розроблені свої модулі, бо кожен має свої ОІДи і алгоритми.

<WRAP center round important 100%>
Тестувати та шукати ОІДи дуже затратно за часом, тому приймаю інформаційну допомогу!!!

Також допоможу розробити модулі для інших вендорів, але потрібно десь тестувати;-)!
</WRAP>

===== Інструкція =====
Для роботи модуля необхідно встановити пакет для SNMP та модулі PERLa
<code|bash>
pkg install net-snmp p5-Net-SNMP p5-Net-SNMP-Util p5-Net-Telnet-Cisco p5-Net-Ping p5-Parallel-ForkManager
</code>

У налаштуваннях білінгу, Ядро -> Моніторинг PON змінити під себе та зберегти
{{:nodeny:modules:image_2020-02-24_14-37-44.png?direct}}

У налаштуваннях білінгу, пункт "OLT Сервера" додати свої ОЛТ
{{:nodeny:modules:olt_list.jpg?400|}}

пробний запуск командою
  /usr/bin/perl /usr/local/nodeny/nokernel.pl -m=ponmon -v
ставимо в автозавантаження:
  echo '/usr/bin/perl /usr/local/nodeny/nokernel.pl -m=ponmon -d &' >> /etc/rc.local
  
<WRAP center round info 100%>
   Для читання FDB таблиць по телнету необхідно додати до документів шаблон налаштувань і вибрати його в налаштуваннях конкретної OLT
   
   Шаблон налаштувань повинен мати теги system та pon_tmpl

</WRAP>
FIXME

Атрибути для різних вендорів OLT відрізняються, тому, щоб дізнатися які атрибути доступні, можна скористатися командою
  cat /usr/local/nodeny/nod/Pon/_Zte.pm | grep "{cfg}"
і брати до уваги все, що в наступних фігурних дужках. наприклад з рядка "//if ($olt->{cfg}{fdb_force_telnet}) {//" беремо **fdb_force_telnet**
<WRAP center round important 100%>
Надалі відмовлятимуся від ідеї з використанням шаблонів і перенесу ці налаштування в конкретну OLT!!!

Також буде можливість вносити свої кастомні атрибути та використовувати їх у своїх додаткових патчах.
</WRAP>


===== Скріншоти =====
{{:nodeny:modules:photo_2020-02-23_00-34-11.jpg|Список ОЛТ}}
{{:nodeny:modules:photo_2020-02-23_00-34-18.jpg|Кількість ОНУ}}
{{:nodeny:modules:image_2020-02-23_01-42-18.png|Список ОНУ}}
{{:nodeny:modules:image_2021-01-16_19-24-201.jpg|Сторінка абонента}}
{{:nodeny:modules:image_2021-01-16_19-24-271.png|Сторінка ОНУ}}
{{:nodeny:modules:photo_2020-02-23_00-34-15.jpg|Графік}}

===== Передісторія =====
Якось мені на роботі було поставлено завдання знайти спосіб керування та моніторингу PON обладнанням.
Спочатку було вирішено використовувати сторонній сервіс [[http://www.easypon.in/]], тоді вони тільки починали розвиватися і послуга була повністю безкоштовна на тестування на нашому обладнанні.
Але раптово вони виставили захмарний рахунок, не пам'ятаю точно, але дуже дохрена багато (близько 1.5 $ на місяць за ОНУ). Ми знали, що сервіс стане платним, але що б так дорого, навіть не підозрювали!
Потім пішли ідеї навісити надбудову [[https://www.userside.eu/|UserSide]], але ціна також не підійшла:)!
Потім директор запропонував змінити білінг на той, у якого даний функціонал в наявності, але йому бік, скільки вкладено сил і часу на свої патчі для NoDeny Plus або скільки проблем принесе переїзд на новий білінг, а так само часу та грошей!

Саме тоді і народилася ідея написати свій модуль сабжа, в якому буде те, що нам потрібно і так як нам це потрібно!
Вирішено! Починаємо!
Як поважаючий себе програміст, я природно починаю гуглити)!
Прошерстивши майже весь github, знаходжу потрібну мені інформацію (до речі 3 проекти з України!) і починаю писати модуль пона!
На той момент ми мали близько семи ОЛТ від BDcom і V-Solution(Spectra) за технологією (G)EPON. З ними, в основному, все було просто, але я не забував про спільноту форумчан білінгу, і тому вирішив робити універсальну платформу для будь-якого вендора і технології, що потягнуло за собою вічні переробки в структурі модуля і БД до нього, і нарешті начебто як все склалося, фірма купує пон шасі ZTE C300 (шасі на 14 слотів з підтримкою технологій (G)EPON, GPON, xPON. залежить від встановлених у неї слотів), зі слотами під GPON. Крім того, вирішено перейти повністю з EPON на GPON і відмовитися від BDcom і V-Solution. І тут я розумію, що вся виконана робота на 90% стала марною! Я в смутку, але починаю розумітися на ZTE, а у них міби закриті! Як вдалося знайти частину мібів, деякі відсутні сам дописав.

Пішла робота наново!

А в порівнянні з BDcom та V-Solution, ZTE – мега-комбайн, який ну дуже класно продуманий! Я швиденько накотив модуль роботи з ним, але вибірка з БД стала дуже довгою, до того ж, треба все звести до єдиної структури!
І тут знову затік! Начальство каже відкласти пон убік т.к. назбиралися інші завдання, що не терплять зволікання, типу заміна всіх мікротиків на Juniper MX80, використання телефонії, ЦРМ та інші завдання не до розголошення.

І ось настав час, я набрався мужності випросити місяць на продовження роботи з поном!

Подальшу історію не буду поки що описувати!

<WRAP left round tip 100%>
Підсумую:
  * Загалом модуль переписувався майже з нуля 6 разів!
  * На все витрачено понад 800 годин робочого та особистого часу!
</WRAP>

===== Розробникам =====
Спілкування основного модуля з модулями вендорів відбувається за допомогою одного виклику головної функції вендора **main($olt, $step)**,
де в змінній $olt передаються всі налаштування конкретної ОЛТ + вміст шаблону керування за наявності його,
а змінної $step - просто номер кола сканування з моменту запуску головного модуля пона.

Змінна $step використовується для пропусків сканування не пріоритетних параметрів, якщо це критично даного вендора.

Функція **main** у свою чергу запускає послідовність сканування ОЛТ та повертає хеш результатів сканування
<code perl>
sub main {
    my $self = shift; # приймає ім'я модуля вендора -
    my $olt = shift; # приймає хеш налаштувань ОЛТ
    my $step = shift; # приймає номер кола сканування

    $olt->{snmp_v} ||= 2; # встановлює або керує версію протоколу snmp
    $olt->{snmp_t} ||= 10; # встановлює або править таймаут відповідей snmp
    $olt->{snmp_r} ||= 10; # встановлює або керує кількість повторних запитів при помилці snmp
    $olt->{tmpl}=&template({TYPE => $olt->{pon_type}}); # готує хеш ОІДів snmp для конкретного типу ПОНу (епон/жпон)
# debug Dumper($olt); Якщо розкоментувати, покаже готовий до роботи хеш ОЛТ
    $data->{olt} = &_check_olt($olt) if $olt->{status}==9; первинна ініціалізація ОЛТ (робиться 1 раз при першому скануванні нової ОЛТ)
    $data->{llid_name} = &_check_llid($olt); # сканування та генерація хешу всіх пон портів ОЛТ
# $data->{onu_unreg} = &_unregistered($olt); #не реалізовано - сканування незареєстрованих ОНУ (не рентабельно, зроблю трапами)
    $data->{onu_list} = &_monitoring($olt);# if !($step%2); # Власне, сканування та генерація хешу всіх ОНУ на ОЛТ з типом ПОН з налаштувань
    $data->{fdb} = &_get_fdb($olt) if ( $olt->{cfg}{fdb_force_telnet} || !($step%3) ); # сканування МАКів за всіма ОНУ на ОЛТ
# debug Dumper($data); # якщо розкоментувати, покаже хеш результатів усіх опитувань
    return $data; # віддає хеш результатів всіх опитувань головному модулю для внесення до БД
}
</code>

Першим із функції **main** викликається генерація ОІДів із **template**
<code perl>
sub template {
    my $hash=shift;
    # example: &template({TYPE => 'epon'});
    # example: &template({TYPE => $olt->{pon_type}});
    my %snmp = (
        epon => {
            get_ports => {},
            monitor => {
                'ONU_SN' => {
                    OID => '.1.3.6.1.4.1.3902.1015.1010.1.1.1.1.1.4',
                },
                'ONU_INDEX' => {
                   # OID => '.1.3.6.1.4.1.3320.101.10.5.1.1',
                }, # bin2mac
                'ONU_STATUS' => {
                    OID => '.1.3.6.1.4.1.3902.1015.1010.1.7.4.1.17',
                },
                'ONU_TX_POWER' => {
                    OID => '.1.3.6.1.4.1.3902.1015.1010.1.1.1.29.1.4',
                    GET => 1, # для ОІДів, які не працюють за запитом snmpwalk (при get запиті в кінець ОІДА дописується ".$ONU_INDEX")
                }, # tx_power = tx_power * 0.1;
                'ONU_RX_POWER' => {
                    OID => '.1.3.6.1.4.1.3902.1015.1010.1.1.1.29.1.5',
                    GET => 1,
                }, # tx_power = tx_power * 0.1;
            },
            fdb => {},
            unworked => {}, # For history. Not used anywhere
        },
        gpon => {
            get_ports => {},
            monitor => {},
            fdb => {},
            unworked => {}, # For history. Not used anywhere
        },
    );
    return $hash->{TYPE} ? $snmp{$hash->{TYPE}} : \%snmp;
}
</code>

FIXME

==== Структура БД ====
<code sql>
CREATE TABLE IF NOT EXISTS pon_bind (
  id smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
  sn char(18) NOT NULL,
  olt_id smallint(4) NOT NULL,
  llid char(16) NOT NULL,
  name char(32) NOT NULL DEFAULT '',
  user int(10) NOT NULL DEFAULT '0',
  place int(10) NOT NULL DEFAULT '0',
  tx char(6) DEFAULT NULL,
  rx char(6) DEFAULT NULL,
  status char(30) DEFAULT NULL,
  dereg char(24) DEFAULT NULL,
  changed int(11) NOT NULL DEFAULT '0',
  PRIMARY KEY (id),
  UNIQUE KEY uniq (olt_id, lіd) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='ONU list';
</code>

<code sql>
DROP TRIGGER IF EXISTS `tr_aft_ins_pon`;
DELIMITER $$
CREATE TRIGGER `tr_aft_ins_pon` AFTER INSERT ON `pon_bind` FOR EACH ROW REPLACE INTO `pon_mon`(`bid`, `rx`, `tx`, `time`)
 VALUES (new.id, new.rx, new.tx, new.changed)
$$
DELIMITER;

DROP TRIGGER IF EXISTS `tr_aft_upd_pon`;
DELIMITER $$
CREATE TRIGGER `tr_aft_upd_pon` AFTER UPDATE ON `pon_bind` FOR EACH ROW IF (FORMAT(NEW.rx,1) <>FORMAT(OLD.rx,1) OR FORMAT(NEW.tx,1) <>FORMAT(OLD.tx ,1)) THEN
      INSERT INTO `pon_mon`(`bid`, `rx`, `tx`, `time`)
      VALUES (NEW.id, NEW.rx, NEW.tx, UNIX_TIMESTAMP() );
    END IF
$$
DELIMITER;
</code>

<code sql>
CREATE TABLE IF NOT EXISTS pon_fdb (
  mac char(18) NOT NULL,
  vlan smallint(4) NOT NULL,
  llid char(16) NOT NULL,
  olt_id smallint(4) NOT NULL,
  name varchar(32) DEFAULT NULL,
  uid int(10) DEFAULT NULL,
  ip char(16) DEFAULT NULL,
  time int(11) NOT NULL DEFAULT '0',
  UNIQUE KEY mac (mac) USING BTREE,
  KEY llid (llid),
  KEY name (name) USING BTREE,
  KEY ip (ip) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='ONU list';
</code>

<code sql>
CREATE TABLE IF NOT EXISTS pon_mon (
  bid mediumint(7) NOT NULL,
  tx char(6) DEFAULT NULL,
  rx char(6) DEFAULT NULL,
  time int(11) NOT NULL DEFAULT '0',
  KEY time (time)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='tmp ONU monitoring';
</code>

<code sql>
CREATE TABLE IF NOT EXISTS pon_olt (
  id smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
  name varchar(30) NOT NULL DEFAULT 'new olt',
  ip varchar(15) NOT NULL,
  snmp_port smallint(6) NOT NULL DEFAULT '0',
  vendor varchar(20) NOT NULL DEFAULT '',
  model varchar(20) NOT NULL DEFAULT '',
  firmware varchar(17) NOT NULL DEFAULT '',
  ro_comunity varchar(32) NOT NULL DEFAULT '',
  rw_comunity varchar(32) NOT NULL DEFAULT '',
  pon_type char(8) NOT NULL DEFAULT 'gpon',
  mng_tmpl int(4) NOT NULL DEFAULT '0',
  param varchar(1024) DEFAULT NULL,
  descr varchar(250) NOT NULL DEFAULT '',
  status tinyint(1) NOT NULL DEFAULT '9',
  enable tinyint(1) NOT NULL DEFAULT '0',
  changed int(11) NOT NULL DEFAULT '0',
  PRIMARY KEY (id),
  UNIQUE KEY nas_identifier (ip, snmp_port, pon_type) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='OLT list';
</code>

<code sql>
CREATE TABLE IF NOT EXISTS pon_onu (
  id mediumint(7) UNSIGNED NOT NULL AUTO_INCREMENT,
  sn char(32) NOT NULL,
  vendor char(64) NOT NULL DEFAULT '',
  model char(24) NOT NULL DEFAULT '',
  firmware char(24) NOT NULL DEFAULT '',
  descr char(255) NOT NULL DEFAULT '',
  changed int(11) NOT NULL DEFAULT '0',
  PRIMARY KEY (id),
  UNIQUE KEY sn (sn)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='ONU list';
</code>

<code sql>
CREATE TABLE IF NOT EXISTS pon_ports (
  id smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
  olt_id smallint(11) NOT NULL,
  name varchar(30) NOT NULL DEFAULT 'new olt',
  p_index varchar(30) NOT NULL,
  type varchar(30) NOT NULL DEFAULT '',
  shelf tinyint(2) NOT NULL DEFAULT '0',
  slot tinyint(2) NOT NULL DEFAULT '0',
  port tinyint(2) NOT NULL DEFAULT '0',
  tx varchar(10) NOT NULL DEFAULT '',
  descr varchar(250) NOT NULL DEFAULT '',
  status tinyint(1) NOT NULL DEFAULT '9',
  enable tinyint(1) NOT NULL DEFAULT '0',
  changed int(11) NOT NULL DEFAULT '0',
  PRIMARY KEY (id),
  UNIQUE KEY olt_id (olt_id, p_index)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='OLT ports';
</code>

Приклад таблиць графіків сигналів
<code sql>
DROP TABLE IF EXISTS z2021_01_01_pon;
CREATE TABLE IF NOT EXISTS z2021_01_01_pon (
  bid mediumint(7) NOT NULL,
  tx char(6) DEFAULT NULL,
  rx char(6) DEFAULT NULL,
  time int(11) NOT NULL DEFAULT '0',
  KEY time (time)
) ENGINE = InnoDB DEFAULT CHARSET = utf8;
</code>