Monq Documentation

website·Indexed 33 days ago

https://docs.monq.ru/

Technical documentation for the Monq platform, including API references for signal management in version 9.1, agent plugin configurations (TCP, UDP, syslog, snmp-trap), and comprehensive migration and upgrade guides for versions 6.x, 7.x, and 8.x using monqctl.

Tokens
1M
Snippets
3.2K
Records
7.1K
Agent score
48%

What's inside Monq

  1. Overview of the Monq UDP plugin

    The udp plugin is used to listen on UDP ports on a Monq agent to collect incoming data. It is specifically designed for use within the Agent's Working Configuration (Рабочая конфигурация агента).

    Requirements:

    • Minimum Monq version: 9.0.0
    • Minimum Monq Agent version: 3.0.0
  2. Overview of the oracleDbSqlRequest plugin

    The oracleDbSqlRequest plugin allows the execution of SQL queries in an Oracle database. It supports Oracle DB versions 19c, 21c, and 23ai. Connection is established directly using a username, password, host, and port.

    Security Warning: The plugin supports not only SELECT queries but also INSERT, DELETE, UPDATE, and REPLACE. To prevent accidental data loss, it is strongly recommended to use a database user account with read-only permissions.

  3. Overview of Monq Report Types

    The Monq Reports module provides two primary types of reports to track the health and availability of information systems:

    1. Availability (Доступность): A report on the availability of an information system as a whole.
    2. Availability Multi-report (Доступность мультиотчет): A report for complex systems that includes availability metrics for the overall system as well as for each of its constituent subsystems.
  4. Overview of KE Health (Здоровье КЕ)

    KE Health is a visual tool used to assess the state of a KE tree and individual Configuration Units (KE). Health is measured on a scale from 0 to 100, where 0 represents complete failure and 100 represents an ideal state.

    Important: KE Health is used for visual assessment of the RSM (Resource State Map) and for changing KE status based on defined thresholds; it does not influence the generation of events.

  5. Overview of Metric-Bridges

    Metric-Bridges convert selected events and logs from indexed tables into metric series based on a defined schedule. The resulting values are stored in a special system stream called Metrics Bridge Stream and are accessible via the 'Metrics' and 'Threshold Management' screens. To function, a Metric-Bridge requires a pre-configured index created from one or more log data streams.
  6. Overview of the Events and Logs screen

    The "Events and Logs" screen is used for the operational analysis of primary events, logs, and messages stored in data streams. It is accessible via the main menu: Data View $\rightarrow$ Logs. Access to the section and its content is governed by the system's role-based access control (RBAC) model.

    Key interface elements include:

    • MQL Query String: Includes a built-in constructor and options to select data sources and indices.
    • Time Range Picker & Histogram: For filtering events by time and visualizing distribution.
    • Log Maps: Management and selection of saved log maps.
    • Event Display: A list or table of events with the ability to open detailed event cards.
    • Field Panel: A panel for managing available/selected fields with statistics on popular values.
    • Update Toggle: Switch between automatic and manual page updates.
    • Export Button: Export filtered data to a file.

    Data Sources are one or more streams from which events are retrieved. By default, all available streams in the current workgroup (including shared streams) are used. If a map is linked to a specific index, the available sources are limited to streams within that index.

  7. Overview of Monq Data Streams

    Data streams in Monq are used for the reception, normalization, and processing of information. They feature automatic data normalization upon reception, flexible processing via built-in parsers and custom scenarios, and specialized storage optimized for specific data types.
  8. Overview of the oracleDbSqlRequest plugin

    The oracleDbSqlRequest plugin allows for the execution of SQL queries in an Oracle DBMS. It supports Oracle DB versions 19c, 21c, and 23ai. Connections are established using a username, password, host, and port.

    Warning: While the plugin is primarily used for SELECT queries, it supports INSERT, DELETE, UPDATE, and REPLACE. To prevent accidental data loss, it is strongly recommended to use a database user account with read-only permissions.

  9. Overview of Global Variable Cache Storage

    Monq provides functions to manage data stored in a cache, enabling data transfer between different scenarios or retrieval at any time. The global variable storage is hosted on a Redis cache server and is intended for temporary storage in RAM, not for long-term data persistence.

    Variable Scope (IsPublic):

    • True: The global variable is accessible at the workgroup level across different scenarios.
    • False (Default): The global variable is accessible only within the current scenario.
  10. Overview of the Monq Kafka agent plugin

    The kafka plugin establishes a continuous streaming connection with an Apache Kafka message broker to retrieve data from specified topics. It requires Monq version 9.0.0 or higher and Monq agent version 3.0.0 or higher. This plugin is specifically designed for use within the Agent Working Configuration.