02 курс

Спринт 2

спринт 1
Пакет log. Логирование в приложении
5/5
Введение в спринт 2
Стандартные и сторонние пакеты для логирования
Логирование через middleware
Инкремент 6
Что вы узнали
Пакет encoding. Сериализация и десериализация данных
7/7
Пакет compress. Сжатие данных
3/3
Пакет os. Операции с файлами
4/5
Спринт 1/3 → Тема 1/4: Пакет log. Логирование в приложении → Урок 1/5

Введение в спринт 2

Дзынь! Звонок в дверь вашей квартиры.
Кто там?
Мне? Неожиданно!
Вы благодарите курьера, закрываете дверь и несёте коробку в комнату.
Так-с, посмотрим, что там.
Поздравляем! Вы успешно прошли первый спринт и в награду получаете умную колонку.
Саша, Гоша, Лиза
Вот это да! Алиса, привет!
Алиса
Здравствуйте! Как ваши дела? Как прошёл день? Что нового?
Э, погоди-погоди, успеем наобщаться. В коробке было что-то ещё.
Как и прежде, чтобы спланировать своё время для выполнения инкрементов и сфокусироваться на важных вещах, вы можете заранее посмотреть все ТЗ по второму спринту.
Развернуть

Инкремент 6

Задание по треку «Сервис сокращения URL»

Реализуйте логирование сведений о запросах и ответах на сервере для всех эндпоинтов, которые у вас уже есть.
  • Сведения о запросах должны содержать URI, метод запроса и время, затраченное на его выполнение.
  • Сведения об ответах должны содержать код статуса и размер содержимого ответа.
Эту функциональность нужно реализовать через middleware. Используйте один из сторонних пакетов для логирования:
  • github.com/rs/zerolog,
  • go.uber.org/zap,
  • github.com/sirupsen/logrus.
Все сообщения логера должны быть на уровне Info.

Задание по треку «Сервис сбора метрик и алертинга»

Реализуйте логирование сведений о запросах и ответах на сервере для всех эндпоинтов, которые у вас уже есть.
  • Сведения о запросах должны содержать URI, метод запроса и время, затраченное на его выполнение.
  • Сведения об ответах должны содержать код статуса и размер содержимого ответа.
Эту функциональность нужно реализовать через middleware. Используйте один из сторонних пакетов для логирования:
  • github.com/rs/zerolog,
  • go.uber.org/zap,
  • github.com/sirupsen/logrus.
Все сообщения логера должны быть на уровне Info.

Инкремент 7

Задание по треку «Сервис сокращения URL»

Добавьте в код сервера новый эндпоинт POST /api/shorten, который будет принимать в теле запроса JSON-объект {"url":"<some_url>"} и возвращать в ответ объект {"result":"<short_url>"}.
Запрос может иметь такой вид:
TEXT
POST http://localhost:8080/api/shorten HTTP/1.1
Host: localhost:8080
Content-Type: application/json
{
  "url": "https://practicum.yandex.ru"
}
Ответ может быть таким:
TEXT
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 30
{
 "result": "http://localhost:8080/EwHXdJfB"
}
Не забудьте добавить тесты на новый эндпоинт, как и на предыдущие.
При реализации задействуйте одну из распространённых библиотек:
  • encoding/json,
  • github.com/mailru/easyjson,
  • github.com/pquerna/ffjson.

Задание по треку «Сервис сбора метрик и алертинга»

Дополните API сервера, чтобы позволить ему принимать метрики в формате JSON.
При реализации задействуйте одну из распространённых библиотек:
  • encoding/json,
  • github.com/mailru/easyjson,
  • github.com/pquerna/ffjson.
Обмен с сервером организуйте с использованием следующей структуры:
  type Metrics struct {
     ID    string   `json:"id"`              // имя метрики
     MType string   `json:"type"`            // параметр, принимающий значение gauge или counter
     Delta *int64   `json:"delta,omitempty"` // значение метрики в случае передачи counter
     Value *float64 `json:"value,omitempty"` // значение метрики в случае передачи gauge
  }
Для передачи метрик на сервер используйте Content-Type: application/json. В теле запроса должен быть описанный выше JSON. Передавать метрики нужно через POST update/. В теле ответа отправляйте JSON той же структуры с актуальным (изменённым) значением Value.
Для получения метрик с сервера также используйте Content-Type: application/json. В теле запроса должен быть описанный выше JSON с заполненными полями ID и MType. Запрашивать нужно через POST value/. В теле ответа должен приходить такой же JSON, но с уже заполненными значениями метрик.
Переведите агент на новый API.
Автотесты проверяют, что агент экспортирует и обновляет на сервере метрики, описанные в первых инкрементах.

Инкремент 8

Задание по треку «Сервис сокращения URL»

Добавьте поддержку gzip в ваш сервис. Научите его:
  • Принимать запросы в сжатом формате (с HTTP-заголовком Content-Encoding).
  • Отдавать сжатый ответ клиенту, который поддерживает обработку сжатых ответов (с HTTP-заголовком Accept-Encoding).
Функция сжатия должна работать для контента с типами application/json и text/html.
Вспомните middleware из урока про HTTP-сервер, это может вам помочь.

Задание по треку «Сервис сбора метрик и алертинга»

Добавьте поддержку gzip в код сервера и агента. Научите:
  • Агент передавать данные в формате gzip.
  • Сервер опционально принимать запросы в сжатом формате (при наличии соответствующего HTTP-заголовка Content-Encoding).
  • Отдавать сжатый ответ клиенту, который поддерживает обработку сжатых ответов (с HTTP-заголовком Accept-Encoding).
Функция сжатия должна работать для контента с типами application/json и text/html.
Вспомните middleware из урока про HTTP-сервер, это может вам помочь.

Инкремент 9

Задание по треку «Сервис сокращения URL»

Сохраните все сокращённые URL на диск в виде файла. При перезапуске сервера все URL должны быть восстановлены.
Сервер должен принимать соответствующие параметры конфигурации через флаги и переменные окружения:
  • Флаг -f, переменная окружения FILE_STORAGE_PATH — полное имя файла, куда сохраняются данные в формате JSON (по умолчанию /tmp/short-url-db.json, пустое значение отключает функцию записи на диск).
Пример содержимого файла:
JSON
{"uuid":"1","short_url":"4rSPg8ap","original_url":"http://yandex.ru"}
{"uuid":"2","short_url":"edVPg3ks","original_url":"http://ya.ru"}
{"uuid":"3","short_url":"dG56Hqxm","original_url":"http://practicum.yandex.ru"}
Приоритет параметров сервера должен быть таким:
  • Если указана переменная окружения, то используется она.
  • Если нет переменной окружения, но есть флаг, то используется он.
  • Если нет ни переменной окружения, ни флага, то используется значение по умолчанию.

Задание по треку «Сервис сбора метрик и алертинга»

Доработайте код сервера, чтобы он мог с заданной периодичностью сохранять текущие значения метрик на диск в указанный файл, а на старте — опционально загружать сохранённые ранее значения. При штатном завершении сервера все накопленные данные должны сохраняться.
Сервер должен принимать соответствующие параметры конфигурации через флаги и переменные окружения:
  • Флаг -i, переменная окружения STORE_INTERVAL — интервал времени в секундах, по истечении которого текущие показания сервера сохраняются на диск (по умолчанию 300 секунд, значение 0 делает запись синхронной).
  • Флаг -f, переменная окружения FILE_STORAGE_PATH — полное имя файла, куда сохраняются текущие значения (по умолчанию /tmp/metrics-db.json, пустое значение отключает функцию записи на диск).
  • Флаг -r, переменная окружения RESTORE — булево значение (true/false), определяющее, загружать или нет ранее сохранённые значения из указанного файла при старте сервера (по умолчанию true).
Приоритет параметров сервера должен быть таким:
  • Если указана переменная окружения, то используется она.
  • Если нет переменной окружения, но есть флаг, то используется он.
  • Если нет ни переменной окружения, ни флага, то используется значение по умолчанию.
Ага, вот и карта второго спринта.
Алиса
Кажется, кто-то мечтает о доме на колёсах.
Ты о чём?
Вы оборачиваетесь и видите такую картину.
Нет, Гофер, это не пылесос. Слезай давай. Нам нужно собираться на работу.
Алиса
Возьмёте меня с собой?
Почему бы и нет!