Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Salva ed esegui nuovamente le query di Logs Insights CloudWatch

Dopo aver creato una query, è possibile salvarla in modo da poterla eseguire di nuovo in un secondo momento. Le interrogazioni vengono salvate in una struttura di cartelle, in modo da poterle organizzare. Puoi salvare fino a 1000 query per regione per account.

Le interrogazioni vengono salvate a un livello specifico della regione, non a un livello specifico dell'utente. Se si crea e si salva un'interrogazione, gli altri utenti con accesso ai CloudWatch registri nella stessa area possono visualizzare tutte le interrogazioni salvate e le relative strutture di cartelle nella regione.

Per salvare una query, è necessario accedere a un ruolo che dispone dell'autorizzazione logs:PutQueryDefinition. Per visualizzare un elenco di query salvate, è necessario accedere a un ruolo che dispone dell'autorizzazione logs:DescribeQueryDefinitions.

Console

Per salvare un'interrogazione

1. Apri la CloudWatch console all'indirizzo https://console.aws.amazon.com/cloudwatch/.

2. Nel pannello di navigazione scegli Logs (Registri), quindi Logs Insights.

3. Nell'editor di query, crea una query.

4. Scegli Save (Salva).

5. Immettere un nome per la query.

6. (Facoltativo) Scegliere una cartella in cui si desidera salvare la query. Selezionare Create new (Crea nuova) per creare una cartella. Se si crea una nuova cartella, è possibile utilizzare i caratteri barra (/) nel nome della cartella per definire una struttura di cartelle. Ad esempio, la denominazione di una nuova cartella folder-level-1/folder-level-2 crea una cartella di livello superiore denominata folder-level-1, con un'altra cartella chiamata folder-level-2 all'interno di tale cartella. La query viene salvata in folder-level-2.

7. (Facoltativo) Modificare i gruppi di log o il testo della query.

8. (Facoltativo) Per utilizzare i parametri nella query, segui questi passaggi aggiuntivi:

   1. Aggiungi parametri alla tua query. Sostituisci i valori statici con segnaposto utilizzando la {{parameter}} sintassi (doppie parentesi prima e dopo il nome del parametro).

      Esempio: interrogazione originale con valori statici:

      fields @timestamp, @message
      | filter level = "Error"
      | filter applicationName = "OrderService"

      Interrogazione aggiornata con parametri:

      fields @timestamp, @message
      | filter level = {{logLevel}}
      | filter applicationName = {{applicationName}}

   2. Definire i parametri utilizzati nella query. Per ogni parametro segnaposto, specificate:

      • Nome: deve corrispondere esattamente al nome del segnaposto (ad esempio,). logLevel applicationName

      • Valore predefinito (opzionale): il valore da utilizzare se non viene fornito alcun valore di parametro.

      • Descrizione (opzionale): spiega lo scopo del parametro.

   3. Le interrogazioni con parametri possono essere eseguite utilizzando il nome della query con un $ prefisso e passando i nomi dei parametri come coppie chiave-valore. Per ulteriori informazioni, vedere Eseguire un'interrogazione salvata.

9. Scegli Save (Salva).

AWS CLI

Per salvare un'interrogazione, usaput-query-definition:

aws logs put-query-definition \
  --name "ErrorsByLevel" \
  --query-string "fields @timestamp, @message | filter level = \"ERROR\"" \
  --log-group-names "/aws/lambda/my-function" \
  --region us-east-1

(Facoltativo) Per salvare un'interrogazione con parametri, aggiungete l'--parametersopzione e utilizzate i {{parameterName}} segnaposto nella stringa di query:

aws logs put-query-definition \
  --name "ErrorsByLevel" \
  --query-string "fields @timestamp, @message | filter level = {{logLevel}} | filter applicationName = {{applicationName}}" \
  --parameters '[{"name":"logLevel","defaultValue":"ERROR","description":"Log level to filter"},{"name":"applicationName","defaultValue":"OrderService","description":"Application name to filter"}]' \
  --log-group-names "/aws/lambda/my-function" \
  --region us-east-1

Per salvare un'interrogazione in una cartella, aggiungete il percorso della cartella come prefisso al nome della query:

aws logs put-query-definition \
  --name "my-folder/ErrorsByLevel" \
  --query-string "fields @timestamp, @message | filter level = {{logLevel}}" \
  --parameters '[{"name":"logLevel","defaultValue":"ERROR","description":"Log level to filter"}]' \
  --log-group-names "/aws/lambda/my-function" \
  --region us-east-1

API

Per salvare un'interrogazione, chiama PutQueryDefinition:

{
  "name": "ErrorsByLevel",
  "queryString": "fields @timestamp, @message | filter level = \"ERROR\"",
  "logGroupNames": ["/aws/lambda/my-function"]
}

(Facoltativo) Per salvare un'interrogazione con parametri, includete il parameters campo e utilizzate i {{parameterName}} segnaposto nella stringa di query:

{
  "name": "ErrorsByLevel",
  "queryString": "fields @timestamp, @message | filter level = {{logLevel}} | filter applicationName = {{applicationName}}",
  "logGroupNames": ["/aws/lambda/my-function"],
  "parameters": [
    {
      "name": "logLevel",
      "defaultValue": "ERROR",
      "description": "Log level to filter"
    },
    {
      "name": "applicationName",
      "defaultValue": "OrderService",
      "description": "Application name to filter"
    }
  ]
}

Console

Per eseguire una query salvata

1. Apri la CloudWatch console all'indirizzo https://console.aws.amazon.com/cloudwatch/.

2. Nel pannello di navigazione scegli Logs (Registri), quindi Logs Insights.

3. A destra, scegliere Query.

4. Seleziona la tua interrogazione dall'elenco Interrogazioni salvate. Il testo della query viene visualizzato nell'editor delle query.

5. (Facoltativo) Per utilizzare un'interrogazione con parametri:

   1. Scegli l'icona + accanto al nome dell'interrogazione nel pannello laterale Interrogazioni salvate.

   2. L'interrogazione con parametri viene visualizzata nell'editor delle interrogazioni. Ad esempio, se si sceglie l'icona + accanto aErrorsByLevel, l'editor di query viene popolato con: $ErrorsByLevel(level=, applicationName=)

   3. Fornire i valori per i parametri (level, ApplicationName) ed eseguire la query. Ad esempio: $ErrorsByLevel(level= "ERROR", applicationName= "OrderService")

6. Scegli Esegui.

AWS CLI

Per eseguire un'interrogazione salvata con parametri

Utilizzare start-query con la $QueryName() sintassi:

aws logs start-query \
  --log-group-names "/aws/lambda/my-function" \
  --start-time 1707566400 --end-time 1707570000 \
  --query-string '$ErrorsByLevel(level= "ERROR", applicationName= "OrderService")' \
  --region us-east-1

API

Per eseguire un'interrogazione salvata con parametri

Chiama StartQuerycon la $QueryName() sintassi presente nel queryString campo:

{
  "logGroupNames": ["/aws/lambda/my-function"],
  "startTime": 1707566400,
  "endTime": 1707570000,
  "queryString": "$ErrorsByLevel(level=\"ERROR\", applicationName= \"OrderService\")"
}

Per eliminare una query, è necessario accedere a un ruolo che dispone dell'autorizzazione logs:DeleteQueryDefinition.

Utilizzo di interrogazioni salvate con parametri

Le interrogazioni salvate con parametri sono modelli di query riutilizzabili con segnaposto denominati. Invece di conservare più copie di interrogazioni quasi identiche, è possibile salvare un modello e fornire valori di parametro diversi durante l'esecuzione della query. I parametri sono supportati solo nel linguaggio di interrogazione CloudWatch Logs Insights.

Come funziona

Quando si salva un'interrogazione, i segnaposto identificano i valori che è possibile fornire al momento dell'esecuzione della query. I segnaposti utilizzano la sintassi. {{parameterName}} Di seguito è riportato un esempio di interrogazione salvata denominata ErrorsByLevel con due parametri e. logLevel applicationName

fields @timestamp, @message
| filter level = {{logLevel}}
| filter applicationName = {{applicationName}}

Per eseguire un'interrogazione salvata, è possibile richiamarla utilizzando il nome dell'interrogazione preceduto da $ e passando i valori dei parametri. Il motore di query CloudWatch Logs Insights sostituisce ogni segnaposto. Se un parametro contiene valori predefiniti, tali valori vengono utilizzati se non vengono forniti altri valori.

# Run query by using query name and passing parameter values explicitly
$ErrorsByLevel(logLevel = "WARN", applicationName = "OrderService")

# Run query without specifying parameter values - default values are used in this case.
$ErrorsByLevel()

I nomi delle interrogazioni salvate contenenti spazi o caratteri speciali devono essere racchiusi tra segni di spunta inversa:

$`Errors By Level`(logLevel = "WARN")

Esempi di interrogazioni salvate con parametri

Aggiungere un limite di risultati come parametro

Nome della query: ErrorsByLevel con parametri logLevel (default:"ERROR"), applicationName (default:"OrderService") e maxResults (default:50)

fields @timestamp, @message, @logStream
| filter level = {{logLevel}}
| filter applicationName = {{applicationName}}
| sort @timestamp desc
| limit {{maxResults}}

# Run the query using the query name and passing parameter values
$ErrorsByLevel(logLevel = "WARN", applicationName = "OrderService", maxResults = 100)

Utilizzo di più interrogazioni salvate con parametri

L'esempio seguente utilizza ErrorsByLevel una seconda query salvata RecentN che è definita come sort @timestamp desc | limit {{count}} (con parametrocount, impostazione predefinita20). Il motore di query CloudWatch Logs Insights espande ogni query prima di eseguirla.

# Using multiple queries with parameters in sequence
$ErrorsByLevel(logLevel = "WARN", applicationName = "OrderService")
| $RecentN(count = 10)

# Each of the queries is expanded, resulting in the following query when it is run.
fields @timestamp, @message
| filter level = "WARN"
| filter applicationName = "OrderService"
| sort @timestamp desc
| limit 10

Quote e gestione degli errori

La stringa di query espansa non può superare i 10.000 caratteri. I nomi dei parametri devono iniziare con una lettera o un carattere di sottolineatura. Un'interrogazione salvata non può fare riferimento a un'altra interrogazione salvata (le chiamate annidate non sono supportate).