Description= и Documentation= в unit-файле
Description= задаёт человеческое название unit, которое systemd печатает в состоянии и в журнале. Documentation= перечисляет ссылки на документацию, доступные через systemctl status.
Что делает
Описание попадает во все сообщения: «Started ...», «Failed to start ...». Без него в журнале будет только имя unit, и при разборе аварии на незнакомой машине это заметно замедляет работу.
Ссылки на документацию выводит systemctl status и открывает systemctl help имя. Для своих служб туда полезно положить ссылку на внутреннюю страницу с описанием.
Где ставится. В секции [Unit].
Значения
| Значение | Что происходит |
|---|---|
Description=Платёжный API | короткая фраза, без слова «служба» и без точки в конце. |
Documentation=https://wiki.internal/payments | ссылка на документацию. |
Documentation=man:myapp(8) | ссылка на страницу руководства. |
Пример
Описание и ссылка на внутреннюю документацию.
[Unit]
Description=Платёжный API (обработка транзакций)
Documentation=https://wiki.internal/services/payments
Documentation=man:payments(8)Типичные ошибки
Описание вида «My service» бесполезно: в журнале оно ничего не уточняет.
Точка в конце описания выглядит в сообщениях лишней: systemd добавляет её сам.
Отсутствие описания не ошибка, но в аварийной ситуации осложняет чтение журнала.
Связанные ошибки
- Unit file is bad и ошибки разбора unit-файлаsystemd не может разобрать unit-файл: неизвестные параметры, ошибки в секциях, недопустимые значения. Как найти проблемную строку.
Рядом стоящие параметры
Источники
- systemd.unit(5)
- Воспроизведено на тестовой машине, systemd 255 (Ubuntu 24.04)