https://github.com/arkuznetsov/iracli

Приложение oscript для взаимодействия с сервисом администрирования 1С
https://github.com/arkuznetsov/iracli

1c 1c-enterprise bsl cli hacktoberfest onescript oscript rac ras

Last synced: 6 months ago
JSON representation

Приложение oscript для взаимодействия с сервисом администрирования 1С

• Host: GitHub
• URL: https://github.com/arkuznetsov/iracli
• Owner: arkuznetsov
• License: mpl-2.0
• Created: 2021-03-31T14:26:17.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-19T06:33:47.000Z (about 3 years ago)
• Last Synced: 2025-03-02T03:29:08.693Z (12 months ago)
• Topics: 1c, 1c-enterprise, bsl, cli, hacktoberfest, onescript, oscript, rac, ras
• Language: 1C Enterprise
• Homepage:
• Size: 199 KB
• Stars: 9
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GitHub release](https://img.shields.io/github/release/ArKuznetsov/iracli.svg?style=flat-square)](https://github.com/ArKuznetsov/iracli/releases)

[![GitHub license](https://img.shields.io/github/license/ArKuznetsov/iracli.svg?style=flat-square)](https://github.com/ArKuznetsov/iracli/blob/develop/LICENSE)

[![Build Status](https://img.shields.io/github/workflow/status/ArKuznetsov/iracli/%D0%9A%D0%BE%D0%BD%D1%82%D1%80%D0%BE%D0%BB%D1%8C%20%D0%BA%D0%B0%D1%87%D0%B5%D1%81%D1%82%D0%B2%D0%B0)](https://github.com/arkuznetsov/iracli/actions/)

[![Quality Gate](https://open.checkbsl.org/api/project_badges/measure?project=iracli&metric=alert_status)](https://open.checkbsl.org/dashboard/index/iracli)

[![Coverage](https://open.checkbsl.org/api/project_badges/measure?project=iracli&metric=coverage)](https://open.checkbsl.org/dashboard/index/iracli)

[![Tech debt](https://open.checkbsl.org/api/project_badges/measure?project=iracli&metric=sqale_index)](https://open.checkbsl.org/dashboard/index/iracli)



# Comand line interface for RAC

Приложение oscript для взаимодействия с сервисом администрирования 1С

## Требования

Требуются следующие библиотеки и инструменты:

- [logos](https://github.com/oscript-library/logos)

- [asserts](https://github.com/oscript-library/asserts)

- [cli](https://github.com/oscript-library/cli)

- [irac](https://github.com/oscript-library/v8runner)

- [1C RAC](https://releases.1c.ru/project/Platform83) - утилита RAC из состава платформы 1С:Предприятие 8.3

## Команды

  - **<тип объектов> list** - список объектов

  - **<тип объектов> get** - данные объекта по указанному пути

  - **counter <тип объектов>** - значения счетчиков для <тип объектов>

  - **counter list** - список доступных счетчиков

  - **counter <тип объектов> list** - список доступных счетчиков для <тип объектов>

  - **dump** - запись состояния кластера в файл

### Используемые типы объектов (`<тип объектов>`)

  - **cluster** - информация о кластерах

  - **server** - информация о рабочих серверах

  - **process** - информация о рабочих процессах

  - **infobase** - информация об информационных базах

  - **session** - информация о сеансах

  - **connection** - информация о соединениях

## Доступные параметры команд

### Доступные параметры команды получения списка объектов кластера (`<тип объектов> list`)

  - **--field <имена полей>** - имена полей запрашиваемого типа объекта, которые попадут в результат, имена полей разделяются запятыми (`--field _all` - попадут все поля)

  - **--filter <имя поля>_<операция сравнения>=<значение поля>** - условие <операция сравнения> (фильтр) по значению полей <имя поля>, условия разделяются запятыми

  - **--order <имена полей>** - сортировка по значениям полей, имена полей разделяются запятыми

  - **--top <количество>** - отбор <количество> первых объектов с учетом порядка сортировки  `--order`

  

### Доступные параметры команды получения данных объекта (`<тип объектов> get`)

  - **--id ** - идентификатор объекта (GUID) или метка объекта

  - **--field** - имена полей запрашиваемого объекта, которые попадут в результат (`--field _all` - попадут все поля)

  - **--property <имя поля>** - выводимое свойство объекта

  - **--format <формат>** - формат вывода результата (json|prometheus|plain)

### Доступные поля запроса счетчиков (`counter <тип объектов>`)

  - **--counter <имя поля счетчика>** - имя поля объекта из которого получается значение счетчика, если не указано, то получаются значения всех полей счетчика

  - **--dim <имена полей>** - имя измерения счетчика по которым выполняется свертка значения счетчика (`dim _all` - попадут все измерения счетчика)

  - **--filter <имя поля>_<операция сравнения>=<значение поля>** - условие <операция сравнения> (фильтр) по значению полей <имя поля>, условия разделяются запятыми

  - **--top <количество>** - отбор <количество> первых значений счетчика с максимальным значением

  - **--aggregate <агрегатная функция>** - агрегатная функция свертки значений счетчика

  - **--format** - формат вывода результата (json|prometheus|plain)

### Формат меток типов объектов кластера (`<метка объекта>`)

  - **cluster** - <адрес сервера>:<порт сервера>

  - **server** - <адрес агента>:<порт агента>

  - **process** - <адрес агента>:<порт процесса>

  - **infobase** - <имя информационной базы>

  - **session** - <имя информационной базы>:<номер сеанса>

  - **connection** - <адрес агента>:<порт процесса>:<номер соединения или имя приложения для соединений с `conn-id = 0`>

### Доступные операции сравнения фильтров (`<операция сравнения>`)

  - **eq** - равно (может не указываться), для строк выполняется без учета регистра

  - **neq** - не равно, для строк выполняется без учета регистра

  - **gt** - больше

  - **gte** - больше или равно

  - **lt** - меньше

  - **lte** - меньше или равно

### Доступные агрегатные функции свертки значений счетчиков (`<агрегатная функция>`)

  - **count** - количество значений счетчика

  - **distinct** - количество **различных** значений счетчика

  - **sum** - сумма значений счетчика

  - **min** - минимальное значение счетчика

  - **max** - максимальное значение счетчика

  - **avg** - среднее значение счетчика

### Доступные форматы

  - **json** - (по умолчанию) JSON-текст собственной структуры

  - **prometheus** - формат Prometheus

  - **plain** - плоский текстовый формат без указания значений измерений

## Примеры комманд:

### Получение списка кластеров

```

iracli cluster list

```

## Серверы

### Получение списка серверов

```

iracli server list

```

## Информационные базы

### Получение списка ИБ

```

iracli infobase list

```

## Сеансы

### Получение списка сеансов

```

iracli session list

```

## Счетчики

### Получение списка счетчиков

```

 iracli counter list

```

### Получение всех счетчиков сеансов

#### Развернуто по всем измерениям

```

iracli counter session

или

iracli counter session --dim _all

```

В формате Prometheus

```

iracli counter session --format prometheus

```

#### Свернуто по всем измерениям

Агрегатная функция по умолчанию (`count`)

```

iracli counter session --dim _no

```

Агрегатная функция СУММА (`sum`)

```

iracli counter session --dim _no aggregate sum

```

### Получение конкретного счетчика сеансов

#### Развернуто по всем измерениям

```

iracli counter session count --dim _all

```

#### С отбором по типу клиента

```

iracli counter session count --filter app-id_eq=Designer

```

#### Свернуто по хосту и ИБ

Агрегатная функция СУММА (`sum`)

```

iracli counter session count --dim host,infobase --aggregate sum

```