diff --git a/beecloud-docs b/beecloud-docs new file mode 160000 index 0000000..df88416 --- /dev/null +++ b/beecloud-docs @@ -0,0 +1 @@ +Subproject commit df88416247529a85beeef673abd5e6722c4037e4 diff --git a/src/PaaS/PostgreSQL/Инструкция по работе с Grafana.md b/src/PaaS/PostgreSQL/Инструкция по работе с Grafana.md new file mode 100644 index 0000000..5457d7c --- /dev/null +++ b/src/PaaS/PostgreSQL/Инструкция по работе с Grafana.md @@ -0,0 +1,93 @@ +Для того, чтобы получить доступ к метрикам кластера, предварительно необходимо запросить доступы. Когда доступы будут получены, появится возможность перейти в систему мониторинга. +Ссылка для входа - https://metrics.dfcloud.ru. + +При переходе по ссылке откроется главная страница Grafana. Для того чтобы найти нужные метрики, необходимо проделать следующий путь: +1. Нажать на кнопку "Dashboards", которая располагается в левом боковом меню. +2. В открывшемся списке всех имеющихся дашбордов необходимо выбрать папку "Cloud PostgreSQL". +3. Внутри будет элемент **Cloud PostgreSQL** - это именно тот дашборд, который нам нужен. +Перейдя на дашборд Cloud PostgreSQL, открываются все метрики кластера. + +В верхней части дашборда расположены все селекторы, с помощью которых можно управлять отображаемыми данными: +- **InstallationID** - выбор одного из кластеров. Если у клиента несколько кластеров PostgreSQL, он может выбирать тот кластер, по которому хочет посмотреть информацию. +- **Cluster node name** - выбор конкретной ноды кластера. Значения графиков меняются в зависимости от того, какой хост выбран. Этот селектор влияет на все графики, кроме блока Patroni. +- **Database** - выбор базы данных, по которой можно смотреть показатели метрик. +- **Lock table** - данный селектор применим не для всех графиков. С его помощью можно выбирать, какой тип блокировки использовать для отображения информации. +## Блок метрик PostgreSQL + +Данный блок отображает ключевые параметры конфигурации и текущие показатели работы экземпляра PostgreSQL. + +| Наименование метрики | Описание метрики | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Version** | Показывает текущую версию PostgreSQL, установленную на кластере. | +| **Current fetch data** | Объем данных, извлеченных из базы за текущий период (операции чтения). | +| **Current insert data** | Объем данных, вставленных в базу (операции записи новых данных). | +| **Current update data** | Объем данных, обновленных в базе. | +| **Seq Page Cost** | Стоимость последовательного чтения страницы данных. Влияет на выбор плана запроса: чем выше значение, тем реже оптимизатор будет выбирать последовательное сканирование таблиц. | +| **Random Page Cost** | Стоимость чтения случайной страницы данных. Низкое значение говорит о том, что в системе используются быстрые диски, и оптимизатор будет чаще выбирать доступ по индексам. | +| **Max Connections** | Максимальное количество одновременных подключений к базе данных, разрешенное на сервере. | +| **Shared Buffers** | Объем оперативной памяти, выделенный под кэш данных PostgreSQL. Здесь хранятся часто используемые данные для ускорения доступа к ним. | +| **Effective Cache** | Предполагаемый размер системного кэша файлов. Используется оптимизатором для оценки вероятности нахождения данных в кэше операционной системы. | +| **Maintenance Work Mem** | Объем памяти для выполнения операций обслуживания. | +| **Work Mem** | Объем памяти, выделяемый для внутренних сортировок и хеш-таблиц при выполнении запросов (на каждую операцию). | +| **Max WAL Size** | Максимальный размер журнала предзаписи, после достижения которого запускается процесс контрольной точки (checkpoint). | +| **Max Worker Processes** | Максимальное количество фоновых процессов, которые могут быть запущены в системе. | +| **Max Parallel Workers** | Максимальное количество параллельных процессов, которые могут быть задействованы при выполнении одного запроса. | +## Блок метрик Database Stats + +Данный блок метрик отражает текущую нагрузку и состояние баз данных в кластере PostgreSQL. Эти метрики позволяют оценить, насколько эффективно работает база данных, отследить скачки нагрузки и своевременно среагировать на потенциальные проблемы до того, как они повлияют на работу приложений. + +| Наименование метрики | Описание метрики | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| **Average CPU Usage** | Показывает время, затраченное на выполнение пользовательских и системных задач, а также, насколько интенсивно используются вычислительные ресурсы сервера базы данных. | +| **Average Memory Usage** | Средний объем оперативной памяти, используемой процессами PostgreSQL за 5-минутные интервалы. Показывает, сколько памяти потребляет база данных в процессе работы. | +| **Open File Descriptors** | Количество открытых файловых дескрипторов процессами PostgreSQL. Метрика показывает среднее (Mean), последнее (Last), максимальное (Max) и минимальное (Min) значение за интервал. | +| **Active sessions** | Показывает, сколько в данный момент выполняется запросов к PostgreSQL. Метрика показывает среднее (Mean), последнее (Last), максимальное (Max) значение. | +| **Transcations** | Количество транзакций в базах данных кластера. Метрика разделена на два типа операций: commits (успешно завершенные транзакции) и rollbacks (откаченные транзакции). | +| **Update data** | Объем данных, обновленных в базах данных кластера. Показывает, сколько данных было изменено в результате выполнения операций UPDATE. | +| **Fetch data (SELECT)** | Объем данных, извлеченных из базы с помощью запросов SELECT. Показывает, сколько данных было считано из базы в результате операций чтения. | +| **Insert data** | Объем данных, вставленных в базы данных кластера. Показывает, сколько данных было добавлено в результате выполнения операций INSERT. | +| **Lock tables** | Количество блокировок таблиц в базах данных кластера. Показывает, сколько раз таблицы были заблокированы для выполнения операций.
AccessShareLock - это блокировка, которая возникает, когда кто-то читает данные из таблицы (делает SELECT). Данная блокировка не мешает операциям чтения, но не дает удалить в этот момент таблицу или изменить ее структуру. | +| **Return data** | Объем данных, возвращаемых клиенту в результате выполнения запросов. Показывает, сколько данных было отправлено обратно клиенту после обработки запросов в базе. | +| **Idle sessions** | Количество бездействующих сессий подключения к базе данных. Показывает, сколько открытых подключений в данный момент не выполняют никаких запросов и просто ждут. | +| **Delete data** | Объем данных, удаленных из базы данных в результате выполнения операций DELETE. Показывает, сколько данных было удалено из таблиц. | +| **Cache Hit Rate** | Показывает процент запросов к данным, которые были удовлетворены из кэша (оперативной памяти), без обращения к диску. Показывает, насколько эффективно используется кэш PostgreSQL. | +| **Buffers (bgwriter)** | Метрика, показывающая активность фонового процесса записи, который занимается синхронизацией данных из оперативной памяти на диск. | +| **Conflicts/Deadlocks** | Метрика, отслеживающая две проблемы при работе с базой данных: конфликты восстановления и взаимоблокировки. | +| **Temp File (Bytes)** | Объем данных, записанных во временные файлы при выполнении запросов в базах данных. PostgreSQL создает временные файлы на диске, когда для выполнения запроса не хватает оперативной памяти. | +| **Checkpoint Stats** | Метрика, показывающая время, затрачиваемое на выполнение checkpoints в PostgreSQL, где:
- write_time - время, затраченное на запись данных на диск во время checkpoint (сколько миллисекунд ушло на запись файлов).
- sync_time - время, затраченное на синхронизацию файлов с диском (чтобы данные гарантированно сохранились). | + +## Блок метрик Patroni + +Данный блок метрик отображает состояние и конфигурацию кластера PostgreSQL под управлением Patroni. Эти метрики позволяют контролировать отказоустойчивость кластера, отслеживать переключения мастера и убеждаться, что репликация работает штатно. + +| Наименование метрики | Описание метрики | +| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Patroni Leader** | Метрика, которая показывает, какая нода в кластере PostgreSQL в данный момент является master-сервером, принимающим запросы на запись. | +| **Patroni Replica** | Метрика, которая показывает, какие узлы кластера PostgreSQL в данный момент выполняют роль реплики. | +| **Sync Standby** | Метрика, которая показывает, какая из реплик в кластере PostgreSQL назначена синхронной. | +| **PostgreSQL WAL Replay** | Метрика, которая показывает, включена ли на узлах кластера синхронизация данных через WAL. | +| **PostgreSQL Pending Restart** | Метрика, которая показывает, требуется ли перезагрузка PostgreSQL на узлах кластера после изменения конфигурационных параметров. | +| **Patroni Primary Node** | Метрика, которая показывает, какой узел в кластере PostgreSQL в данный момент является основным и принимает запросы на запись. | +| **Patroni Secondary Nodes** | Метрика, которая показывает, какие узлы кластера PostgreSQL в определенные моменты времени выполняли роль реплик. | +| **Replicas Received WAL Location** | Метрика, показывающая объем журналов предзаписи (WAL), полученных каждой репликой кластера. | +| **Primary WAL Location** | Метрика, показывающая объем журналов предзаписи (WAL), на основном сервере кластера PostgreSQL. | +| **Replicas Replayed WAL Location** | Метрика, показывающая объем журналов предзаписи (WAL), которые были не просто получены, а уже применены на репликах кластера. | +| **WAL Replay Paused** | Метрика, которая отслеживает, не приостановлен ли процесс применения WAL-журналов на узлах кластера. Если передача или применение WAL-файлов останавливается, на графике происходит скачок. | + +## Блок метрик Hosts + +Блок Hosts управляется селектором **Cluster node name**. Данный блок метрик отображает состояние и ресурсы серверов, на которых развернут кластер PostgreSQL. Эти метрики позволяют оценить, хватает ли серверу ресурсов для текущей нагрузки, и своевременно обнаружить проблемы с производительностью или нехваткой места на дисках. + +| Наименование метрики | Описание метрики | +| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **CPU Busy** | Метрика, показывающая общую загруженность всех процессорных ядер на сервере, где работает PostgreSQL. | +| **RAM Used** | Метрика, показывающая процент оперативной памяти, который занят на сервере всеми процессами. | +| **CPU Cores** | Метрика, показывающая общее количество процессорных ядер, доступных на сервере, где работает PostgreSQL. | +| **RAM Total** | Метрика, показывающая общий объем оперативной памяти, установленный на сервере. | +| **DB Disk Total** | Метрика, показывающая общий объем дискового пространства, выделенного для хранения данных базы данных PostgreSQL на сервере. | +| **CPU Basic** | Метрика, которая показывает детальную разбивку загрузки процессора по типам выполняемых задач. Она позволяет увидеть, на что именно тратится процессорное время на сервере. | +| **Memory Basic** | Метрика, которая показывает детальную разбивку использования оперативной памяти на сервере, а также информацию о SWAP. | +| **Disk IOps** | Метрика, показывающая количество операций чтения и записи, выполняемых на диске сервера в секунду. | +| **Disk Space Used Basic** | Метрика, показывающая процент занятого дискового пространства на всех подключенных файловых системах сервера. | +| **Disk R/W Data** | Показывает объем данных в байтах, читаемых с диска и записываемых на диск в секунду. | +| **Filesystem space available** | Метрика, показывающая объем свободного дискового пространства на файловой системе сервера. | diff --git a/src/PaaS/PostgreSQL/Инструкция по работе с PgAdmin.md b/src/PaaS/PostgreSQL/Инструкция по работе с PgAdmin.md new file mode 100644 index 0000000..e0d67f8 --- /dev/null +++ b/src/PaaS/PostgreSQL/Инструкция по работе с PgAdmin.md @@ -0,0 +1,54 @@ +После предоставления доступа к сервису Cloud PostgreSQL пользователь получает возможность управлять базами данных через веб-интерфейс pgAdmin. Ниже приведена инструкция по входу в систему и выполнению основных операций. +## Вход в pgAdmin + +1. Откройте веб-браузер и перейдите по адресу, предоставленному для доступа к pgAdmin. +2. На странице авторизации введите **логин и пароль от pgAdmin**. +> Учетные данные направляются пользователю на электронную почту при предоставлении доступа. +3. После входа в систему в левой панели навигации откройте раздел **Servers**. +4. Выберите предварительно настроенный сервер с названием **PostgreSQL**. +5. В открывшемся окне введите пароль. +> Важно: на данном этапе необходимо указать **пароль учетной записи базы данных**, а не пароль от pgAdmin. +6. Нажмите **ОК**. +7. После успешной аутентификации станет доступен веб-интерфейс СУБД PostgreSQL. +## Просмотр реплик и параметров конфигурации + +pgAdmin позволяет осуществлять мониторинг реплик, входящих в состав кластера. + +Чтобы просмотреть список реплик: +- Откройте раздел **Replica nodes** в панели навигации. + +Чтобы проверить состояние репликации: +1. Выберите нужную реплику в разделе **Replica nodes**. +2. Перейдите в подраздел **Replication**. +3. Откройте пункт **Replication stats**. +4. Разверните раздел **Подробности** - в нем отображаются все параметры и текущее состояние репликации. +> Вкладка **Replication** позволяет определить, выполняется ли передача данных на дополнительные узлы кластера. + +Так же, есть возможность посмотреть **параметры конфигурации PostgreSQL**, применённых к конкретной реплике. Для этого необходимо перейти в раздел **Конфигурация**, который расположен в блоке **Replica nodes**. + +Во вкладке отображается таблица со следующими колонками: +- **Имя** - наименование конфигурационного параметра; +- **Категория** - логическая группа параметра; +- **Значение** - текущее установленное значение; +- **Единицы** - единицы измерения (если применимо); +- **Описание** - краткое пояснение назначения параметра. +> Вкладка **Конфигурация** предназначена для просмотра текущих настроек реплики. +## Просмотр и управление базами данных + +Для просмотра существующих баз данных: +- Откройте раздел **Базы данных** в панели навигации. В этом разделе отображается перечень всех созданных баз. + +Для создания новой базы данных: +1. Щелкните правой кнопкой мыши по разделу **Базы данных**. +2. В контекстном меню выберите **Создать**, затем - **База данных**. +3. Заполните обязательные поля в открывшейся форме. +4. Нажмите **Сохранить**. +## Роли входа / группы + +В разделе **Роли входа/группы** отображается список пользователей (ролей), имеющих доступ к базам данных кластера. + +Для создания новой роли: +1. Щелкните правой кнопкой мыши по разделу **Роли входа/группы**. +2. Выберите **Создать**, затем - **Роль входа/группы**. +3. Заполните необходимые параметры в форме создания роли. +4. Нажмите **Сохранить**. \ No newline at end of file