פריסת המחבר

בדף הזה במדריך של Cloud Search מוסבר איך להגדיר מקור נתונים ומחבר תוכן להוספת נתונים לאינדקס. כדי להתחיל מההתחלה, אפשר לעיין במדריך למתחילים בנושא Cloud Search.

פיתוח המחבר

מעבירים את ספריית העבודה לספרייה cloud-search-samples/end-to-end/connector ומריצים את הפקודה הבאה:

mvn package -DskipTests

הפקודה מאפשרת להוריד את יחסי התלות הנדרשים ליצירת מחבר התוכן ולקמפל את הקוד.

יצירת פרטי כניסה לחשבון שירות

המחבר דורש פרטי כניסה של חשבון שירות כדי לבצע קריאה ל-Cloud Search API. כדי ליצור את פרטי הכניסה:

1. חוזרים למסוף Google Cloud.
2. בחלונית הניווט הימנית, לוחצים על פרטי כניסה. הדף Credential (פרטי כניסה) מופיע.
3. לוחצים על הרשימה הנפתחת + CREATE CREDENTIALS ובוחרים באפשרות Service account. הדף 'יצירת חשבון שירות' מופיע.
4. בשדה Service account name מזינים tutorial.
5. מציינים את הערך של Service account ID (מיד אחרי שם חשבון השירות). הערך הזה ישמש מאוחר יותר.
6. לוחצים על יצירה. תיבת הדו-שיח 'הרשאות של חשבון שירות (אופציונלי)' מופיעה.
7. לוחצים על המשך. תיבת הדו-שיח 'הענקת גישה למשתמשים לחשבון השירות הזה (אופציונלי)' מופיעה.
8. לוחצים על סיום. המסך Credentials (פרטי כניסה) יופיע.
9. בקטע Service Accounts (חשבונות שירות), לוחצים על כתובת האימייל של חשבון השירות. הדף 'פרטי חשבון השירות' מופיע.
10. בקטע Keys (מפתחות), לוחצים על הרשימה הנפתחת ADD KEY ובוחרים באפשרות Create new key. תיפתח תיבת הדו-שיח 'יצירת מפתח פרטי'.
11. לוחצים על יצירה.
12. (אופציונלי) אם מופיעה תיבת הדו-שיח 'האם ברצונך לאפשר הורדות בכתובת console.cloud.google.com?', לוחצים על אישור.
13. קובץ של מפתח פרטי נשמר במחשב. שימו לב לאיפה הקובץ שהורד נשמר. הקובץ הזה משמש להגדרת מחבר התוכן כדי שהוא יוכל לבצע אימות עצמי בזמן הקריאה לממשקי Google Cloud Search API.

איך מפעילים תמיכה של צד שלישי

לפני שתוכלו להפעיל ממשקי API אחרים של Cloud Search, תצטרכו לאתחל תמיכה של צד שלישי ב-Google Cloud Search.

הערה: אם השלמתם את המדריך ל-Cloud Search, כבר הפעילתם את התמיכה של צד שלישי ב-Cloud Search ותוכלו לדלג על השלב הזה.

כדי להפעיל תמיכה של צד שלישי ב-Cloud Search:

1. הפרויקט של פלטפורמת Cloud Search מכיל את פרטי הכניסה של חשבון השירות. עם זאת, כדי להפעיל את התמיכה בצד שלישי, צריך ליצור פרטי כניסה לאפליקציית אינטרנט. הוראות ליצירת פרטי כניסה לאפליקציית אינטרנט מפורטות במאמר יצירת פרטי כניסה. בסיום השלב הזה, אמורים להיות לכם מזהה לקוח וקובץ של סוד לקוח.

2. משתמשים במגרש המשחקים של OAuth 2 של Google כדי לקבל אסימון גישה:

   1. לוחצים על 'הגדרות' ומסמנים את האפשרות שימוש בפרטי הכניסה שלך לאימות.
   2. מזינים את מזהה הלקוח ואת סוד הלקוח משלב 1.
   3. לוחצים על סגירה.
   4. בשדה scopes, מקלידים https://www.googleapis.com/auth/cloud_search.settings ולוחצים על Authorize. מגרש המשחקים של OAuth 2 מחזיר קוד הרשאה.
   5. לוחצים על Exchange authorization code for tokens. הטוקן מוחזר.

3. כדי לאתחל תמיכה של צד שלישי ב-Cloud Search, משתמשים בפקודה הבאה של curl. חשוב להחליף את [YOUR_ACCESS_TOKEN] באסימון שהתקבל בשלב 2.

   curl --request POST \
   'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
     --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{}' \
     --compressed
   

   אם הפעולה מצליחה, גוף התגובה מכיל מופע של operation. לדוגמה:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   }
   

   אם לא, פנו לתמיכה של Cloud Search.

4. משתמשים ב-operations.get כדי לוודא שתמיכת הצד השלישי מופעלת:

   curl \
   'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
   [YOUR_API_KEY]' \
   --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
   --header 'Accept: application/json' \
   --compressed
   

   כשהאיפוס של הצד השלישי מסתיים, הוא מכיל את השדה done שמוגדר כ-true. לדוגמה:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   done: true
   }
   

יצירת מקור הנתונים

בשלב הבא, יוצרים מקור נתונים במסוף Admin. מקור הנתונים מספק מרחב שמות להוספת תוכן לאינדקס באמצעות המחבר.

הערה: רק אדמין דומיין יכול לבצע את השלבים האלה.

1. פותחים את מסוף Google Admin.
2. לוחצים על סמל האפליקציות. הדף 'ניהול אפליקציות' יופיע.
3. לוחצים על Google Workspace. הדף 'ניהול אפליקציות ב-Google Workspace' מופיע.
4. גוללים למטה ולוחצים על חיפוש ב-Cloud. הדף 'הגדרות ל-Google Workspace' יופיע.
5. לוחצים על מקורות נתונים של צד שלישי. הדף 'מקורות נתונים' יופיע.
6. לוחצים על הסמל העגול הצהוב +. תיבת הדו-שיח 'הוספת מקור נתונים חדש' מופיעה.
7. בשדה Display name מקלידים tutorial.
8. בשדה Service account email addresses, מזינים את כתובת האימייל של חשבון השירות שיצרתם בקטע הקודם. אם אתם לא יודעים מה כתובת האימייל של חשבון השירות, תוכלו לחפש את הערך בדף service accounts.
9. לוחצים על ADD. תיבת הדו-שיח 'יצירת מקור הנתונים הסתיימה' מופיעה.
10. לוחצים על *אישור. שימו לב למזהה המקור של מקור הנתונים החדש שנוצר. מזהה המקור משמש להגדרת מחבר התוכן.

יצירת אסימון גישה אישי ל-GitHub API

המחבר דורש גישה מאומתת ל-GitHub API כדי שיהיה לו מכסה מספקת. כדי לפשט את התהליך, המחבר משתמש באסימוני גישה אישיים במקום ב-OAuth. טוקנים אישיים מאפשרים לבצע אימות בתור משתמש עם קבוצה מוגבלת של הרשאות, בדומה ל-OAuth.

1. מתחברים ל-GitHub.
2. בפינה השמאלית העליונה, לוחצים על תמונת הפרופיל. יופיע תפריט נפתח.
3. לוחצים על הגדרות.
4. לוחצים על הגדרות למפתחים.
5. לוחצים על אסימוני גישה אישיים.
6. לוחצים על Generate personal access token.
7. בשדה הערה, מזינים 'מדריך Cloud Search'.
8. בודקים את ההיקף public_repo.
9. לוחצים על Generate token.
10. מציינים את האסימון שנוצר. המחבר משתמש בו כדי לבצע קריאות ל-API של GitHub, ומספק מכסת API לביצוע ההוספה לאינדקס.

הגדרת המחבר

אחרי שיוצרים את פרטי הכניסה ואת מקור הנתונים, מעדכנים את הגדרות המחבר כך שיכללו את הערכים הבאים:

1. משורת הפקודה, משנים את הספרייה ל-cloud-search-samples/end-to-end/connector/.
2. פותחים את הקובץ sample-config.properties באמצעות כלי לעריכת טקסט.
3. מגדירים את הפרמטר api.serviceAccountPrivateKeyFile לנתיב הקובץ של פרטי הכניסה לשירות שהורדתם קודם.
4. מגדירים את הפרמטר api.sourceId למזהה של מקור הנתונים שיצרתם קודם.
5. מגדירים את הפרמטר github.user בשם המשתמש שלכם ב-GitHub.
6. מגדירים את הפרמטר github.token לאסימון הגישה שיצרתם קודם.
7. שומרים את הקובץ.

עדכון הסכימה

המחבר יוצר אינדקס גם לתוכן מובנה וגם לתוכן לא מובנה. לפני הוספת נתונים לאינדקס, צריך לעדכן את הסכימה של מקור הנתונים. מריצים את הפקודה הבאה כדי לעדכן את הסכימה:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
    -Dexec.args="-Dconfig=sample-config.properties"

הפעלת המחבר

כדי להפעיל את המחבר ולהתחיל את ההוספה לאינדקס, מריצים את הפקודה:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
    -Dexec.args="-Dconfig=sample-config.properties"

הגדרת ברירת המחדל של המחבר היא להוסיף לאינדקס מאגר יחיד בארגון googleworkspace. הוספת המאגר לאינדקס נמשכת בערך דקה. אחרי ההוספה הראשונית לאינדקס, המחבר ממשיך לבדוק אם יש שינויים במאגר שצריכים להופיע באינדקס של Cloud Search.

בדיקת הקוד

בחלקים הבאים נסביר איך המחבר נוצר.

הפעלת האפליקציה

נקודת הכניסה למחבר היא הכיתה GithubConnector. השיטה main יוצרת מופע של IndexingApplication ב-SDK ומפעילה אותו.

GithubConnector.java

הצגת הקוד ב-GitHub

/**
 * Main entry point for the connector. Creates and starts an indexing
 * application using the {@code ListingConnector} template and the sample's
 * custom {@code Repository} implementation.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new GithubRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args)
      .build();
  application.start();
}

הפונקציה ListingConnector שמספקת ה-SDK מיישמת אסטרטגיית סריקה שמשתמשת בתורים של Cloud Search כדי לעקוב אחרי המצב של הפריטים באינדקס. הוא מעביר את הגישה לתוכן מ-GitHub אל GithubRepository, שמוטמע על ידי המחבר לדוגמה.

ניווט במאגרים של GitHub

במהלך טרaversals מלאים, מתבצעת קריאה ל-method‏ getIds() כדי לדחוף לתור פריטים שעשויים להידרש להוספה לאינדקס.

המחבר יכול להוסיף לאינדקס כמה מאגרים או ארגונים. כדי למזער את ההשפעה של כשל, המערכת עוברת על מאגר GitHub אחד בכל פעם. נקודת עצירה מוחזרת עם תוצאות הסריקה, שמכילות את רשימת המאגרים שצריך להוסיף לאינדקס בקריאות הבאות ל-getIds(). אם מתרחשת שגיאה, ההוספה לאינדקס תמשיך במאגר הנוכחי במקום להתחיל מחדש.

GithubRepository.java

הצגת הקוד ב-GitHub

/**
 * Gets all of the existing item IDs from the data repository. While
 * multiple repositories are supported, only one repository is traversed
 * per call. The remaining repositories are saved in the checkpoint
 * are traversed on subsequent calls. This minimizes the amount of
 * data that needs to be reindex in the event of an error.
 *
 * <p>This method is called by {@link ListingConnector#traverse()} during
 * <em>full traversals</em>. Every document ID and metadata hash value in
 * the <em>repository</em> is pushed to the Cloud Search queue. Each pushed
 * document is later polled and processed in the {@link #getDoc(Item)} method.
 * <p>
 * The metadata hash values are pushed to aid document change detection. The
 * queue sets the document status depending on the hash comparison. If the
 * pushed ID doesn't yet exist in Cloud Search, the document's status is
 * set to <em>new</em>. If the ID exists but has a mismatched hash value,
 * its status is set to <em>modified</em>. If the ID exists and matches
 * the hash value, its status is unchanged.
 *
 * <p>In every case, the pushed content hash value is only used for
 * comparison. The hash value is only set in the queue during an
 * update (see {@link #getDoc(Item)}).
 *
 * @param checkpoint value defined and maintained by this connector
 * @return this is typically a {@link PushItems} instance
 */
@Override
public CheckpointCloseableIterable<ApiOperation> getIds(byte[] checkpoint)
    throws RepositoryException {
  List<String> repositories;
  // Decode the checkpoint if present to get the list of remaining
  // repositories to index.
  if (checkpoint != null) {
    try {
      FullTraversalCheckpoint decodedCheckpoint = FullTraversalCheckpoint
          .fromBytes(checkpoint);
      repositories = decodedCheckpoint.getRemainingRepositories();
    } catch (IOException e) {
      throw new RepositoryException.Builder()
          .setErrorMessage("Unable to deserialize checkpoint")
          .setCause(e)
          .build();
    }
  } else {
    // No previous checkpoint, scan for repositories to index
    // based on the connector configuration.
    try {
      repositories = scanRepositories();
    } catch (IOException e) {
      throw toRepositoryError(e, Optional.of("Unable to scan repositories"));
    }
  }

  if (repositories.isEmpty()) {
    // Nothing left to index. Reset the checkpoint to null so the
    // next full traversal starts from the beginning
    Collection<ApiOperation> empty = Collections.emptyList();
    return new CheckpointCloseableIterableImpl.Builder<>(empty)
        .setCheckpoint((byte[]) null)
        .setHasMore(false)
        .build();
  }

  // Still have more repositories to index. Pop the next repository to
  // index off the list. The remaining repositories make up the next
  // checkpoint.
  String repositoryToIndex = repositories.get(0);
  repositories = repositories.subList(1, repositories.size());

  try {
    log.info(() -> String.format("Traversing repository %s", repositoryToIndex));
    Collection<ApiOperation> items = collectRepositoryItems(repositoryToIndex);
    FullTraversalCheckpoint newCheckpoint = new FullTraversalCheckpoint(repositories);
    return new CheckpointCloseableIterableImpl.Builder<>(items)
        .setHasMore(true)
        .setCheckpoint(newCheckpoint.toBytes())
        .build();
  } catch (IOException e) {
    String errorMessage = String.format("Unable to traverse repo: %s",
        repositoryToIndex);
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

השיטה collectRepositoryItems() מטפלת בסריקה של מאגר GitHub יחיד. ה-method הזה מחזיר אוסף של ApiOperations שמייצג את הפריטים שרוצים לדחוף לתור. הפריטים מועברים (push) בתור שם משאב וערך גיבוב (hash) שמייצג את המצב הנוכחי של הפריט.

הערך של הגיבוב משמש בסריקה חוזרת של המאגרים ב-GitHub. הערך הזה מספק בדיקה קלה כדי לקבוע אם התוכן השתנה בלי שתצטרכו להעלות תוכן נוסף. המחבר מציב ברשימה את כל הפריטים באופן עיוור. אם הפריט חדש או שערך הגיבוב השתנה, הוא זמין לבדיקה בתור. אחרת, הפריט נחשב ללא שינויים.

GithubRepository.java

הצגת הקוד ב-GitHub

/**
 * Fetch IDs to  push in to the queue for all items in the repository.
 * Currently captures issues & content in the master branch.
 *
 * @param name Name of repository to index
 * @return Items to push into the queue for later indexing
 * @throws IOException if error reading issues
 */
private Collection<ApiOperation> collectRepositoryItems(String name)
    throws IOException {
  List<ApiOperation> operations = new ArrayList<>();
  GHRepository repo = github.getRepository(name);

  // Add the repository as an item to be indexed
  String metadataHash = repo.getUpdatedAt().toString();
  String resourceName = repo.getHtmlUrl().getPath();
  PushItem repositoryPushItem = new PushItem()
      .setMetadataHash(metadataHash);
  PushItems items = new PushItems.Builder()
      .addPushItem(resourceName, repositoryPushItem)
      .build();

  operations.add(items);
  // Add issues/pull requests & files
  operations.add(collectIssues(repo));
  operations.add(collectContent(repo));
  return operations;
}

עיבוד התור

אחרי שהסריקה המלאה מסתיימת, המחבר מתחיל לבדוק את התור כדי לאתר פריטים שצריך להוסיף לאינדקס. השיטה getDoc() מתבצעת לכל פריט שנשלף מהתור. השיטה קוראת את הפריט מ-GitHub וממירה אותו לייצוג המתאים להוספה לאינדקס.

מכיוון שהמחבר פועל מול נתונים פעילים שעשויים להשתנות בכל שלב, getDoc() מאמת גם שהפריט בתור עדיין תקף ומחק פריטים מהאינדקס שכבר לא קיימים.

GithubRepository.java

הצגת הקוד ב-GitHub

/**
 * Gets a single data repository item and indexes it if required.
 *
 * <p>This method is called by the {@link ListingConnector} during a poll
 * of the Cloud Search queue. Each queued item is processed
 * individually depending on its state in the data repository.
 *
 * @param item the data repository item to retrieve
 * @return the item's state determines which type of
 * {@link ApiOperation} is returned:
 * {@link RepositoryDoc}, {@link DeleteItem}, or {@link PushItem}
 */
@Override
public ApiOperation getDoc(Item item) throws RepositoryException {
  log.info(() -> String.format("Processing item: %s ", item.getName()));
  Object githubObject;
  try {
    // Retrieve the item from GitHub
    githubObject = getGithubObject(item.getName());
    if (githubObject instanceof GHRepository) {
      return indexItem((GHRepository) githubObject, item);
    } else if (githubObject instanceof GHPullRequest) {
      return indexItem((GHPullRequest) githubObject, item);
    } else if (githubObject instanceof GHIssue) {
      return indexItem((GHIssue) githubObject, item);
    } else if (githubObject instanceof GHContent) {
      return indexItem((GHContent) githubObject, item);
    } else {
      String errorMessage = String.format("Unexpected item received: %s",
          item.getName());
      throw new RepositoryException.Builder()
          .setErrorMessage(errorMessage)
          .setErrorType(RepositoryException.ErrorType.UNKNOWN)
          .build();
    }
  } catch (FileNotFoundException e) {
    log.info(() -> String.format("Deleting item: %s ", item.getName()));
    return ApiOperations.deleteItem(item.getName());
  } catch (IOException e) {
    String errorMessage = String.format("Unable to retrieve item: %s",
        item.getName());
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

לכל אחד מהאובייקטים ב-GitHub שמתווספים לאינדקס המחבר, ה-method התואם של indexItem() יוצר את ייצוג הפריט ב-Cloud Search. לדוגמה, כדי ליצור את הייצוג של פריטי תוכן:

GithubRepository.java

הצגת הקוד ב-GitHub

/**
 * Build the ApiOperation to index a content item (file).
 *
 * @param content      Content item to index
 * @param previousItem Previous item state in the index
 * @return ApiOperation (RepositoryDoc if indexing,  PushItem if not modified)
 * @throws IOException if unable to create operation
 */
private ApiOperation indexItem(GHContent content, Item previousItem)
    throws IOException {
  String metadataHash = content.getSha();

  // If previously indexed and unchanged, just requeue as unmodified
  if (canSkipIndexing(previousItem, metadataHash)) {
    return notModified(previousItem.getName());
  }

  String resourceName = new URL(content.getHtmlUrl()).getPath();
  FieldOrValue<String> title = FieldOrValue.withValue(content.getName());
  FieldOrValue<String> url = FieldOrValue.withValue(content.getHtmlUrl());

  String containerName = content.getOwner().getHtmlUrl().getPath();
  String programmingLanguage = FileExtensions.getLanguageForFile(content.getName());

  // Structured data based on the schema
  Multimap<String, Object> structuredData = ArrayListMultimap.create();
  structuredData.put("organization", content.getOwner().getOwnerName());
  structuredData.put("repository", content.getOwner().getName());
  structuredData.put("path", content.getPath());
  structuredData.put("language", programmingLanguage);

  Item item = IndexingItemBuilder.fromConfiguration(resourceName)
      .setTitle(title)
      .setContainerName(containerName)
      .setSourceRepositoryUrl(url)
      .setItemType(IndexingItemBuilder.ItemType.CONTAINER_ITEM)
      .setObjectType("file")
      .setValues(structuredData)
      .setVersion(Longs.toByteArray(System.currentTimeMillis()))
      .setHash(content.getSha())
      .build();

  // Index the file content too
  String mimeType = FileTypeMap.getDefaultFileTypeMap()
      .getContentType(content.getName());
  AbstractInputStreamContent fileContent = new InputStreamContent(
      mimeType, content.read())
      .setLength(content.getSize())
      .setCloseInputStream(true);
  return new RepositoryDoc.Builder()
      .setItem(item)
      .setContent(fileContent, IndexingService.ContentFormat.RAW)
      .setRequestMode(IndexingService.RequestMode.SYNCHRONOUS)
      .build();
}

בשלב הבא, פורסים את ממשק החיפוש.

הקודם הבא