Trong hầu hết các trường hợp, các số liệu, biểu đồ và hình ảnh trực quan hóa giám sát ứng dụng mặc định do AppSignal cung cấp sẽ có tác dụng cho ứng dụng Ruby của bạn. Tuy nhiên, bạn có thể là kiểu người dùng thích kiểm soát một chút những gì được đo lường, cách nó hiển thị và cách chuyển tiếp những thông tin quan trọng về ứng dụng của bạn.
AppSignal cho phép bạn tùy chỉnh các số liệu và trang tổng quan ứng dụng theo ý muốn. Trong hướng dẫn này, chúng ta sẽ tìm hiểu tất cả về các chỉ số tùy chỉnh của AppSignal, bao gồm:
- Chỉ số tùy chỉnh là gì
- Các loại chỉ số tùy chỉnh khác nhau mà bạn có thể thiết lập
- Cách tùy chỉnh trực quan hóa biểu đồ
- Cách thiết lập cảnh báo hiệu quả
Và hơn thế nữa!
Nhưng trước khi chúng ta đi sâu vào phần này, bạn sẽ cần thực hiện một số điều sau.
Điều kiện tiên quyết
- Tài khoản AppSignal: Nếu bạn chưa có, hãy đăng ký dùng thử miễn phí 30 ngày.
- Ứng dụng Ruby: Ứng dụng này có thể dựa trên bất kỳ khung Ruby nào được hỗ trợ, như Rails, Sinatra hoặc chỉ đơn giản là Ruby. Ngoài ra, nó có thể là một ứng dụng sản xuất hoặc phát triển. Nếu bạn không muốn tạo ứng dụng của riêng mình, hãy sao chép mã cho ứng dụng Sinatra mẫu mà chúng tôi sẽ sử dụng trong hướng dẫn này.
Lưu ý:Nếu bạn đang sử dụng ứng dụng của riêng mình để làm theo hướng dẫn này, hãy đảm bảo ứng dụng của bạn được định cấu hình để sử dụng đá quý AppSignal Ruby mới nhất, vì các ví dụ được sử dụng trong hướng dẫn này đều giả định trường hợp này xảy ra.
Chỉ số tùy chỉnh là gì?
Ngoài việc đo lường tỷ lệ lỗi, thông lượng và hiệu suất của ứng dụng, bạn có thể quan tâm đến việc đo lường dữ liệu tùy chỉnh được thiết kế riêng cho ứng dụng của riêng bạn. Ví dụ:bạn có thể quan tâm đến số lượng khách truy cập đã đăng ký ứng dụng của bạn trong một khoảng thời gian cụ thể, lớp websocket của ứng dụng đang hoạt động như thế nào, v.v.
Đối với những trường hợp tùy chỉnh như vậy, bạn có thể khó tìm được công cụ đo lường tiêu chuẩn trong AppSignal. Thay vào đó, bạn sẽ cần sử dụng số liệu tùy chỉnh. Chỉ số tùy chỉnh là các chỉ số bổ sung mà bạn xác định cùng với các chỉ số mặc định để hiểu rõ hơn về cách ứng dụng của bạn đang chạy.
Tiếp theo, hãy tìm hiểu cách thiết lập chỉ số tùy chỉnh đầu tiên của chúng tôi.
Thiết lập số liệu tùy chỉnh
Bạn có thể thiết lập số liệu tùy chỉnh cho hầu hết mọi trường hợp sử dụng trong ứng dụng của mình. Hãy bắt đầu với một ví dụ đơn giản để giúp bạn hiểu mọi thứ khớp với nhau như thế nào.
Bước đầu tiên là xác định số liệu tùy chỉnh sẽ được theo dõi trên AppSignal. Bạn có thể xác định chỉ số tùy chỉnh bằng cách sử dụng các loại chỉ số khác nhau có sẵn:
- Thước đo
- Bộ đếm
- Phân phối
Chỉ số tùy chỉnh của thước đo
Trong AppSignal, một thước đo chỉ số tùy chỉnh rất hữu ích để đo lường các chỉ số tăng và giảm theo thời gian.
Hãy thiết lập một thước đo tùy chỉnh đơn giản để đo tổng số bài đăng trong ứng dụng Sinatra mẫu của chúng tôi:
Trong mã hiển thị ở trên, chúng tôi sử dụng Appsignal::Helpers::Metrics mô-đun và gọi set_gauge phương thức chấp nhận ba đối số:
key:tên của số liệu tùy chỉnh. Trong ví dụ này sẽ là all_posts .value- Số liệu hoặc "vật" cần đo. Trong ví dụ hiển thị ở trên, đây chỉ đơn giản là tổng số bài đăng.tags- Siêu dữ liệu bổ sung và tùy chọn có thể được thêm vào số liệu tùy chỉnh và hữu ích cho việc gắn nhãn dữ liệu được đo theo cách bạn muốn. Ví dụ:chúng ta có thể dễ dàng gắn thẻposts_countsố liệu để tính đến môi trường, như minh họa bên dưới:
Tuyệt vời, chúng tôi vừa thêm chỉ số đo tùy chỉnh đầu tiên của mình! Nhưng nếu bạn quay lại AppSignal, số liệu tùy chỉnh mới của bạn sẽ không hiển thị. Thay vào đó, bạn có thể thấy trang tổng quan mặc định như hiển thị bên dưới:
Vậy bạn cần làm gì để số liệu tùy chỉnh xuất hiện? Bạn cần thêm một bảng điều khiển. Bắt đầu bằng việc tạo trang tổng quan mới:
Sau đó đặt tên cho trang tổng quan mới của bạn bằng tiêu đề và mô tả mang tính mô tả:
Sau khi thêm trang tổng quan tùy chỉnh, giờ đây bạn sẽ cần thêm biểu đồ cho chỉ số tùy chỉnh:
Sau đó xác định biểu đồ mới:
Dưới đây là bảng phân tích các trường để thiết lập biểu đồ mới:
- a. Tiêu đề - Nhập tiêu đề mô tả cho biểu đồ mới.
- b. Mô tả - Đây là tùy chọn nhưng bạn có thể nhập mô tả cho biểu đồ mới.
- c. Số liệu - Đây là nơi bạn xác định số liệu sẽ được đo và hiển thị bằng biểu đồ mới. Đây là tên của chỉ số tùy chỉnh hoặc đối số đầu tiên được xác định trong
set_gaugephương thức:all_posts. Trong phần này, bạn cũng có thể xác định các thẻ (ví dụ:thẻ môi trường cũng được bao gồm như hình). - d. Hiển thị biểu đồ - Đây là nơi bạn chọn kiểu hiển thị biểu đồ cho biểu đồ mới của mình.
- e. Nhãn huyền thoại - Bạn có thể tùy chỉnh nhãn cho chú giải biểu đồ tại đây.
- f. Định dạng dữ liệu - Xác định kiểu dữ liệu dùng để hiển thị đồ thị. Bạn có thể chọn từ một số định dạng, bao gồm số lượng, tỷ lệ phần trăm, thông lượng (tính bằng yêu cầu/phút hoặc giờ), thời lượng (tính bằng mili giây) hoặc kích thước tệp (tính bằng byte).
Khi bạn đã xác định chính xác các thuộc tính của biểu đồ mới, bạn sẽ nhận được biểu đồ cho số liệu tùy chỉnh. Điều này tương tự như những gì được hiển thị bên dưới:
Tiếp theo, chúng ta hãy xem loại chỉ số tùy chỉnh tiếp theo:bộ đếm.
Chỉ số tùy chỉnh của bộ đếm
Số liệu tùy chỉnh truy cập rất phù hợp để đo số lần một sự kiện xảy ra. Bằng cách sử dụng ứng dụng ví dụ, chúng tôi có thể áp dụng số liệu truy cập để đo mỗi lần trang chủ (gốc) được truy cập.
Để bắt đầu, hãy chỉnh sửa phương thức gốc để bao gồm mã hiển thị bên dưới:
Ở đây, chúng tôi sử dụng increment_counter của AppSignal phương thức và truyền nó visits_count như đối số đầu tiên. Bước tăng là số nguyên 1, được truyền làm đối số thứ hai. Bạn cũng có thể thêm tags hash làm đối số thứ ba, nhưng chúng ta sẽ giữ nguyên (vì điều này đã được đề cập trong phần trước).
Bây giờ hãy tiếp tục và làm theo các bước như đã nêu cho loại số liệu đo. Thêm biểu đồ tùy chỉnh cho số liệu truy cập này để cung cấp cho bạn biểu đồ tương tự với biểu đồ được hiển thị:
Hãy chuyển sang số liệu tùy chỉnh phân phối.
Chỉ số tùy chỉnh phân phối
Chỉ số tùy chỉnh phân phối AppSignal rất hữu ích để đo lường một số thứ trên một đơn vị thời gian:ví dụ:cần bao nhiêu giây để tạo báo cáo PDF hoặc mất bao lâu để thực thi một công việc nền.
Sử dụng ứng dụng ví dụ, hãy sửa đổi tệp chính để bao gồm lệnh gọi đến điểm cuối API mở. Sau đó, chúng tôi sẽ sử dụng mức phân bổ tùy chỉnh để đo thời lượng của lệnh gọi API tính bằng mili giây.
Bây giờ, nếu quay lại AppSignal, chúng ta có thể xem phân bổ tùy chỉnh dưới dạng biểu đồ.
Mẹo:Bạn có thể làm theo các bước được nêu trong phần thước đo để thiết lập trực quan hóa biểu đồ tùy chỉnh.
Bây giờ bạn đã học cách tạo số liệu tùy chỉnh và trực quan hóa biểu đồ đi kèm, bạn có thể nhận thấy rằng việc tiếp tục quay lại bảng thông tin AppSignal để xem điều gì đang xảy ra với ứng dụng của bạn sẽ không thuận tiện lắm. Thay vào đó, sẽ rất hữu ích nếu bạn có thể nhận được thông báo về các chỉ số tùy chỉnh của mình, phải không?
Tiếp theo hãy tìm hiểu cách thiết lập thông báo cho các chỉ số tùy chỉnh của bạn.
Cảnh báo thông báo
Theo mặc định, bất cứ khi nào xảy ra lỗi hoặc sự kiện hiệu suất, AppSignal sẽ mở một sự cố cho sự kiện đó và đặt nó vào phần liên quan. Ví dụ:nếu đó là lỗi, bạn sẽ tìm thấy nó trong danh sách lỗi, trong khi các sự cố về hiệu suất sẽ nằm trong danh sách hiệu suất.
Ngoài ra, AppSignal gửi thông báo sự cố qua email (kênh thông báo mặc định). Bạn cũng có thể thiết lập các kênh thông báo khác, chẳng hạn như:
- Bất hòa
- Google Hangouts
- Liên lạc nội bộ
- Nhóm Microsoft
- Chậm chạp
- Webhook
Và hơn thế nữa.
Nhưng trước khi chúng tôi thiết lập trình kích hoạt thông báo cho một trong các chỉ số tùy chỉnh của mình, điều quan trọng là bạn phải biết các tùy chọn thông báo khác nhau có sẵn cho bạn.
Để bắt đầu, bạn có thể thiết lập thông báo cho:
- Mọi lúc - Tại đây, thông báo sẽ được gửi đi mỗi khi có sự cố xảy ra.
- Triển khai lần đầu - Điều này cho biết rằng thông báo sẽ được gửi vào lần đầu tiên xảy ra sự cố sau khi triển khai.
- Đầu tiên sau khi đóng - Tại đây, thông báo sẽ được gửi đi bất cứ khi nào sự cố tái diễn sau khi sự cố trước đó đã bị đóng.
- Không bao giờ thông báo - Đúng như tên gọi, trong trường hợp này, thông báo sẽ không bao giờ được gửi nhưng lỗi hoặc sự cố về hiệu suất vẫn sẽ được theo dõi trên AppSignal.
- Mỗi giờ hoặc ngày thứ n - Với tùy chọn này, bạn có thể chỉ định số lượng cảnh báo sẽ được gửi cho bạn trong vòng một giờ hoặc một ngày. Tùy chọn này hoàn hảo để cân bằng giữa việc nhận thông báo về các sự kiện quan trọng và việc có quá nhiều thông báo (điều này có thể dễ dàng khiến bạn hoặc nhóm của bạn choáng ngợp).
Tôi thực sự khuyên bạn nên tìm hiểu tài liệu về cài đặt thông báo của AppSignal để biết thêm thông tin về các tùy chọn này.
Hãy xem cách thiết lập thông báo cho một trong các số liệu tùy chỉnh mà chúng tôi đã thực hiện trước đó. Đây sẽ là một ví dụ đơn giản nhưng sẽ minh họa các bước bạn cần thực hiện cho trường hợp sử dụng của riêng mình.
Thiết lập cảnh báo thông báo cho số liệu tùy chỉnh của bạn
Trong ví dụ này, chúng tôi sẽ sử dụng số liệu phân phối đã đo thời lượng của lệnh gọi API trước đó trong bài đăng này. Giả sử chúng tôi muốn nhận thông báo qua email bất cứ khi nào thời lượng trung bình vượt quá một con số nhất định (tính bằng mili giây).
Các bước để thiết lập tính năng này được hiển thị bên dưới:
Đầu tiên, hãy bắt đầu bằng cách nhấn Kích hoạt liên kết trong menu bên trái.
Đặt tên phù hợp cho trình kích hoạt của bạn, sau đó chọn phép đo cho thông báo này. Trong ví dụ này, chúng tôi đang sử dụng fetch_books_duration số liệu tùy chỉnh phân phối. Bạn cũng có thể thêm thẻ nếu muốn.
Tiếp theo, xác định toán tử so sánh và giá trị cần kiểm tra. Ví dụ:giả sử chúng tôi muốn nhận cảnh báo bất cứ khi nào thời lượng vượt quá 1600 mili giây. Đối với điều này, chúng tôi sẽ chọn toán tử so sánh nhiều hơn , thì giá trị là 1600.
Cuối cùng, bạn sẽ cần xác định cài đặt khởi động và thời gian hồi chiêu cảnh báo. Cung cấp mô tả cho cảnh báo, liên kết đến trang tổng quan để đưa vào thông báo cảnh báo (nếu cần) và cuối cùng là phương thức thông báo (với email là mặc định).
Sau khi thực hiện xong, bạn sẽ nhận được thông báo bất cứ khi nào xảy ra sự cố phù hợp với cài đặt bạn nhập ở đây.
Và thế là xong!
Kết thúc
Trong bài viết này, chúng ta đã tìm hiểu cách thiết lập số liệu tùy chỉnh cho ứng dụng Ruby bằng trang tổng quan và hình ảnh trực quan hóa biểu đồ phù hợp trên AppSignal.
Chức năng số liệu tùy chỉnh mà AppSignal cung cấp có thể được tinh chỉnh cho các ứng dụng rất mạnh. Hãy tìm hiểu kỹ tài liệu về chỉ số tùy chỉnh của AppSignal để khám phá thêm các khả năng.
Cho đến lần sau, chúc bạn viết mã vui vẻ!
Tái bút. Nếu bạn muốn đọc các bài đăng của Ruby Magic ngay khi chúng được đăng tải, hãy đăng ký nhận bản tin Ruby Magic của chúng tôi và không bao giờ bỏ lỡ một bài đăng nào!