Triển khai trình bổ trợ Norconex HTTP Collector Indexer

Hướng dẫn này dành cho quản trị viên trình bổ trợ chỉ mục của Google Cloud Search Norconex HTTP Collector, tức là bất cứ ai chịu trách nhiệm tải xuống, triển khai, định cấu hình và duy trì trình bổ trợ trình lập chỉ mục. Hướng dẫn này giả định rằng bạn đã quen thuộc với các hệ điều hành Linux, các nguyên tắc cơ bản về thu thập dữ liệu web, XML và Norconex HTTP Collector.

Tài liệu hướng dẫn này bao gồm thông tin về cách thực hiện các tác vụ chính liên quan đến việc triển khai trình bổ trợ cho trình bổ trợ chỉ mục:

  • Tải phần mềm trình bổ trợ trình lập chỉ mục xuống
  • Định cấu hình Google Cloud Search
  • Định cấu hình Trình thu thập HTTP Norconex và thu thập thông tin trên web
  • Bắt đầu thu thập thông tin web và tải nội dung lên

Thông tin về những thao tác mà quản trị viên Google Workspace phải thực hiện để ánh xạ Google Cloud Search với trình bổ trợ trình lập chỉ mục Norconex HTTP Collector không xuất hiện trong hướng dẫn này. Để biết thông tin về các nhiệm vụ đó, hãy xem bài viết Quản lý nguồn dữ liệu của bên thứ ba.

Tổng quan về trình bổ trợ chỉ mục Cloud Search Norconex HTTP Collector

Theo mặc định, Cloud Search có thể khám phá, lập chỉ mục và phân phát nội dung trên các sản phẩm của Google Workspace, như Google Tài liệu và Gmail. Bạn có thể mở rộng phạm vi tiếp cận của Google Cloud Search để bao gồm việc phân phát nội dung web cho người dùng bằng cách triển khai trình bổ trợ trình lập chỉ mục cho Norconex HTTP Collector, một trình thu thập dữ liệu web nguồn mở dành cho doanh nghiệp.

Tệp thuộc tính cấu hình

Để cho phép trình bổ trợ trình lập chỉ mục thực hiện việc thu thập dữ liệu web và tải nội dung lên API lập chỉ mục, với tư cách là quản trị viên trình bổ trợ chỉ mục, bạn phải cung cấp thông tin cụ thể trong các bước định cấu hình được mô tả trong tài liệu này trong phần Các bước triển khai.

Để sử dụng trình bổ trợ trình lập chỉ mục, bạn phải đặt các thuộc tính trong 2 tệp cấu hình:

  • {gcs-crawl-config.xml}-- chứa các chế độ cài đặt dành cho Trình thu thập HTTP Norconex.
  • sdk-configuration.properties-- chứa các chế độ cài đặt dành cho Google Cloud Search.

Các thuộc tính trong mỗi tệp cho phép trình bổ trợ trình lập chỉ mục của Google Cloud Search và Norconex HTTP Collector giao tiếp với nhau.

Thu thập thông tin web và tải nội dung lên

Sau khi điền sẵn các tệp cấu hình, bạn có các chế độ cài đặt cần thiết để bắt đầu thu thập thông tin trên web. Norconex HTTP Collector thu thập dữ liệu web, khám phá nội dung tài liệu có liên quan đến cấu hình và tải các phiên bản nhị phân (hoặc văn bản) gốc của nội dung tài liệu lên API lập chỉ mục Cloud Search, nơi nội dung được lập chỉ mục và cuối cùng được phân phát cho người dùng của bạn.

Hệ điều hành được hỗ trợ

Bạn phải cài đặt Trình bổ trợ chỉ mục của Google Cloud Search Norconex HTTP Collector trên Linux.

Phiên bản Norconex HTTP Collector được hỗ trợ

Trình bổ trợ chỉ mục của Google Cloud Search Norconex HTTP Collector hỗ trợ phiên bản 2.8.0.

Hỗ trợ Danh sách kiểm soát quyền truy cập (ACL)

Trình bổ trợ trình lập chỉ mục hỗ trợ việc kiểm soát quyền truy cập vào các tài liệu trong miền Google Workspace bằng cách sử dụng Danh sách kiểm soát quyền truy cập (ACL).

Nếu ACL mặc định được bật trong cấu hình trình bổ trợ Google Cloud Search (defaultAcl.mode được đặt thành none khác và được định cấu hình bằng defaultAcl.*), thì trước tiên, trình bổ trợ trình lập chỉ mục sẽ cố gắng tạo và áp dụng ACL mặc định.

Nếu không bật các danh sách kiểm soát quyền truy cập (ACL) mặc định, thì trình bổ trợ sẽ quay lại cấp quyền đọc cho toàn bộ miền Google Workspace.

Để biết nội dung mô tả chi tiết về các tham số cấu hình ACL, hãy xem bài viết Thông số trình kết nối do Google cung cấp.

Điều kiện tiên quyết

Trước khi triển khai trình bổ trợ trình chỉ mục, hãy đảm bảo bạn có các thành phần bắt buộc sau:

  • Java JRE 1.8 được cài đặt trên máy tính chạy trình bổ trợ trình lập chỉ mục

  • Những thông tin cần thiết về Google Workspace để thiết lập mối quan hệ giữa Cloud Search và Norconex HTTP Collector:

    Thông thường, quản trị viên Google Workspace của miền có thể cung cấp những thông tin đăng nhập này cho bạn.

Các bước triển khai

Để triển khai trình bổ trợ trình lập chỉ mục, hãy làm theo các bước sau:

  1. Cài đặt Norconex HTTP Collector và phần mềm trình bổ trợ lập chỉ mục
  2. Định cấu hình Google Cloud Search
  3. Định cấu hình Trình thu thập HTTP Norconex
  4. Định cấu hình tính năng thu thập thông tin web
  5. Bắt đầu thu thập thông tin trên web và tải nội dung lên

Bước 1: Cài đặt Norconex HTTP Collector và phần mềm plugin cho trình lập chỉ mục

  1. Tải phần mềm cam kết Norconex xuống từ trang này.
  2. Giải nén phần mềm đã tải xuống vào thư mục ~/norconex/
  3. Sao chép trình bổ trợ uỷ quyền trên GitHub. git clone https://github.com/google-cloudsearch/norconex-committer-plugin.git, sau đó là cd norconex-committer-plugin
  4. Hãy xem phiên bản trình bổ trợ uỷ quyền mong muốn và tạo tệp ZIP: git checkout tags/v1-0.0.3 và mvn package (Để bỏ qua các kiểm thử khi tạo trình kết nối, hãy sử dụng mvn package -DskipTests.)
  5. cd target
  6. Sao chép tệp jar của trình bổ trợ đã tạo vào thư mục norconex lib. cp google-cloudsearch-norconex-committer-plugin-v1-0.0.3.jar ~/norconex/norconex-collector-http-{version}/lib
  7. Giải nén tệp ZIP bạn vừa tạo rồi giải nén tệp: unzip google-cloudsearch-norconex-committer-plugin-v1-0.0.3.zip
  8. Thực thi tập lệnh cài đặt để sao chép .jar của trình bổ trợ và tất cả thư viện bắt buộc vào thư mục của trình thu thập http:
    1. Thay đổi đối với trình bổ trợ trình uỷ quyền đã giải nén đã giải nén ở trên: cd google-cloudsearch-norconex-committer-plugin-v1-0.0.3
    2. Thực thi $ sh install.sh và cung cấp đường dẫn đầy đủ đến norconex/norconex-collector-http-{version}/lib dưới dạng thư mục mục tiêu khi được nhắc.
    3. Nếu tìm thấy các tệp jar trùng lặp, hãy chọn lựa chọn 1 (Chỉ sao chép Jar nguồn nếu phiên bản lớn hơn hoặc giống với phiên bản Jar mục tiêu sau khi đổi tên Jar đích).

Bước 2: Định cấu hình Google Cloud Search

Để trình bổ trợ trình lập chỉ mục kết nối với Norconex HTTP Collector và lập chỉ mục nội dung liên quan, bạn phải tạo tệp cấu hình Cloud Search trong thư mục Norconex HTTP Collector được cài đặt. Bạn nên đặt tên cho tệp cấu hình Cloud Search là sdk-configuration.properties.

Tệp cấu hình này phải chứa cặp giá trị/khoá xác định thông số. Tệp cấu hình phải chỉ định ít nhất các thông số cần thiết sau đây để truy cập vào nguồn dữ liệu của Cloud Search.

Xem xét Thông số
Mã nguồn dữ liệu api.sourceId = 1234567890abcdef
Bắt buộc. Mã nguồn trên Cloud Search do quản trị viên Google Workspace thiết lập.
Tài khoản dịch vụ api.serviceAccountPrivateKeyFile = ./PrivateKey.json
Bắt buộc. Tệp khoá tài khoản dịch vụ Cloud Search do quản trị viên Google Workspace tạo để hỗ trợ tiếp cận của trình bổ trợ chỉ mục.

Ví dụ sau đây cho thấy một tệp sdk-configuration.properties.

#
# data source access
api.sourceId=1234567890abcdef
api.serviceAccountPrivateKeyFile=./PrivateKey.json
#

Tệp cấu hình cũng có thể chứa các tham số cấu hình do Google cung cấp. Những tham số này có thể ảnh hưởng đến cách trình bổ trợ này đẩy dữ liệu vào Google Cloud Search API. Ví dụ: tập hợp tham số batch.* xác định cách trình kết nối kết hợp các yêu cầu.

Nếu bạn không xác định thông số trong tệp cấu hình, thì hệ thống sẽ sử dụng giá trị mặc định (nếu có). Để biết nội dung mô tả chi tiết về từng thông số, hãy xem bài viết Các thông số trình kết nối do Google cung cấp.

Bạn có thể định cấu hình trình bổ trợ trình lập chỉ mục để điền siêu dữ liệu và dữ liệu có cấu trúc cho nội dung được lập chỉ mục. Giá trị được điền cho các trường siêu dữ liệu và trường dữ liệu có cấu trúc có thể được trích xuất từ các thẻ meta trong nội dung HTML đang được lập chỉ mục hoặc có thể chỉ định giá trị mặc định trong tệp cấu hình.

Chế độ cài đặt Tham số
Tiêu đề itemMetadata.title.field=movieTitle
itemMetadata.title.defaultValue=Gone with the Wind
Theo mặc định, trình bổ trợ này sử dụng HTML title làm tiêu đề cho tài liệu đang được lập chỉ mục. Trong trường hợp thiếu tiêu đề, bạn có thể tham chiếu đến thuộc tính siêu dữ liệu có chứa giá trị tương ứng với tiêu đề tài liệu hoặc đặt giá trị mặc định.
Dấu thời gian đã tạo itemMetadata.createTime.field=releaseDate
itemMetadata.createTime.defaultValue=1940-01-17
Thuộc tính siêu dữ liệu chứa giá trị cho dấu thời gian tạo tài liệu.
Lần sửa cuối itemMetadata.updateTime.field=releaseDate
itemMetadata.updateTime.defaultValue=1940-01-17
Thuộc tính siêu dữ liệu chứa giá trị của dấu thời gian sửa đổi gần đây nhất đối với tài liệu.
Ngôn ngữ của giấy tờ itemMetadata.contentLanguage.field=languageCode
itemMetadata.contentLanguage.defaultValue=en-US
Ngôn ngữ cho nội dung của tài liệu được lập chỉ mục.
Loại đối tượng giản đồ itemMetadata.objectType=movie
Loại đối tượng mà trang web sử dụng, như xác định trong phần định nghĩa đối tượng giản đồ nguồn dữ liệu. Trình kết nối sẽ không lập chỉ mục bất kỳ dữ liệu có cấu trúc nào nếu thuộc tính này không được chỉ định.

Lưu ý: Thuộc tính cấu hình này trỏ đến một giá trị thay vì thuộc tính siêu dữ liệu, đồng thời không hỗ trợ các hậu tố .field và .defaultValue.

Định dạng ngày giờ

Định dạng ngày giờ chỉ định định dạng dự kiến trong các thuộc tính siêu dữ liệu. Nếu tệp cấu hình không chứa tham số này, thì các giá trị mặc định sẽ được sử dụng. Bảng sau đây cho thấy thông số này.

Chế độ cài đặt

Tham số

Mẫu ngày giờ bổ sung

structuredData.dateTimePatterns=MM/dd/uuuu HH:mm:ssXXX

Danh sách các mẫu java.time.format.DateTimeFormatter bổ sung được phân tách bằng dấu chấm phẩy. Các mẫu này được dùng khi phân tích cú pháp giá trị chuỗi cho bất kỳ trường ngày hoặc giờ nào trong siêu dữ liệu hoặc giản đồ. Giá trị mặc định là một danh sách trống, nhưng các định dạng RFC 3339 và RFC 1123 luôn được hỗ trợ.

Bước 3: Định cấu hình Trình thu thập HTTP Norconex

Tệp lưu trữ zip norconex-committer-google-cloud-search-{version}.zip bao gồm tệp cấu hình mẫu, minimum-config.xml.

Bạn nên bắt đầu định cấu hình bằng cách sao chép tệp mẫu:

  1. Thay đổi thành thư mục Norconex HTTP Collector:
    $ cd ~/norconex/norconex-collector-http-{version}/
  2. Sao chép tệp cấu hình:
    $ cp examples/minimum/minimum-config.xml gcs-crawl-config.xml
  3. Chỉnh sửa tệp mới tạo (trong ví dụ này là gcs-crawl-config.xml) và thêm hoặc thay thế các nút <committer> và <tagger> hiện có như mô tả trong bảng sau.
Xem xét Thông số
<committer> node <committer class="com.norconex.committer.googlecloudsearch. GoogleCloudSearchCommitter">

Bắt buộc. Để bật trình bổ trợ này, bạn phải thêm nút <committer> làm nút con của nút <httpcollector> gốc.
<UploadFormat> <uploadFormat>raw</uploadFormat>
Không bắt buộc. Định dạng mà trình bổ trợ trình lập chỉ mục đẩy nội dung tài liệu vào API trình lập chỉ mục của Google Cloud Search. Các giá trị hợp lệ là:
  • raw: trình bổ trợ trình lập chỉ mục sẽ đẩy nội dung tài liệu gốc, chưa được chuyển đổi.
  • text: trình bổ trợ trình lập chỉ mục đẩy nội dung văn bản được trích xuất.

Giá trị mặc định là raw.
BinaryContent Tagger <tagger> node <tagger class="com.norconex.committer.googlecloudsearch.BinaryContentTagger"/>
Bắt buộc nếu giá trị của <UploadFormat> là raw. Trong trường hợp này, trình bổ trợ trình lập chỉ mục cần có trường nội dung nhị phân của tài liệu.

Bạn phải thêm nút BinaryContentTagger <tagger> làm phần tử con của nút <importer> / <preParseHandlers>.

Ví dụ sau đây cho thấy nội dung sửa đổi cần thiết đối với gcs-crawl-config.xml.

<committer class="com.norconex.committer.googlecloudsearch.GoogleCloudSearchCommitter">
    <configFilePath>/full/path/to/gcs-sdk-config.properties</configFilePath>
    
    <uploadFormat>raw</uploadFormat>
</committer>
<importer>
  <preParseHandlers>
    <tagger class="com.norconex.committer.googlecloudsearch.BinaryContentTagger"/>
  </preParseHandlers>
</importer>

Bước 4: Định cấu hình thu thập thông tin web

Trước khi bắt đầu thu thập dữ liệu web, bạn phải định cấu hình thu thập dữ liệu để thu thập dữ liệu đó chỉ bao gồm thông tin mà tổ chức của bạn muốn đưa vào kết quả tìm kiếm. Các chế độ cài đặt quan trọng nhất cho việc thu thập dữ liệu web là một phần của(các) nút <crawler> và có thể bao gồm:

  • URL bắt đầu
  • Chiều sâu tối đa của việc thu thập thông tin
  • Số lượng chuỗi

Thay đổi các giá trị cấu hình này theo nhu cầu của bạn. Để biết thêm thông tin chi tiết về cách thiết lập tính năng thu thập thông tin web cũng như danh sách đầy đủ các thông số cấu hình có sẵn, hãy xem trang Cấu hình của Trình thu thập HTTP.

Bước 5: Bắt đầu thu thập thông tin trên web và tải nội dung lên

Sau khi cài đặt và thiết lập trình bổ trợ trình lập chỉ mục, bạn có thể tự chạy trình bổ trợ này ở chế độ cục bộ.

Ví dụ sau giả định các thành phần bắt buộc nằm trong thư mục cục bộ trên hệ thống Linux. Chạy lệnh sau:

$ ./collector-http[.bat|.sh] -a start -c gcs-crawl-config.xml

Giám sát trình thu thập thông tin bằng Trình theo dõi JEF

Trình theo dõi Norconex JEF (Job Execution Framework) là một công cụ đồ hoạ để theo dõi tiến trình của các quy trình và công việc của Norconex Web Crawler (HTTP Collector). Để xem hướng dẫn đầy đủ về cách thiết lập tiện ích này, hãy truy cập vào phần Theo dõi tiến trình của trình thu thập thông tin bằng Trình theo dõi JEF.