Справочник по источнику данных SNMP

Расширения / Расширения 2.0 / Справочник по источнику данных SNMP

Этот справочник предоставляет обзор того, как определить и настроить источник данных SNMP для вашего расширения Ключ-Астром с использованием YAML. В руководстве описаны детали объявления метрик, измерений и настройки вашей SNMP-инфраструктуры.

1. Область данных

Определите набор данных, который будет извлечен из вашей SNMP-инфраструктуры и загружен в Ключ-Астром.

- **Пример определения расширения**:

  ```yaml

```yaml

name: custom.snmp.metrics

version: 1.0.0

min Ключ-Астром Version: "1.202"

author:

  name: "Company Name"

  email: "support@company.com"

  url: "https://company.com"

```

В этом разделе указывается основная информация о расширении, включая его название, версию, минимальную поддерживаемую версию Ключ-Астром и контактные данные автора.

2. Метрики

Определите метрики, которые будут собираться из SNMP устройств.

- **Пример определения метрик**:

  ```yaml

  metrics:

    - key: snmp.cpu.usage

      oid: 1.3.6.1.4.1.2021.11.10

      metricType: gauge

      dimensions:

        - device_ip

      displayname: "CPU Usage"

      unit: Percent

  ```

Этот пример показывает, как настроить метрику, включающую ключ метрики, OID, тип метрики, связанные измерения, отображаемое имя и единицу измерения.

3. Измерения (Dimensions)

Измерения позволяют вам определять дополнительные контексты для метрик.

- **Пример измерения**:

  ```yaml

  dimensions:

    - key: device_ip

      displayname: "Device IP"

      type: ip

  ```

Этот раздел демонстрирует, как создать измерение для добавления контекста, такого как IP-адрес устройства, к метрике.

4. Конфигурация подключения

Задайте параметры подключения к SNMP устройствам.

- **Пример конфигурации**:

  ```yaml

  snmp:

    version: "2c"

    port: 161

    community: "public"

    timeout: 3000

    retries: 2

  ```

Этот пример показывает, как настроить параметры подключения для SNMP, такие как версия, порт, сообщество, таймаут и количество повторных попыток.

5. Инфраструктура SNMP

Определите устройства SNMP, с которых будет собираться информация.

- **Пример определения устройства**:

  ```yaml

  devices:

    - ip: "192.168.1.100"

      name: "Router 1"

    - ip: "192.168.1.101"

      name: "Switch 1"

  ```

Этот пример иллюстрирует, как задать IP-адреса и имена устройств, с которых будет собираться SNMP информация.

Этот справочник служит основным руководством для создания и настройки SNMP источников данных в Ключ-Астром с помощью YAML, позволяя вам эффективно собирать и отслеживать метрики с ваших устройств.