DOCSEARCHbyAlgolia
Submit Docs

Monq Documentation

website·Indexed 33 days ago

https://v8.docs.monq.ru/

Technical documentation for Monq (versions 8.0 through 8.9), covering the Service Model (RSM), Configuration Item (CI/KE) management, and automation functions. Includes API references for signals and object models, agent plugin configurations for syslog, tail, and SNMP trap, and integration guides for external systems such as Zabbix, Logstash, and Fluent Bit.

Tokens
1.8M
Snippets
4.8K
Records
12.1K
Agent score
33%

What's inside Monq

  1. Overview of Automation Scenarios

    A Scenario (Сценарий) in the automation module is a sequence of operations represented as blocks on a visual canvas. Its primary purpose is to automate tasks for processing events and metrics based on specific conditions and actions. A scenario consists of:

    1. A trigger event that initiates the scenario (with a data structure defined in the general event pipeline).
    2. One or more executable functions.
    3. Various transformer functions, data providers, comparison operators, API call functions, and variables.

  2. Overview of pull-based data integration jobs in monq

    For integration with external information systems using 'pull' technology (where the client initiates the request and the server responds), monq provides Custom Jobs. These jobs are defined as YAML scenarios that execute on either a system Agent (internal microservice) or an external Agent. The result of a scenario execution is an 'artifact', which is then transmitted to a monq Data Stream via the REST API.

  3. Overview of the Monq UDP agent plugin

    The udp plugin is used to listen on UDP ports on a Monq agent. It can only be used when configuring the Agent Working Configuration.

    Requirements:

    • Minimum Monq version: 8.9.2
    • Minimum Monq agent version: 2.2.0

  4. Overview of Monq system modules and architecture

    Monq v8.4 is composed of several functional modules and infrastructure components. These are categorized into two types: data processing modules (which pass data sequentially) and support modules (which provide storage, settings, and core services).

  5. Overview of Metric Thresholds in Monq

    A metric threshold is a limit value set for a specific metric to identify critical states (e.g., errors, overloads). When a metric reaches or exceeds this threshold, the mcs-thresholds-service processor generates events. These events can trigger the opening, closing, or confirmation of a threshold. Thresholds are short-lived objects with a start and end time, similar to Signals. Note: It is not permitted to reopen completed thresholds in Monq.

  6. Overview of Monq Agent httpPlugin

    The httpPlugin is a built-in module for the Monq agent that allows users to execute HTTP requests defined as YAML scenarios within a Data Stream. It supports all standard HTTP methods and allows the results of these requests to be sent to the Monq collector as artifacts, enabling flexible configuration of the final event model by passing results between scenario steps.

  7. Overview of User Groups in Monq

    User Groups are used to organize users and assign permissions and roles efficiently. Unlike individual permissions, User Groups can be added to a 'WorkGroup', making all group members participants of that WorkGroup without listing them individually.

    Key attributes of a User Group:

    • Name: Must be unique within the user space.
    • Composition: A list of user identifiers belonging to the group.

    Constraints:

    • User Groups cannot have an owner.
    • Management of User Groups is restricted to Space Administrators with the appropriate roles.

  8. Overview of the Monq TCP plugin

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

    Requirements:

    • Minimum Monq version: 8.9.2
    • Minimum Monq Agent version: 2.2.0