Elasticsearch

Il connettore Elasticsearch ti consente di connetterti a un motore di ricerca Elasticsearch ed eseguire le operazioni del motore di ricerca supportate.

Prima di iniziare

Prima di utilizzare il connettore Elasticsearch, esegui le seguenti attività:

• Nel tuo progetto Google Cloud:
  • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
  • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente non umano che deve autenticarsi ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta la pagina Creazione di un account di servizio.

  • Abilita i seguenti servizi:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Per informazioni su come abilitare i servizi, vedi Attivazione dei servizi.

  Se questi servizi o autorizzazioni non sono stati abilitati in precedenza per il tuo progetto, ti viene richiesto di abilitarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore è necessario creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Se disponi di molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione:

1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

   Vai alla pagina Connessioni

2. Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
3. Nella sezione Posizione, scegli la località per la connessione.
   1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le aree geografiche supportate, consulta la sezione Località.

   2. Fai clic su AVANTI.
4. Nella sezione Dettagli connessione, completa quanto segue:
   1. Connettore: seleziona Elasticsearch dall'elenco a discesa dei connettori disponibili.
   2. Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
   3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 63 caratteri.
   4. Facoltativamente, inserisci una descrizione per l'istanza di connessione.
   5. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
   6. Facoltativamente, configura le impostazioni del nodo di connessione:
      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, al contrario, sono necessari meno nodi per elaborare un numero inferiore di transazioni. Per capire in che modo i nodi influiscono sui prezzi del connettore, consulta Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi viene impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi viene impostato su 50.

   Nota: puoi personalizzare i valori del nodo di connessione solo se sei un cliente con pagamento a consumo.
   7. Valutazione lato client: imposta ClientSideEvaluation su true per eseguire la valutazione sul lato client su oggetti nidificati.
   8. Modello dei dati: specifica il modello dei dati da utilizzare durante l'analisi dei documenti Elasticsearch e la generazione dei metadati del database.
   9. Numero massimo di risultati: il numero massimo di risultati totali da restituire da Elasticsearch quando si utilizza l'API Search predefinita.
   10. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e configurare i seguenti valori:
   • Schema di autenticazione proxy: seleziona il tipo di autenticazione per eseguire l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Di base: autenticazione HTTP di base.
     • Digest: autenticazione HTTP digest.
   • Utente proxy: un nome utente da utilizzare per l'autenticazione con il server proxy.
   • Password proxy: il secret di Secret Manager della password dell'utente.
   • Tipo SSL proxy: il tipo SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Automatica: l'impostazione predefinita. Se l'URL è HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è HTTP, viene utilizzata l'opzione MAI.
     • Sempre: la connessione è sempre SSL abilitata.
     • Mai: la connessione non è abilitata per SSL.
     • Tunnel: la connessione avviene attraverso un proxy di tunneling. Il server proxy apre una connessione con l'host remoto e il traffico passa attraverso il proxy.
   • Nella sezione Server proxy, inserisci i dettagli del server proxy.
     1. Fai clic su + Aggiungi destinazione.
     2. Seleziona un Tipo di destinazione.
        • Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.

          Se vuoi stabilire una connessione privata al tuo sistema di backend, segui questi passaggi:

          • Crea un collegamento al servizio PSC.
          • Crea un allegato endpoint, quindi inserisci i dettagli del collegamento nel campo Indirizzo host.
   11. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   12. Fai clic su AVANTI.
5. Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
   1. Tipo di destinazione: seleziona un Tipo di destinazione.
      • Seleziona Indirizzo host dall'elenco per specificare il nome host o l'indirizzo IP della destinazione.
      • Se vuoi stabilire una connessione privata ai tuoi sistemi di backend, seleziona Collegamento endpoint dall'elenco, quindi seleziona il collegamento dell'endpoint richiesto dall'elenco Collegamento endpoint.
        Nota : per capire come creare un collegamento dell'endpoint, vedi Collegamento del servizio PSC e Collegamento dell'endpoint. Una volta creato, il collegamento dell'endpoint sarà visibile nell'elenco Allegato endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi considerare di configurare indirizzi IP in uscita statici per le tue connessioni e quindi configurare le regole del firewall in modo da inserire nella lista consentita solo gli indirizzi IP statici specifici.

      Per inserire altre destinazioni, fai clic su +AGGIUNGI DESTINAZIONE.

   2. Fai clic su AVANTI.
6. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
   1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione Elasticsearch supporta i seguenti tipi di autenticazione:

      • Anonimo
      • Nome utente e password

   Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

   2. Fai clic su AVANTI.
7. Verifica: controlla i dettagli della connessione e dell'autenticazione.
8. Fai clic su Crea.

Configura autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

• Anonimo

  Se vuoi utilizzare l'accesso anonimo, seleziona Non disponibile.

• Nome utente e password
  • Nome utente: nome utente del connettore
  • Password: il secret di Secret Manager contenente la password associata al connettore.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene esposta sotto forma di entità, operazioni e azioni.

Nota: puoi visualizzare le entità, le operazioni e le azioni di un connettore nell'attività Connettori.

• Entità: un'entità può essere considerata come un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità è diversa da un connettore a un connettore. Ad esempio, in un connettore di database le tabelle sono le entità, in un connettore file server le cartelle sono le entità, mentre in un connettore di sistema di messaggistica le code sono le entità.

  Tuttavia, è possibile che un connettore non supporti o non abbia entità. In questo caso, l'elenco Entities sarà vuoto.

• Operazione: un'operazione è l'attività che è possibile eseguire su un'entità. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sull'entità dell'attività Connectors. Tuttavia, se un connettore non supporta nessuna delle operazioni relative alle entità, le operazioni non supportate non saranno elencate nell'elenco Operations.

• Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità e variare da connettore a connettore. Normalmente, un'azione avrà alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Nota : a tutte le entità e alle azioni è associato uno schema. Ad esempio, uno schema delle azioni contiene i dettagli dei parametri, come i nomi dei parametri e il tipo di dati corrispondente. Lo schema (metadati) per le entità e le azioni viene recuperato dalla connessione in fase di runtime dal tuo backend. Se sono presenti aggiornamenti allo schema, questi aggiornamenti non si rifletteranno automaticamente nelle connessioni esistenti. Devi aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione, quindi fai clic su Aggiorna schema di connessione.

Limitazioni di sistema

Il connettore Elasticsearch può elaborare 10 transazioni al secondo per nodo e limita le transazioni che superano questo limite. Per impostazione predefinita, Integration Connectors alloca due nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

Nota: il numero di nodi di Integration Connectors verrà scalato automaticamente in modo dinamico in base all'utilizzo. Tuttavia, se vuoi prenotare capacità per grandi volumi senza attendere la scalabilità automatica, puoi regolare il valore minimo del nodo per una connessione. Sono necessari più nodi per elaborare più transazioni per una connessione. Al contrario, sono necessari meno nodi se una connessione elabora meno transazioni. Per configurare i valori del nodo:

• Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo dei nodi nella pagina Modifica connessione.
• Se sei un cliente con abbonamento, contatta l'assistenza.

Il numero massimo di transazioni che un nodo è in grado di gestire dipende da vari fattori. Pertanto, prima di regolare il numero minimo di nodi per migliorare la velocità effettiva, ti consigliamo di verificare se i tuoi sistemi di backend sono configurati in modo ottimale per gestire il traffico richiesto.

Azioni

Questa sezione elenca le azioni supportate dal connettore. Per capire come configurare le azioni, consulta Esempi di azioni.

Nota: i risultati di tutte le azioni saranno disponibili come risposta JSON nel parametro di risposta connectorOutputPayload dell'attività Connectors dopo aver eseguito l'integrazione.

Azione CreateIndex

Questa azione crea un indice.

Parametri di input dell'azione CreateIndex

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
AliasFilter	String	No	Query su oggetto DSL utilizzato per limitare i documenti a cui l'alias può accedere.
NumberOfShards	String	No	Il numero di shard primari che dovrebbe avere l'indice creato.
AliasIsWriteIndex	Booleano	No	Specifica se l'indice alias è scrivibile.
Alias	String	No	Un alias per l'indice.
AliasIndexRouting	String	No	Valore utilizzato dall'alias per instradare le operazioni di indicizzazione a uno shard specifico. Se specificato, sovrascrive il valore di routing per le operazioni di indicizzazione.
Indice	String	Sì	Il nome dell'indice.
NumberOfRoutingShards	String	No	Numero utilizzato internamente da Elasticsearch con il valore da NumberOfShards per instradare documenti a uno shard primario.
OtherSettings	String	No	Un oggetto JSON delle impostazioni. Questa impostazione non può essere utilizzata insieme a NumberOfRoutingShards o NumberOfShards.
Mappature	String	No	Un oggetto JSON che specifica il mapping per l'indice.
AliasIsHidden	Booleano	No	Specifica se l'alias è nascosto. Tutti gli indici dell'alias devono avere lo stesso valore is_hidden.
AliasRouting	String	No	Valore utilizzato dall'alias per indirizzare le operazioni di indicizzazione e ricerca a uno shard specifico. Potrebbe essere sovrascritto da AliasIndexRouting o AliasSearchRouting per determinate operazioni.

Parametri di output dell'azione CreateIndex

Se l'azione è riuscita, questa azione restituisce lo stato 200 (OK).

Per capire come configurare l'azione CreateIndex, consulta Esempi di azioni.

Azione EditIndexAliases

Questa azione modifica un alias di indice.

Parametri di input dell'azione EditIndexAliases

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Alias	String	No	Il nome dell'alias. Gli alias multipli sono separati da punto e virgola.
Filtro	String	No	Un filtro da utilizzare durante la creazione dell'alias. Viene preso il filtro JSON non elaborato utilizzando Query DSL. Se ci sono più filtri separati da punto e virgola,
Routing	String	No	Il valore di routing da associare all'alias. Più valori di routing sono separati da punto e virgola.
SearchRouting	String	No	Il valore di routing da associare all'alias per le operazioni di ricerca. Più valori di routing della ricerca sono separati da punto e virgola.
IndexRouting	String	No	Il valore di routing da associare all'alias per le operazioni di indicizzazione. Più valori di routing dell'indice sono separati da punto e virgola.
Azione	String	Sì	L'azione da eseguire, ad esempio add, remove o remove_index. Le azioni multiple sono separate da punto e virgola.
Indice	String	Sì	Il nome dell'indice. Gli indici multipli sono separati da punto e virgola.

Parametri di output dell'azione EditIndexAliases

Se l'azione è riuscita, questa azione restituisce lo stato 200 (OK).

Per capire come configurare l'azione ModifyIndexAliases, consulta Esempi di azioni.

azione Esecuzione CustomQuery

Questa azione ti consente di eseguire una query personalizzata.

Per creare una query personalizzata:

1. Segui le istruzioni dettagliate per aggiungere un'attività dei connettori.
2. Quando configuri l'attività del connettore, seleziona Azioni nel tipo di azione che vuoi eseguire.
3. Nell'elenco Azione, seleziona Esegui query personalizzata, quindi fai clic su Fine.

   

4. Espandi la sezione Input attività, quindi segui questi passaggi:
   1. Nel campo Timeout dopo, inserisci il numero di secondi di attesa prima che la query venga eseguita.

      Valore predefinito: 180 secondi.

   2. Nel campo Numero massimo di righe, inserisci il numero massimo di righe da restituire dal database.

      Valore predefinito: 25.

   3. Per aggiornare la query personalizzata, fai clic su Modifica script personalizzato. Viene visualizzata la finestra di dialogo Editor di script.

      

   4. Nella finestra di dialogo Editor di script, inserisci la query SQL e fai clic su Salva.

      Puoi utilizzare un punto interrogativo (?) in un'istruzione SQL per rappresentare un singolo parametro che deve essere specificato nell'elenco parametri di ricerca. Ad esempio, la seguente query SQL seleziona tutte le righe della tabella Employees corrispondenti ai valori specificati per la colonna LastName:

      SELECT * FROM Employees where LastName=?

      Nota: sono supportate le istruzioni DML (Data Manipulation Language) e DDL (Data Definition Language).
   5. Se hai utilizzato dei punti interrogativi nella query SQL, devi aggiungere il parametro facendo clic su + Aggiungi nome parametro per ciascun punto. Durante l'esecuzione dell'integrazione, questi parametri sostituiscono in sequenza i punti interrogativi (?) nella query SQL. Ad esempio, se hai aggiunto tre punti interrogativi (?), devi aggiungere tre parametri in ordine sequenziale.

      

      Per aggiungere parametri di ricerca:

      1. Nell'elenco Tipo, seleziona il tipo di dati del parametro.
      2. Nel campo Valore, inserisci il valore del parametro.
      3. Per aggiungere più parametri, fai clic su + Aggiungi parametro di query.

Se l'esecuzione è riuscita, questa azione restituisce lo stato 200 (OK) con un corpo della risposta contenente i risultati della query.

Esempi di azioni

In questa sezione viene descritto come eseguire alcune azioni in questo connettore.

Esempio: creare un indice

Questo esempio crea un indice.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CreateIndex e fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "Index": "new_index_1"
   }

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività CreateIndex avrà un valore simile al seguente:

[{
"CompletedBeforeTimeout": "true",
"ShardsAcknowledged": "true",
"IndexName": "new_index_1"
}]

Esempio - Modificare un alias di un indice

Questo esempio mostra come modificare un alias di indice.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione ModifyIndexAliases e fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "Action": "remove_index",
   "Index": "postmanindex"
   }

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività ModifyIndexAliases avrà un valore simile al seguente:

[{
}]

Esempi di operazioni con entità

Questa sezione mostra come eseguire alcune delle operazioni relative alle entità in questo connettore.

Esempio: elenca tutti i record

In questo esempio sono elencati tutti i record nell'entità Demoindex.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Demoindex dall'elenco Entity.
3. Seleziona l'operazione List e fai clic su Fine.
4. Facoltativamente, nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Specifica il valore della clausola di filtro sempre tra virgolette singole (').

Esempio: recupero di un record da un'entità

Questo esempio ottiene un record con l'ID specificato dall'entità Demoindex.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Demoindex dall'elenco Entity.
3. Seleziona l'operazione Get e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId (ID entità), quindi inserisci 23 nel campo Valore predefinito.

   In questo caso, 23 è un ID record univoco nell'entità Demoindex.

Esempio: creare un record in un'entità

Questo esempio crea un record nell'entità Demoindex.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Demoindex dall'elenco Entity.
3. Seleziona l'operazione Create e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "message": "GET /search HTTP/1.1 200 1070000",
   "@timestamp": "2099-11-15 13:12:00.0"
   }

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   [{
   "_id": "23"
   }]

Esempio: aggiornare un record

Questo esempio aggiorna il record con l'ID specificato nell'entità Demoindex.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Demoindex dall'elenco Entity.
3. Seleziona l'operazione Update e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "message": "GET /search HTTP/1.1 200 1070000",
   "@timestamp": "2099-11-15 13:12:00.0",
   "name": "GoogleCloud_Update_docs",
   "price": 10.0}

5. Fai clic su entityId e inserisci 23 nel campo Default Value (Valore predefinito).

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   [{
   "_id": "23"
   }]

Esempio: eliminare un record da un'entità

Questo esempio elimina il record con l'ID specificato nell'entità Demoindex.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Demoindex dall'elenco Entity.
3. Seleziona l'operazione Delete e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci pcqT4wB4uQNUCuamh4N nel campo Valore predefinito.

Nota: se l'entità ha una chiave primaria composita, puoi specificare una clausola di filtro.

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, vedi Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di connessioni, vedi il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione di Terraform:

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
client_side_evaluation	BOOLEANO	False	Imposta ClientSideEvaluation su true per eseguire la valutazione sul lato client su oggetti nidificati.
data_model	ENUM	False	Specifica il modello dei dati da utilizzare durante l'analisi dei documenti Elasticsearch e la generazione dei metadati del database. I valori supportati sono: Document, FlattenedDocuments, Relational
max_results	STRING	False	Il numero massimo di risultati totali da restituire da Elasticsearch quando si utilizza l'API Search predefinita.
livello di dettaglio	STRING	False	Il livello di dettaglio per la connessione varia da 1 a 5. Con un livello di dettaglio più elevato, verranno registrati tutti i dettagli della comunicazione (certificati di richiesta, risposta e SSL).
proxy_enabled	BOOLEANO	False	Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme	ENUM	False	Il tipo di autenticazione da utilizzare per l'autenticazione sul proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user	STRING	False	Un nome utente da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_password	SECRET	False	Una password da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_ssltype	ENUM	False	Il tipo SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL

Utilizzare la connessione Elasticsearch in un'integrazione

Dopo aver creato la connessione, la connessione diventa disponibile sia in Apigee Integration che in Application Integration. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

• Per capire come creare e utilizzare l'attività Connectors in Apigee Integration, vedi Attività connettori.
• Per capire come creare e utilizzare l'attività Connettori in Application Integration, vedi Attività connettori.

Ricevi assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community Google Cloud nei forum di Cloud.

Passaggi successivi

• Scopri come sospendere e ripristinare una connessione.
• Scopri come monitorare l'utilizzo dei connettori.
• Scopri come visualizzare i log del connettore.