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 queste operazioni:

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 saperne di più, consulta la pagina sulla 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 Abilitazione dei servizi.
Se questi servizi o queste autorizzazioni non sono stati abilitati per il tuo progetto in precedenza, ti verrà chiesto 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. Ciò significa che se disponi di molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione, segui questi passaggi:

Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.
Vai alla pagina Connessioni
Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
Nella sezione Posizione, scegli la località per la connessione.
1. Regione: seleziona una località dall'elenco a discesa.
  Per l'elenco di tutte le regioni supportate, vedi Località.
2. Fai clic su AVANTI.
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 superare i 63 caratteri.
4. (Facoltativo) 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 minore 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 è impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi è impostato su 50.
7. Valutazione lato client: imposta ClientSideEvaluation su true per eseguire la valutazione lato client sugli oggetti nidificati.
8. Modello di dati: specifica il modello dei dati da utilizzare durante l'analisi dei documenti Elasticsearch e la generazione dei metadati del database.
9. Max risultati: il numero massimo di risultati totali da restituire da Elasticsearch quando utilizzi 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:
11. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave-valore.
12. Fai clic su AVANTI.
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.
  1. Nel campo Indirizzo host, specifica il nome host o l'indirizzo IP della destinazione.
    1. Se vuoi stabilire una connessione privata ai sistemi di backend, segui questi passaggi:
      1. Crea un collegamento al servizio PSC.
      2. Crea un collegamento endpoint e inserisci i relativi dettagli nel campo Indirizzo host.
    2. Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi configurare indirizzi IP statici in uscita per le tue connessioni, quindi configurare le regole firewall in modo da inserire nella lista consentita solo indirizzi IP statici specifici.
  Per inserire altre destinazioni, fai clic su +AGGIUNGI DESTINAZIONE.
2. Fai clic su AVANTI.
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
2. Fai clic su AVANTI.
Verifica: controlla i dettagli di connessione e autenticazione.
Fai clic su Crea.

Configura l'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 è esposta come entità, operazioni e azioni.

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 di file server, le cartelle sono le entità e in un connettore di sistema di messaggistica le code sono le entità.
Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.
Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:
- Elenca
- Scarica
- Crea
- Aggiorna
- Elimina
Se selezioni un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni delle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni delle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.
Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione attraverso l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità e di variare da connettore a connettore. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Limitazioni di sistema

Il connettore Elasticsearch può elaborare 10 transazioni al secondo per nodo e limitare qualsiasi transazione oltre questo limite. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, consulta 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. Per elaborare più transazioni per una connessione, sono necessari più nodi. Al contrario, se una connessione elabora meno transazioni, sono necessari meno nodi. Per configurare i valori dei nodi:

Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo del nodo nella pagina di modifica delle connessioni.
Se sei un cliente che ha sottoscritto un abbonamento, contatta l'assistenza.

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

Azioni

In questa sezione sono elencate le azioni supportate dal connettore. Per capire come configurare le azioni, consulta gli esempi di azioni.

Nota: i risultati di tutte le azioni saranno disponibili come risposta JSON nel parametro di risposta connectorOutputPayload dell'attività di 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	Stringa	No	Esegui una query sull'oggetto DSL utilizzato per limitare i documenti a cui può accedere l'alias.
NumberOfShards	Stringa	No	Il numero di shard primari che deve avere l'indice creato.
AliasIsWriteIndex	Booleano	No	Specifica se è possibile scrivere nell'indice alias.
Alias	Stringa	No	Un alias per l'indice.
AliasIndexRouting	Stringa	No	Valore utilizzato dall'alias per instradare le operazioni di indicizzazione a uno shard specifico. Se specificato, il valore di routing per le operazioni di indicizzazione viene sovrascritto.
Indice	Stringa	Sì	Il nome dell'indice.
NumberOfRoutingShards	Stringa	No	Numero utilizzato da Elasticsearch internamente con il valore di NumberOfShards per il routing dei documenti a uno shard primario.
OtherSettings	Stringa	No	Un oggetto JSON delle impostazioni. Questa impostazione non può essere utilizzata in combinazione con NumberOfRoutingShards o NumberOfShards.
Mappature	Stringa	No	Un oggetto JSON che specifica la mappatura dell'indice.
AliasIsHidden	Booleano	No	Specifica se l'alias è nascosto. Tutti gli indici dell'alias devono avere lo stesso valore `is_hidden`.
AliasRouting	Stringa	No	Valore utilizzato dall'alias per instradare le operazioni di indicizzazione e ricerca a uno shard specifico. Può essere sovrascritto da AliasIndexRouting o AliasSearchRouting per determinate operazioni.

Parametri di output dell'azione CreateIndex

Se l'azione ha esito positivo, l'azione restituisce lo stato 200 (OK).

Per capire come configurare l'azione CreateIndex, consulta la sezione 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	Stringa	No	Il nome dell'alias. Più alias sono separati da punto e virgola.
Filtro	Stringa	No	Un filtro da utilizzare durante la creazione dell'alias. Questa operazione prende il filtro JSON non elaborato utilizzando Query DSL. Più filtri sono separati da un punto e virgola.
Routing	Stringa	No	Il valore di routing da associare all'alias. Più valori di routing sono separati da punto e virgola.
SearchRouting	Stringa	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	Stringa	No	Il valore di routing da associare all'alias per le operazioni di indicizzazione. Più valori di routing degli indici sono separati da punto e virgola.
Azione	Stringa	Sì	L'azione da eseguire, ad esempio `add`, `remove` o `remove_index`. Più azioni sono separate da punto e virgola.
Indice	Stringa	Sì	Il nome dell'indice. Più indici sono separati da punto e virgola.

Parametri di output dell'azioneModifiedIndexAliases

Se l'azione ha esito positivo, l'azione restituisce lo stato 200 (OK).

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

Azione ExecuteCustomQuery

Questa azione ti consente di eseguire una query personalizzata.

Per creare una query personalizzata:

Segui le istruzioni dettagliate per aggiungere un'attività dei connettori.
Quando configuri l'attività del connettore, seleziona Azioni nel tipo di azione da eseguire.
Nell'elenco Azione, seleziona Esegui query personalizzata e fai clic su Fine.
Espandi la sezione Input attività, quindi segui questi passaggi:
1. Nel campo Timeout dopo, inserisci il numero di secondi di attesa prima dell'esecuzione della query.
  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 query personalizzata. Si apre 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 che corrispondono 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 punti interrogativi nella query SQL, devi aggiungere il parametro facendo clic su + Aggiungi nome parametro per ciascun punto interrogativo. Durante l'esecuzione dell'integrazione, questi parametri sostituiscono i punti interrogativi (?) nella query SQL in modo sequenziale. Ad esempio, se hai aggiunto tre punti interrogativi (?), devi aggiungere tre parametri in ordine di sequenza. 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 ricerca.

Se l'esecuzione viene eseguita correttamente, questa azione restituisce lo stato 200 (OK) con un corpo della risposta che contiene i risultati della query.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio - Creare un indice

In questo esempio viene creato un indice.

Nella finestra di dialogo Configure connector task, fai clic su Actions.
Seleziona l'azione CreateIndex, quindi fai clic su Fine.
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à di CreateIndex avrà un valore simile al seguente:

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

Esempio: modificare un alias di indice

Questo esempio mostra come modificare un alias di indice.

Nella finestra di dialogo Configure connector task, fai clic su Actions.
Seleziona l'azione ModifyIndexAliases, quindi fai clic su Fine.
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à di ModifyIndexAliases avrà un valore simile al seguente:

[{
}]

Esempi di operazioni sull'entità

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

Esempio: elencare tutti i record

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

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Demoindex dall'elenco Entity.
Seleziona l'operazione List, quindi fai clic su Fine.
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 compreso tra virgolette singole (').

Esempio: recuperare un record da un'entità

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

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Demoindex dall'elenco Entity.
Seleziona l'operazione Get, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e inserisci 23 nel campo Valore predefinito.
Qui, 23 è un ID record univoco nell'entità Demoindex.

Esempio: creare un record in un'entità

In questo esempio viene creato un record nell'entità Demoindex.

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Demoindex dall'elenco Entity.
Seleziona l'operazione Create, quindi fai clic su Fine.
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: aggiornamento di un record

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

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Demoindex dall'elenco Entity.
Seleziona l'operazione Update, quindi fai clic su Fine.
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}
```
Fai clic su entityId, quindi 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.

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

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

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

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

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

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
client_side_evaluation	BOOLEANO	False	Imposta ClientSideEvaluation su true per eseguire il lato client di valutazione sugli 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 utilizzi l'API Search predefinita.
livello di dettaglio	STRING	False	Livello di Preferenze di lettura per la connessione, varia da 1 a 5. Un livello di dettaglio maggiore registra tutti i dettagli delle comunicazioni (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 eseguire l'autenticazione sul proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user	STRING	False	Un nome utente da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_password	SECRET	False	Una password da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_ssltype	ENUM	False	Il tipo di SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, GCP

Utilizza la connessione Elasticsearch in un'integrazione

Dopo aver creato 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à Connettori in Apigee Integration, consulta Attività Connettori.
Per capire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevi assistenza dalla community Google Cloud

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

Passaggi successivi

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