Разверните соединитель

На этой странице руководства Cloud Search показано, как настроить источник данных и соединитель контента для индексирования данных. Чтобы начать работу с этим руководством, обратитесь к руководству по началу работы с Cloud Search.

Создание соединителя

Измените свой рабочий каталог на каталог cloud-search-samples/end-to-end/connector и выполните следующую команду:

mvn package -DskipTests

Команда загружает необходимые зависимости, необходимые для создания соединителя контента, и компилирует код.

Создайте учетные данные сервисной учетной записи

Соединителю требуются учетные данные учетной записи службы для вызова API Cloud Search. Чтобы создать учетные данные:

1. Вернитесь в консоль Google Cloud .
2. На панели навигации слева нажмите «Учетные данные» . Появится страница «Учетные данные».
3. Нажмите раскрывающийся список + CREATE CREDENTIALS и выберите Сервисный аккаунт . Появится страница «Создать учетную запись службы».
4. В поле « Имя учетной записи службы » введите «tutorial».
5. Обратите внимание на значение идентификатора учетной записи службы (сразу после имени учетной записи службы). Это значение используется позже.
6. Нажмите СОЗДАТЬ . Появится диалоговое окно «Разрешения сервисной учетной записи (необязательно)».
7. Нажмите ПРОДОЛЖИТЬ . Появится диалоговое окно «Предоставить пользователям доступ к этой учетной записи службы (необязательно)».
8. Нажмите ГОТОВО . Появится экран «Учетные данные».
9. В разделе «Учетные записи служб» нажмите на адрес электронной почты учетной записи службы. Откроется страница «Сведения об учетной записи службы».
10. В разделе «Ключи» щелкните раскрывающийся список «ДОБАВИТЬ КЛЮЧ» и выберите «Создать новый ключ» . Появится диалоговое окно «Создать закрытый ключ».
11. Нажмите СОЗДАТЬ .
12. (необязательно) Если вопрос «Хотите ли вы разрешить загрузку на console.cloud.google.com?» появится диалоговое окно, нажмите «Разрешить» .
13. Файл закрытого ключа сохраняется на вашем компьютере. Обратите внимание на расположение загруженного файла. Этот файл используется для настройки соединителя контента, чтобы он мог аутентифицировать себя при вызове API Google Cloud Search.

Инициализация сторонней поддержки

Прежде чем вы сможете вызывать любые другие API Cloud Search, вам необходимо инициализировать стороннюю поддержку Google Cloud Search.

Чтобы инициализировать стороннюю поддержку Cloud Search:

1. Ваш проект платформы Cloud Search содержит учетные данные сервисной учетной записи. Однако для инициализации сторонней поддержки необходимо создать учетные данные веб-приложения. Инструкции по созданию учетных данных веб-приложения см. в разделе Создание учетных данных . По завершении этого шага у вас должен быть идентификатор клиента и секретный файл клиента.

2. Используйте площадку Google OAuth 2 для получения токена доступа:

   1. Нажмите «Настройки» и установите флажок «Пользователь имеет свои учетные данные» .
   2. Введите идентификатор клиента и секрет клиента из шага 1.
   3. Нажмите Закрыть .
   4. В поле «Области» введите https://www.googleapis.com/auth/cloud_search.settings и нажмите «Авторизовать» . Игровая площадка OAuth 2 возвращает код авторизации.
   5. Нажмите «Код авторизации Exchange для токенов» . Токен возвращается.

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
   }
   

Создайте источник данных

Затем создайте источник данных в консоли администратора. Источник данных предоставляет пространство имен для индексации содержимого с помощью соединителя.

1. Откройте консоль администратора Google .
2. Нажмите значок «Приложения». Появится страница «Администрирование приложений».
3. Нажмите Google Workspace . Откроется страница «Администрирование приложений Google Workspace».
4. Прокрутите вниз и нажмите «Поиск в облаке» . Откроется страница «Настройки Google Workspace».
5. Нажмите Сторонние источники данных . Откроется страница «Источники данных».
6. Нажмите круглый желтый + . Появится диалоговое окно «Добавить новый источник данных».
7. В поле «Отображаемое имя » введите «учебник».
8. В поле Адреса электронной почты учетной записи службы введите адрес электронной почты учетной записи службы, которую вы создали в предыдущем разделе. Если вы не знаете адрес электронной почты учетной записи службы, найдите значение на странице учетных записей службы .
9. Нажмите ДОБАВИТЬ . Появится диалоговое окно «Источник данных успешно создан».
10. Нажмите * ОК . Запишите идентификатор источника для вновь созданного источника данных. Идентификатор источника используется для настройки соединителя содержимого.

Создайте личный токен доступа для API GitHub.

Соединителю требуется аутентифицированный доступ к API GitHub, чтобы иметь достаточную квоту. Для простоты соединитель использует токены личного доступа вместо OAuth. Персональные токены позволяют аутентифицироваться как пользователь с ограниченным набором разрешений, аналогично OAuth.

1. Войдите в GitHub.
2. В правом верхнем углу нажмите на изображение своего профиля. Появится раскрывающееся меню.
3. Нажмите «Настройки» .
4. Нажмите «Настройки разработчика» .
5. Нажмите Токены личного доступа .
6. Нажмите «Создать токен личного доступа» .
7. В поле «Примечание » введите «Учебное пособие по Cloud Search».
8. Проверьте область public_repo .
9. Нажмите Создать токен .
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 . Индексация репозитория занимает около 1 минуты. После первоначального индексирования коннектор продолжает опрашивать репозиторий на наличие изменений, которые необходимо отразить в индексе Cloud Search.

Проверка кода

В остальных разделах рассматривается, как устроен соединитель.

Запуск приложения

Точкой входа в коннектор является класс GithubConnector . main метод создает экземпляр IndexingApplication SDK и запускает его.

/**
 * 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 для отслеживания состояния элементов в индексе. Он делегирует GithubRepository , реализованный примером соединителя, для доступа к контенту из GitHub.

Обход репозиториев GitHub

Во время полного обхода вызывается метод getIds() для помещения в очередь элементов, которые, возможно, потребуется индексировать.

Соединитель может индексировать несколько репозиториев или организаций. Чтобы свести к минимуму влияние сбоя, за раз просматривается один репозиторий GitHub. Контрольная точка возвращается с результатами обхода, содержащими список репозиториев, которые будут индексироваться при последующих вызовах getIds() . В случае возникновения ошибки индексирование возобновляется в текущем репозитории, а не начинается с начала.

/**
 * 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. Этот метод возвращает коллекцию ApiOperations представляющую элементы, которые необходимо поместить в очередь. Элементы передаются как имя ресурса и хеш-значение, представляющее текущее состояние элемента.

Хэш-значение используется при последующих обходах репозиториев 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() также проверяет, что элемент в очереди все еще действителен, и удаляет из индекса все элементы, которые больше не существуют.

/**
 * 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, индексируемого коннектором, соответствующий метод indexItem() занимается созданием представления элемента для Cloud Search. Например, чтобы построить представление элементов контента:

/**
 * 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();
}

Далее разверните интерфейс поиска.

Предыдущий Следующий