Giới thiệu
Logrotate là một tiện ích hệ thống quản lý việc tự động xoay và nén các tệp nhật ký (log files). Nếu các tệp nhật ký không được xoay, nén và cắt bỏ định kỳ, cuối cùng chúng có thể chiếm hết dung lượng đĩa có sẵn trên hệ thống.
Logrotate được cài đặt mặc định trên Ubuntu 20.04 và được thiết lập để xử lý nhu cầu xoay vòng nhật ký của tất cả các gói đã cài đặt, bao gồm rsyslog, bộ xử lý nhật ký hệ thống mặc định.
Trong bài viết này, chúng ta sẽ khám phá cấu hình Logrotate mặc định, sau đó thiết lập cấu hình xoay vòng nhật ký cho một ứng dụng tùy chỉnh hư cấu.
Điều kiện
Hướng dẫn này giả sử bạn có máy chủ Ubuntu 20.04, với non-root sudo-enabled user (không hỗ trợ sudo), như được mô tả trong Thiết lập máy chủ ban đầu với Ubuntu 20.04.
Logrotate cũng có sẵn trên nhiều bản phân phối Linux khác, nhưng cấu hình mặc định có thể khác. Các phần khác của hướng dẫn này vẫn sẽ áp dụng, miễn là phiên bản Logrotate của bạn tương tự như Ubuntu 20.04. Làm theo Bước 1 để xác định phiên bản Logrotate của bạn.
Đăng nhập vào máy chủ của bạn với tư cách là sudo-enabled user của bạn để bắt đầu.
Bước 1: Xác nhận phiên bản Logrotate của bạn
Logrotate được cài đặt theo mặc định trên Ubuntu. Tuy nhiên, nếu bạn cần cài đặt nó, hãy chạy các lệnh sau để cập nhật danh sách gói của bạn và truy xuất gói:
Nếu bạn đang sử dụng máy chủ không phải Ubuntu, trước tiên hãy đảm bảo rằng Logrotate đã được cài đặt bằng cách yêu cầu thông tin phiên bản của nó:
Outputlogrotate 3.14.0
Default mail command: /usr/bin/mail
Default compress command: /bin/gzip
Default uncompress command: /bin/gunzip
Default compress extension: .gz
Default state file path: /var/lib/logrotate/status
ACL support: yes
SELinux support: yes
Nếu Logrotate được cài đặt nhưng số phiên bản khác nhau đáng kể, bạn có thể gặp sự cố với một số tùy chọn cấu hình được khám phá trong hướng dẫn này. Tham khảo tài liệu dành cho phiên bản Logrotate cụ thể của bạn bằng cách đọc trang hướng dẫn sử dụng (man) của nó:
Bạn cũng có thể tham khảo phiên bản trực tuyến của tài liệu Logrotate. Tiếp theo, chúng ta sẽ xem xét cấu trúc cấu hình mặc định của Logrotate trên Ubuntu.
Bước 2: Khám phá cấu hình Logrotate
Thông tin cấu hình của Logrotate thường có thể được tìm thấy ở hai nơi trên Ubuntu:
/etc/logrotate.conf: tệp này chứa một số cài đặt mặc định và thiết lập xoay vòng cho một số nhật ký không thuộc sở hữu của bất kỳ gói hệ thống nào. Nó cũng sử dụng câu lệnhincludeđể lấy cấu hình từ bất kỳ tệp nào trong thư mục/etc/logrotate.d./etc/logrotate.d/: đây là nơi bất kỳ gói nào bạn cài đặt cần trợ giúp xoay vòng nhật ký sẽ đặt cấu hình Logrotate của chúng. Trên bản cài đặt tiêu chuẩn, bạn nên có các tệp ở đây cho các công cụ hệ thống cốt lõi nhưapt,dpkg,rsyslog, v.v.
Theo mặc định, logrotate.conf sẽ thiết lập cấu hình luân phiên nhật ký hàng tuần, với các tệp nhật ký thuộc sở hữu của root user và syslog group, với bốn tệp nhật ký được giữ lại cùng một lúc (rotate 4) và các tệp nhật ký trống mới được tạo sau tệp hiện tại được xoay (create).
Hãy xem tệp cấu hình Logrotate của gói trong /etc/logrotate.d. cat tệp cho tiện ích gói apt:
Output/var/log/apt/term.log {
rotate 12
monthly
compress
missingok
notifempty
}
/var/log/apt/history.log {
rotate 12
monthly
compress
missingok
notifempty
}
Tệp này chứa các khối cấu hình cho hai tệp nhật ký khác nhau trong thư mục /var/log/apt/: term.log và history.log. Cả hai đều có các tùy chọn giống nhau. Bất kỳ tùy chọn nào không được đặt trong các khối cấu hình này sẽ kế thừa các giá trị mặc định hoặc các giá trị được đặt trong /etc/logrotate.conf. Mọi cài đặt trong tệp logrotate sẽ ghi đè các giá trị mặc định của logrotate, được thiết lập cấu hình trong /etc/logrotate.conf. Các tùy chọn được đặt cho nhật ký apt là:
rotate 12: giữ mười hai tệp nhật ký cũ. Điều này ghi đè mặc định rotate 4.monthly: luân phiên mỗi tháng một lần. Điều này ghi đè mặc địnhweekly.compress: nén các tập tin đã xoay. Điều này sử dụnggziptheo mặc định và dẫn đến các tệp kết thúc bằng.gz. Lệnh nén có thể được thay đổi bằng cách sử dụng tùy chọncompresscmd.missingok: không viết thông báo lỗi nếu thiếu tệp nhật ký.notifempty: không xoay tệp nhật ký nếu nó trống.
Các tệp cấu hình này cũng kế thừa hành vi create mặc định, hướng dẫn Logrotate tạo nhật ký mới sau khi xoay. Điều này có thể được ghi đè với nocreate, mặc dù điều đó sẽ vô hiệu hóa hiệu quả hầu hết các chức năng khác.
Có nhiều tùy chọn cấu hình hơn có sẵn. Bạn có thể đọc về tất cả chúng bằng cách gõ man logrotate trên dòng lệnh để hiển thị trang hướng dẫn sử dụng Logrotate.
Tiếp theo, chúng ta sẽ thiết lập một tệp cấu hình để xử lý nhật ký cho một dịch vụ hư cấu có tên là your-app.
Bước 3: Thiết lập cấu hình mẫu
Để quản lý các tệp nhật ký bằng logrotate cho các ứng dụng bên ngoài các dịch vụ hệ thống được đóng gói sẵn và cấu hình sẵn, chúng ta có hai tùy chọn:
- Tạo tệp cấu hình Logrotate mới và đặt nó vào
/etc/logrotate.d/. Điều này sẽ được chạy hàng ngày với tư cách là root user cùng với tất cả các công việc Logrotate tiêu chuẩn khác. - Tạo tệp cấu hình mới và chạy nó bên ngoài thiết lập Logrotate mặc định của Ubuntu. Điều này chỉ thực sự cần thiết nếu bạn cần chạy Logrotate với tư cách là non-root user hoặc nếu bạn muốn xoay nhật ký thường xuyên hơn hàng ngày (cấu hình
hourlytrong/etc/logrotate.d/sẽ không hiệu quả, vì thiết lập Logrotate của hệ thống chỉ chạy một lần một ngày).
Hãy xem xét hai tùy chọn này với một số thiết lập mẫu.
Thêm cấu hình vào /etc/logrotate.d/
Chúng ta muốn thiết lập cấu hình xoay vòng nhật ký cho một máy chủ web hư cấu đặt access.log và error.log vào /var/log/your-app/. Nó chạy với tư cách là www-data user và group.
Để thêm cấu hình cho các tệp nhật ký ứng dụng của bạn vào /etc/logrotate.d/, trước tiên hãy mở một tệp mới trong thư mục /etc/logrotate.d bằng nano hoặc trình soạn thảo ưa thích của bạn:
Thêm các dòng sau vào tệp cấu hình mới của bạn:
Một số chỉ thị cấu hình mới trong tệp này là:
create 0640 www-data www-data: điều này tạo một tệp nhật ký trống mới sau khi xoay vòng, với các quyền được chỉ định (0640, chủ sở hữu (www-data) và nhóm (cũng làwww-data).sharedscripts: cờ này có nghĩa là bất kỳ tập lệnh nào được thêm vào cấu hình chỉ được chạy một lần cho mỗi lần chạy, thay vì cho từng tệp được xoay vòng. Vì đường dẫn/var/log/your-app/*.logbao gồm ký tự đại diện*, cấu hình này sẽ khớp với bất kỳ số lượng tệp nhật ký nào trong thư mụcyour-app. Nếu không có tùy chọnsharedscripts, tập lệnh được chỉ định trongpostrotatesẽ chạy mỗi khi logrotate xử lý tệp nhật ký mà không có tùy chọn này.postrotatetớiendscript: khối này chứa tập lệnh để chạy sau khi xoay tệp nhật ký. Trong trường hợp này, chúng ta đang tải lại ứng dụng mẫu của mình. Điều này đôi khi cần thiết để ứng dụng của bạn chuyển sang tệp nhật ký mới được tạo. Lưu ý rằngpostrotatechạy trước khi các bản ghi được nén. Quá trình nén có thể mất nhiều thời gian và phần mềm của bạn sẽ chuyển sang tệp nhật ký mới ngay lập tức. Đối với các tác vụ cần chạy sau khi nén nhật ký, hãy sử dụng khốilastactionthay thế.
Để lưu và thoát nano, hãy nhấn Ctrl + X, và khi được nhắc, hãy nhấn Y rồi nhấn Enter. Bạn có thể kiểm tra tệp cấu hình bằng cách chạy thử:
Lệnh này gọi logrotate, trỏ nó đến tệp cấu hình tiêu chuẩn và bật chế độ gỡ lỗi.
Thông tin sẽ in ra các tệp nhật ký mà Logrotate đang xử lý và nó sẽ làm gì với chúng. Nếu tất cả đều ổn, bạn đã hoàn tất. Công việc Logrotate tiêu chuẩn sẽ chạy mỗi ngày một lần và bao gồm cấu hình mới của bạn.
Tiếp theo, chúng ta sẽ thử một thiết lập hoàn toàn không sử dụng cấu hình mặc định của Ubuntu.
Bước 4: Tạo cấu hình Logrotate độc lập
Trong ví dụ này, chúng ta có một ứng dụng đang chạy dưới dạng user sammy, tạo nhật ký được lưu trữ trong /home/sammy/logs/. Chúng ta muốn xoay các nhật ký này hàng giờ, vì vậy chúng ta cần thiết lập điều này bên ngoài cấu trúc /etc/logrotate.d được cung cấp bởi Ubuntu.
Trước tiên, chúng ta sẽ tạo một tệp cấu hình trong thư mục chính của chúng ta. Mở nó trong một trình soạn thảo văn bản:
Sau đó, dán vào cấu hình sau:
Lưu và đóng tập tin. Chúng ta đã gặp tất cả các tùy chọn này trong các bước trước, nhưng hãy tóm tắt: cấu hình này sẽ xoay các tệp hàng giờ, nén và giữ hai mươi bốn nhật ký cũ và tạo một tệp nhật ký mới để thay thế tệp đã xoay.
Bạn sẽ cần tùy chỉnh cấu hình cho phù hợp với ứng dụng của mình, nhưng đây là một khởi đầu tốt.
Để kiểm tra xem cấu hình có hoạt động hay không, hãy tạo một tệp nhật ký. Đầu tiên cd vào thư mục chính của user của bạn bằng lệnh cd ~. Sau đó, tạo một thư mục cho các bản ghi bằng lệnh mkdir. Cuối cùng tạo một tệp trống trong thư mục logs bằng lệnh touch. Chạy các lệnh sau để hoàn thành các bước sau:
Bây giờ chúng ta có một tệp nhật ký trống ở đúng vị trí, hãy chạy lệnh logrotate.
Vì nhật ký thuộc sở hữu của sammy nên chúng ta không cần sử dụng sudo. Tuy nhiên, chúng ta cần chỉ định một tệp trạng thái. Tệp này ghi lại những gì logrotate đã tìm thấy và bất kỳ hành động nào mà nó đã thực hiện vào lần cuối cùng nó chạy, để nó biết phải làm gì trong lần chạy tiếp theo. Theo dõi trạng thái này được xử lý cho chúng ta khi sử dụng cấu hình /etc/logrotate.conf mặc định. Tệp trạng thái được lưu trữ trong /var/lib/logrotate/status. Vì chúng ta không sử dụng cấu hình mặc định, chúng ta sẽ cần định cấu hình vị trí tệp trạng thái theo cách thủ công.
Chúng ta sẽ yêu cầu Logrotate đặt tệp trạng thái ngay trong thư mục chính của chúng ta cho ví dụ này. Nó có thể đến bất cứ nơi nào có thể tiếp cận và thuận tiện. Chạy lệnh sau để sử dụng /home/sammy/logrotate.conf mà bạn đã tạo và ghi lại trạng thái mà logrotate gặp phải:
Outputreading config file /home/sammy/logrotate.conf
Handling 1 logs
rotating pattern: /home/sammy/logs/*.log hourly (24 rotations)
empty log files are rotated, old logs are removed
considering log /home/sammy/logs/access.log
log does not need rotating
Cờ --verbose sẽ in ra thông tin chi tiết về những gì Logrotate đang làm. Trong trường hợp này, nó không xoay bất cứ thứ gì. Đây là lần đầu tiên Logrotate gặp phải tệp nhật ký này và nó đã có từ 0 giờ nên không nên xoay.
Nếu chúng ta kiểm tra tệp trạng thái bằng tiện ích cat, chúng ta sẽ lưu ý rằng Logrotate đã ghi lại một số thông tin về quá trình chạy:
Outputlogrotate state -- version 2
"/home/sammy/logs/access.log" 2021-12-3-19:0:0
Logrotate ghi nhận các bản ghi mà nó đã nhìn thấy và thời điểm nó xem xét chúng để quay vòng lần cuối. Nếu chúng ta chạy cùng lệnh này một giờ sau đó, nhật ký sẽ được xoay như mong đợi.
Nếu bạn muốn buộc Logrotate xoay tệp nhật ký khi nó không có, hãy sử dụng cờ --force:
Điều này rất hữu ích khi kiểm tra postrotate và các tập lệnh khác.
Cuối cùng, chúng ta cần thiết lập một công việc cron để chạy Logrotate mỗi giờ. Mở crontab của user của bạn:
Thao tác này sẽ mở một tệp văn bản. Nếu đây là lần đầu tiên bạn sử dụng cron, bạn có thể được nhắc chọn một trình soạn thảo văn bản mặc định. Nếu bạn không có sở thích, chúng tôi khuyên bạn nên sử dụng nano cho người dùng mới. Có thể có một số nhận xét đã có trong tệp giải thích cú pháp cron. Di chuyển con trỏ xuống một dòng trống mới ở cuối tệp và thêm phần sau:
Nhiệm vụ này sẽ chạy vào phút thứ 14 hàng giờ, hàng ngày. Nó chạy gần giống lệnh logrotate mà chúng ta đã chạy trước đó, mặc dù chúng ta đã mở rộng logrotate thành đường dẫn đầy đủ của nó là /usr/sbin/logrotate để an toàn. Bạn nên sử dụng các đường dẫn đầy đủ khi viết cron jobs. Để tìm hiểu thêm về cron, bạn có thể xem lại các hướng dẫn khác của chúng tôi.
Lưu file và thoát. Thao tác này sẽ cài đặt crontab và tác vụ của chúng ta sẽ chạy theo lịch trình đã chỉ định.
Nếu chúng ta truy cập lại thư mục nhật ký của mình trong khoảng một giờ, chúng ta sẽ tìm thấy tệp nhật ký đã xoay và nén access.log.1.gz (hoặc .2.gz nếu bạn chạy Logrotate với cờ --force).
Kết luận
Trong hướng dẫn này, chúng ta đã xác minh phiên bản Logrotate của mình, khám phá cấu hình Ubuntu Logrotate mặc định và thiết lập hai loại cấu hình tùy chỉnh khác nhau. Để tìm hiểu thêm về dòng lệnh và các tùy chọn cấu hình có sẵn cho Logrotate, bạn có thể đọc trang hướng dẫn sử dụng của nó bằng cách chạy man logrotate trong thiết bị đầu cuối của bạn hoặc bằng cách truy cập tài liệu trực tuyến.