Bağlayıcıyı dağıtma

Cloud Search eğiticisinin bu sayfasında, verileri dizine eklemek için bir veri kaynağının ve içerik bağlayıcısının nasıl oluşturulacağı gösterilmektedir. Bu eğiticinin başından başlamak için Cloud Search başlangıç eğitimine bakın

Bağlayıcıyı oluşturma

Çalışma dizininizi cloud-search-samples/end-to-end/connector dizini olarak değiştirin ve şu komutu çalıştırın:

mvn package -DskipTests

Komut, içerik bağlayıcısını oluşturmak için gereken gerekli bağımlılıkları indirir ve kodu derler.

Hizmet hesabı kimlik bilgileri oluşturma

Bağlayıcının, Cloud Search API'lerini çağırmak için hizmet hesabı kimlik bilgilerini kullanması gerekir. Kimlik bilgilerini oluşturmak için:

1. Google Cloud Console'a dönün.
2. Sol gezinme menüsünde, Credentials (Kimlik bilgileri) seçeneğini tıklayın. "Kimlik bilgileri" sayfası görünür.
3. + KİMLİK BİLGİLERİ OLUŞTUR açılır listesini tıklayın ve Hizmet hesabı'nı seçin. "Hizmet hesabı oluştur" sayfası görüntülenir.
4. Service account name (Hizmet hesabı adı) alanına "tutorial" yazın.
5. Hizmet hesabı kimliği değerini (Hizmet hesabı adından hemen sonra) not edin. Bu değer daha sonra kullanılır.
6. CREATE'ı (OLUŞTUR) tıklayın. "Hizmet hesabı izinleri (isteğe bağlı)" iletişim kutusu görünür.
7. DEVAM'ı tıklayın. "Kullanıcıların bu hizmet hesabına erişmelerine izin ver (isteğe bağlı)" iletişim kutusu görünür.
8. BİTTİ'yi tıklayın. "Kimlik bilgileri" ekranı görünür.
9. Hizmet Hesapları bölümünde, hizmet hesabı e-postasını tıklayın. "Hizmet hesabı ayrıntıları" sayfası düzeltilir.
10. Anahtarlar bölümünün altında ANAHTAR EKLE açılır listesini tıklayın ve Yeni anahtar oluştur'u seçin. "Özel anahtar oluştur" iletişim kutusu görünür.
11. CREATE'ı (OLUŞTUR) tıklayın.
12. (isteğe bağlı) "console.cloud.google.com üzerinden indirme işlemlerine izin vermek istiyor musunuz?" iletişim kutusu görünürse İzin ver'i tıklayın.
13. Özel anahtar dosyası bilgisayarınıza kaydedilir. İndirilen dosyanın konumunu not edin. Bu dosya, Google Cloud Search API'lerini çağırırken kendi kimliğini doğrulayabilmesi için içerik bağlayıcısını yapılandırmak için kullanılır.

Üçüncü taraf desteğini başlatma

Diğer Cloud Search API'lerini çağırabilmeniz için öncelikle Google Cloud Search'e yönelik üçüncü taraf desteğini başlatmanız gerekir.

Not: Cloud Search eğiticisini başarıyla yürüttüyseniz Cloud Search için üçüncü taraf desteğini zaten başlatmışsınız demektir ve bu adımı atlayabilirsiniz.

Cloud Search için üçüncü taraf desteğini başlatmak amacıyla:

1. Cloud Search platform projeniz hizmet hesabı kimlik bilgileri içeriyor. Ancak üçüncü taraf desteğini başlatmak için web uygulaması kimlik bilgileri oluşturmanız gerekir. Web uygulaması kimlik bilgilerinin nasıl oluşturulacağıyla ilgili talimatlar için Kimlik bilgileri oluşturma konusuna bakın. Bu adımı tamamladıktan sonra elinizde bir istemci kimliği ve istemci gizli anahtarı olacaktır.

2. Erişim jetonu almak için Google'ın OAuth 2 oyun alanını kullanın:

   1. Ayarları tıklayın ve Kullanıcı için kendi kimlik doğrulama bilgilerinizi kullanın seçeneğini işaretleyin.
   2. 1. adımdaki istemci kimliğini ve istemci gizli anahtarını girin.
   3. Close'u (Kapat) tıklayın.
   4. Kapsamlar alanına https://www.googleapis.com/auth/cloud_search.settings yazın ve Yetkilendir'i tıklayın. OAuth 2 oynatma listesi, bir yetkilendirme kodu döndürür.
   5. Jetonlar için yetkilendirme kodu değiş tokuşu yap seçeneğini tıklayın. Bir jeton döndürülür.

3. Cloud Search için üçüncü taraf desteğini başlatmak amacıyla aşağıdaki curl komutunu kullanın. [YOUR_ACCESS_TOKEN] kısmını 2. adımda aldığınız jetonla değiştirdiğinizden emin olun.

   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
   

   Başarılı olursa yanıt gövdesi, operation öğesinin bir örneğini içerir. Örneğin:

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

   Başarısız olursa Cloud Search destek ekibiyle iletişime geçin.

4. Üçüncü taraf desteğinin başlatıldığını doğrulamak için operations.get dosyasını kullanın:

   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
   

   Üçüncü taraf başlatma tamamlandığında, true olarak ayarlanmış done alanını içerir. Örneğin:

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

Veri kaynağını oluşturma

Ardından, Yönetici Konsolu'nda bir veri kaynağı oluşturun. Veri kaynağı, bağlayıcıyı kullanarak içeriklerin dizine eklenmesi için bir ad alanı sağlar.

Not: Bu adımlar bir alan yöneticisi tarafından gerçekleştirilmelidir.

1. Google Yönetici konsolunu açın.
2. Uygulamalar simgesini tıklayın. "Uygulama yönetimi" sayfası görünür.
3. Google Workspace'i tıklayın. "Uygulamalardaki Google Workspace yönetimi" sayfası görünür.
4. Aşağı kaydırın ve Cloud Search'ü tıklayın. "Google Workspace Ayarları" sayfası görünür.
5. Üçüncü taraf veri kaynakları'nı tıklayın. "Veri Kaynakları" sayfası görüntülenir.
6. Yuvarlak sarı + işaretini tıklayın. "Yeni veri kaynağı ekle" iletişim kutusu görünür.
7. Görünen ad alanına "tutorial" yazın.
8. Hizmet hesabı e-posta adresleri alanına, bir önceki bölümde oluşturduğunuz hizmet hesabının e-posta adresini girin. Hizmet hesabının e-posta adresini bilmiyorsanız hizmet hesapları sayfasında değeri arayın.
9. EKLE'yi tıklayın. "Veri kaynağı başarıyla oluşturuldu" iletişim kutusu görünür.
10. *Tamam'ı tıklayın. Yeni oluşturulan veri kaynağının Kaynak Kimliği'ni not edin. Kaynak Kimliği, içerik bağlayıcısını yapılandırmak için kullanılır.

GitHub API için kişisel erişim jetonu oluşturma

Bağlayıcının, yeterli kotaya sahip olması için GitHub API'ye kimliği doğrulanmış erişim sağlaması gerekir. Bağlayıcı, basitlik açısından OAuth yerine kişisel erişim jetonlarını kullanır. Kişisel jetonlar, OAuth'a benzer sınırlı izin grubuna sahip kullanıcı olarak kimlik doğrulaması yapılmasına olanak tanır.

1. GitHub'a giriş yapın.
2. Sağ üst köşeden profil resminizi tıklayın. Bir açılır menü görüntülenir.
3. Ayarlar'ı tıklayın.
4. Geliştirici ayarları'nı tıklayın.
5. Kişisel erişim jetonları'nı tıklayın.
6. Kişisel erişim jetonu oluştur'u tıklayın.
7. Not alanına "Cloud Search eğiticisi" yazın.
8. public_repo kapsamını kontrol edin.
9. Jeton oluştur'u tıklayın.
10. Oluşturulan jetonu not edin. Bu API, bağlayıcı tarafından GitHub API'lerini çağırmak için kullanılır ve dizine ekleme işlemini gerçekleştirmek için API kotası sağlar.

Bağlayıcıyı yapılandırma

Kimlik bilgilerini ve veri kaynağını oluşturduktan sonra, bağlayıcı yapılandırmasını şu değerleri içerecek şekilde güncelleyin:

1. Komut satırından dizini cloud-search-samples/end-to-end/connector/ olarak değiştirin.
2. sample-config.properties dosyasını bir metin düzenleyiciyle açın.
3. api.serviceAccountPrivateKeyFile parametresini, daha önce indirdiğiniz hizmet kimlik bilgilerinin dosya yoluna ayarlayın.
4. api.sourceId parametresini, daha önce oluşturduğunuz veri kaynağının kimliğine ayarlayın.
5. github.user parametresini GitHub kullanıcı adınıza ayarlayın.
6. github.token parametresini daha önce oluşturduğunuz erişim jetonuna ayarlayın.
7. Dosyayı kaydedin.

Şemayı güncelleme

Bağlayıcı, hem yapılandırılmış hem de yapılandırılmamış içeriği dizine ekler. Verileri dizine eklemeden önce veri kaynağına ait şemayı güncellemeniz gerekir. Şemayı güncellemek için aşağıdaki komutu çalıştırın:

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

Bağlayıcıyı çalıştırma

Bağlayıcıyı çalıştırmak ve dizine eklemeye başlamak için şu komutu çalıştırın:

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

Bağlayıcı için varsayılan yapılandırma, googleworkspace kuruluşundaki tek bir depoyu dizine eklemektir. Deponun dizine eklenmesi yaklaşık 1 dakika sürer. İlk dizine ekleme işleminden sonra bağlayıcı, Cloud Search dizinine yansıtılması gereken depo değişiklikleri için yoklama yapmaya devam eder.

Kodu inceleme

Geri kalan bölümlerde bağlayıcının nasıl oluşturulduğu incelenir.

Uygulamayı başlatma

Bağlayıcının giriş noktası GithubConnector sınıfıdır. main yöntemi, SDK'nın IndexingApplication değerini somutlaştırır ve başlatır.

GithubConnector.java

GitHub'da göster

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

SDK tarafından sağlanan ListingConnector, dizindeki öğelerin durumunu izlemek için Cloud Search sıralarından yararlanan bir geçiş stratejisi uygular. GitHub'daki içeriğe erişmek için örnek bağlayıcı tarafından uygulanan GithubRepository ağına yetki verir.

GitHub depolarını geçme

Tam geçişler sırasında, dizine eklenmesi gerekebilecek öğeleri sıraya aktarmak için getIds() yöntemi çağrılır.

Bağlayıcı, birden fazla depo veya kuruluşu dizine ekleyebilir. Bir hatanın etkisini en aza indirmek için her defasında bir GitHub deposuna geçiş yapılır. getIds() için yapılan sonraki çağrılarda dizine eklenecek depoların listesini içeren geçişin sonuçlarıyla bir kontrol noktası döndürülür. Hata oluşursa dizine ekleme baştan başlamak yerine mevcut depoda devam ettirilir.

GithubRepository.java

GitHub'da göster

/**
 * 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() yöntemi tek bir GitHub deposu geçişini işler. Bu yöntem, sıraya aktarılacak öğeleri temsil eden bir ApiOperations koleksiyonu döndürür. Öğeler, kaynak adı ve öğenin mevcut durumunu temsil eden bir karma değeri olarak aktarılır.

Karma değeri, GitHub depolarının sonraki geçişlerinde kullanılır. Bu değer, ek içerik yüklemek zorunda kalmadan içeriğin değişip değişmediğini belirlemek için basit bir kontrol sağlar. Bağlayıcı körü körüne tüm öğeleri sıraya alır. Öğe yeniyse veya karma değeri değiştiyse sıradaki yoklama için kullanılabilir hale gelir. Aksi takdirde, öğe değiştirilmemiş kabul edilir.

GithubRepository.java

GitHub'da göster

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

Sıra işleniyor

Tam geçiş tamamlandıktan sonra, bağlayıcı, dizine eklenmesi gereken öğeler için sırayı yoklamaya başlar. getDoc() yöntemi, sıradan alınan her öğe için çağrılır. Bu yöntem, öğeyi GitHub'dan okur ve dizine ekleme için uygun temsile dönüştürür.

Bağlayıcı herhangi bir zamanda değiştirilebilen canlı verilere karşı çalıştığından getDoc(), sıradaki öğenin hâlâ geçerli olduğunu da doğrular ve artık var olmayan tüm öğeleri dizinden siler.

GithubRepository.java

GitHub'da göster

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

Bağlayıcının dizine eklediği GitHub nesnelerinin her biri için karşılık gelen indexItem() yöntemi, Cloud Search için öğe temsilini oluşturur. Örneğin, içerik öğelerinin temsilini oluşturmak için:

GithubRepository.java

GitHub'da göster

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

Ardından, arama arayüzünü dağıtın.

Önceki Sonraki