Wdrażanie oprogramowania sprzęgającego

Na tej stronie samouczka Cloud Search znajdziesz informacje o tym, jak skonfigurować źródło danych i łącznik treści do indeksowania danych. Aby rozpocząć od początku tego samouczka, zapoznaj się z samouczkiem wprowadzającym do Cloud Search.

Tworzenie oprogramowania sprzęgającego

Zmień katalog roboczy na cloud-search-samples/end-to-end/connector i uruchom to polecenie:

mvn package -DskipTests

Polecenie pobiera zależności wymagane do utworzenia łącznika treści i skompiluje kod.

Tworzenie danych logowania do konta usługi

Aby wywoływać interfejsy API Cloud Search, sprzęg wymaga danych logowania do konta usługi. Aby utworzyć dane logowania:

1. Wróć do konsoli Google Cloud.
2. W panelu nawigacyjnym po lewej stronie kliknij Dane logowania. Pojawi się strona „Dane logowania”.
3. Kliknij menu + UTWÓRZ DANE LOGOWANIA i wybierz Konto usługi. Pojawi się strona „Tworzenie konta usługi”.
4. W polu Nazwa konta usługi wpisz „tutorial”.
5. Zanotuj wartość identyfikatora konta usługi (zaraz po nazwie konta usługi). Ta wartość jest używana później.
6. Kliknij UTWÓRZ. Wyświetli się okno „Uprawnienia konta usługi (opcjonalnie)”.
7. Kliknij DALEJ. Pojawi się okno „Przyznaj użytkownikom dostęp do tego konta usługi (opcjonalnie)”.
8. Kliknij GOTOWE. Pojawi się ekran „Dane logowania”.
9. W sekcji Konta usługi kliknij adres e-mail konta usługi. Pojawi się strona „Szczegóły konta usługi”.
10. W sekcji Klucze kliknij menu DODAJ KLUC i wybierz Utwórz nowy klucz. Wyświetli się okno „Tworzenie klucza prywatnego”.
11. Kliknij UTWÓRZ.
12. (Opcjonalnie) Jeśli pojawi się okno „Czy chcesz zezwolić na pobieranie na console.cloud.google.com?”, kliknij Zezwól.
13. Plik klucza prywatnego jest zapisywany na komputerze. Zapamiętaj lokalizację pobranego pliku. Ten plik służy do konfigurowania oprogramowania sprzęgającego treści, dzięki czemu może się uwierzytelniać podczas wywoływania interfejsów Google Cloud Search API.

Inicjowanie obsługi przez firmę zewnętrzną

Zanim zaczniesz wywoływać inne interfejsy Cloud Search, musisz zainicjować obsługę Google Cloud Search przez zewnętrznych dostawców.

Aby zainicjować obsługę Cloud Search przez inne firmy:

1. Twój projekt platformy Cloud Search zawiera dane logowania do konta usługi. Jednak aby zainicjować obsługę przez zewnętrznego dostawcę, musisz utworzyć dane logowania do aplikacji internetowej. Instrukcje tworzenia danych logowania do aplikacji internetowej znajdziesz w sekcji Tworzenie danych logowania. Po wykonaniu tego kroku powinieneś mieć identyfikator klienta i tajny klucz klienta.

2. Aby uzyskać token dostępu, skorzystaj z narzędzia Google do testowania protokołu OAuth 2:

   1. Kliknij Ustawienia i zaznacz Użyj własnych danych logowania.
   2. Wpisz identyfikator i tajny klucz klienta z kroku 1.
   3. Kliknij Zamknij.
   4. W polu zakresów wpisz https://www.googleapis.com/auth/cloud_search.settings i kliknij Autoryzuj. Narzędzie OAuth 2 Playground zwraca kod autoryzacji.
   5. Kliknij Kod autoryzacji wymiany dla tokenów. Zwracany jest token.

3. Aby zainicjować obsługę Cloud Search przez inne firmy, użyj tego polecenia curl: Pamiętaj, aby zastąpić [YOUR_ACCESS_TOKEN] tokenem uzyskanym w kroku 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
   

   Jeśli operacja się uda, treść odpowiedzi będzie zawierała wystąpienie obiektu operation. Przykład:

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

   Jeśli to nie zadziała, skontaktuj się z zespołem pomocy Cloud Search.

4. Aby sprawdzić, czy obsługa zewnętrzna jest zainicjowana, użyj wywołania 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
   

   Po zakończeniu inicjalizacji przez usługę innej firmy pole done będzie zawierać wartość true. Na przykład:

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

Tworzenie źródła danych

Następnie utwórz źródło danych w konsoli administracyjnej. Źródło danych zapewnia przestrzeń nazw do indeksowania treści za pomocą oprogramowania sprzęgającego.

1. Otwórz konsolę administracyjną Google.
2. Kliknij ikonę aplikacji. Pojawi się strona „Administracja aplikacjami”.
3. Kliknij Google Workspace. Pojawi się strona „Administracja Google Workspace”.
4. Przewiń w dół i kliknij Cloud Search. Pojawi się strona „Ustawienia Google Workspace”.
5. Kliknij Zewnętrzne źródła danych. Pojawi się strona „Źródła danych”.
6. Kliknij okrągłe żółte +. Pojawi się okno „Dodaj nowe źródło danych”.
7. W polu Wyświetlana nazwa wpisz „tutorial”.
8. W polu Adresy e-mail kont usługi wpisz adres e-mail konta usługi utworzonego w poprzedniej sekcji. Jeśli nie znasz adresu e-mail konta usługi, wyszukaj tę wartość na stronie Konta usługi.
9. Kliknij DODAJ. Pojawi się okno „Źródło danych zostało utworzone”.
10. Kliknij *OK. Zapisz identyfikator źródła nowo utworzonego źródła danych. Identyfikator źródła służy do konfigurowania łącznika treści.

Wygeneruj osobisty token dostępu do interfejsu GitHub API

Oprogramowanie sprzęgające wymaga uwierzytelnionego dostępu do interfejsu GitHub API, aby zapewnić wystarczający limit. Ze względu na prostotę łącznik korzysta z osobowych tokenów dostępu zamiast OAuth. Tokeny osobiste umożliwiają uwierzytelnianie się jako użytkownik z ograniczonym zestawem uprawnień podobnym do OAuth.

1. Zaloguj się w GitHubie.
2. W prawym górnym rogu kliknij swoje zdjęcie profilowe. Pojawi się menu.
3. Kliknij Ustawienia.
4. Kliknij Ustawienia programisty.
5. Kliknij Osobiste tokeny dostępu.
6. Kliknij Generate personal access token (Wygeneruj osobisty token dostępu).
7. W polu Uwaga wpisz „Samouczek Cloud Search”.
8. Sprawdź zakres public_repo.
9. Kliknij Wygeneruj token.
10. Zapisz wygenerowany token. Jest ono używane przez oprogramowanie sprzęgające do wywoływania interfejsów GitHub API i zapewnia limit interfejsu API do indeksowania.

Konfigurowanie oprogramowania sprzęgającego

Po utworzeniu danych logowania i źródła danych zaktualizuj konfigurację łącznika, aby uwzględnić te wartości:

1. Z poziomu wiersza poleceń zmień katalog na cloud-search-samples/end-to-end/connector/.
2. Otwórz plik sample-config.properties w edytorze tekstu.
3. Ustaw parametr api.serviceAccountPrivateKeyFile na ścieżkę pliku pobranych wcześniej danych logowania do usługi.
4. Parametr api.sourceId ustaw na identyfikator wcześniej utworzonego źródła danych.
5. Ustaw parametr github.user na swoją nazwę użytkownika na GitHubie.
6. Ustaw parametr github.token na utworzony wcześniej token dostępu.
7. Zapisz plik.

Zaktualizuj schemat

Pośrednik indeksuje zarówno treści uporządkowane, jak i nieuporządkowane. Przed zindeksowaniem danych musisz zaktualizować schemat źródła danych. Aby zaktualizować schemat, uruchom to polecenie:

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

Uruchamianie oprogramowania sprzęgającego

Aby uruchomić usługę łączenie danych i rozpocząć indeksowanie, uruchom to polecenie:

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

Domyślna konfiguracja oprogramowania sprzęgającego polega na indeksowaniu pojedynczego repozytorium w organizacji googleworkspace. Indeksowanie repozytorium trwa około minuty. Po wstępnym indeksowaniu oprogramowanie sprzęgające nadal przeszukuje repozytorium w poszukiwaniu zmian, które muszą zostać odzwierciedlone w indeksie Cloud Search.

Sprawdzanie kodu

Pozostałe sekcje opisują sposób tworzenia tego oprogramowania.

Uruchamianie aplikacji

Punkt wejścia do tego łącznika to klasa GithubConnector. Metoda main tworzy instancję IndexingApplication pakietu SDK i go uruchamia.

/**
 * 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 udostępniany przez pakiet SDK stosuje strategię przeszukiwania, która wykorzystuje koleje Cloud Search do śledzenia stanu elementów w indeksie. Deleguje ona do GithubRepository, która jest implementowana przez przykładowy łącznik, aby uzyskać dostęp do treści z GitHuba.

Przechodzenie przez repozytoria GitHub

Podczas pełnego przeszukiwania wywoływana jest metoda getIds(), aby przesłać elementy, które mogą wymagać indeksowania w kolejce.

Oprogramowanie sprzęgające może indeksować wiele repozytoriów lub organizacji. Aby zminimalizować wpływ awarii, naraz przeszukiwane jest tylko jedno repozytorium GitHub. Wraz z wynikami przechodzenia zwracany jest punkt kontrolny zawierający listę repozytoriów, które mają zostać zindeksowane w kolejnych wywołaniach funkcji getIds(). W przypadku błędu indeksowanie zostanie wznowione w bieżącym repozytorium, zamiast zaczynać od początku.

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

Metoda collectRepositoryItems() obsługuje przechodzenie przez pojedyncze repozytorium GitHub. Ta metoda zwraca kolekcję ApiOperations reprezentującą elementy, które mają zostać dodane do kolejki. Elementy są przesyłane jako nazwa zasobu i wartość funkcji haszującej reprezentująca bieżący stan elementu.

Wartość hasha jest używana podczas kolejnych przeszukiwań repozytoriów GitHub. Ta wartość umożliwia szybkie sprawdzenie, czy treści uległy zmianie, bez konieczności przesyłania dodatkowych treści. Łącznik na ślepo umieszcza wszystkie elementy w kolejce. Jeśli element jest nowy lub zmieniła się jego wartość skrótu, jest on dostępny do pobierania w kolejce. W przeciwnym razie produkt zostanie uznany za niezmodyfikowany.

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

Przetwarzam kolejkę

Po zakończeniu pełnego przemierzania oprogramowanie sprzęgające rozpoczyna odpytywanie kolejki w poszukiwaniu elementów, które mają zostać zindeksowane. Metoda getDoc() jest wywoływana w przypadku każdego elementu pobranego z kolejki. Ta metoda odczytuje element z GitHuba i przekształca go w odpowiednią reprezentację do indeksowania.

Ponieważ oprogramowanie sprzęgające działa na podstawie danych na żywo, które mogą ulec zmianie w dowolnym momencie, getDoc() sprawdza też, czy element w kole jest nadal prawidłowy, oraz usuwa z indeksu elementy, które już nie istnieją.

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

W przypadku każdego z indekowanych przez łącznik obiektów GitHub odpowiednia metoda indexItem() odpowiada za tworzenie reprezentacji elementu w wyszukiwarce Cloud. Na przykład, aby utworzyć reprezentację dla elementów treści:

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

Następnie wdróż interfejs wyszukiwania.

Wstecz Dalej