- タームは、
janeやsmithなどの1つの単語の場合があります。 - タームは、二重引用符で囲まれたフレーズ(
"customer log")の場合があり、同じ語順でフレーズにあるすべての単語に一致させます。 - フィールド名のないタームは、これらの選択されたフィールドにのみ一致させます。
- 複数のタームは、括弧を使ってグループにまとめ、サブクエリにすることができます。
- すべての検索フィールドでは、大文字と小文字が区別されます。
- 演算子(
AND、OR、NOT)はすべての検索可能なフィールドに使用できます。
検索可能なフィールド
以下のフィールドは検索可能で、大文字と小文字が区別されます。ベアのタームに対して検索可能なフィールド
検索タームがフィールド名を使わずに入力された場合には、以下のフィールドに対してのみ検索されます。client_nameconnectiondescriptioniplog_idtypeuser_name
完全一致
完全一致で検索するには、次のように、二重引用符を使用します:description:"Username invalid"。
例えば、Username invalidと一致するログを見つけるには、q=description:"Username invalid"を使用します。
ワイルドカード
ワイルドカード検索は、アスタリスク文字(*)を使用して0以上の文字を置換する次のようなタームに実行できます:user_name:john*。プレフィックスの照合では、user_name:j*などのように使用できます。ワイルドカードのその他の使用(サフィックスの照合など)の場合、リテラルは3文字以上である必要があります。たとえば、name:*usaは使用できますが、name:*saは使用できません。
クエスチョンマークの記号(?)には対応していません。
たとえば、ユーザー名がjohnで始まるユーザーを見つけるには、q=user_name:john*を使用します。
範囲
ログ検索クエリで範囲を使用することができます。包括的な範囲には[min TO max]のように角括弧を使用し、排他的な範囲には{min TO max}のように中括弧を使用します。
中括弧と角括弧は同じ範囲の表現内で組み合わせることができます。範囲内にワイルドカードを使用することもできます。
たとえば、2018年12月18日から現在までのログをすべて見つけるには、q=date:[2018-12-18 TO *]を使用します。
保存期間の始めから2018年12月19日の前日までのログを見つけるには、q=date:[* TO 2018-12-19}を使用します。
クエリの例
以下の例は、を使用して実行できるクエリの種類を紹介するものです。制限事項
414 Request-URI Too Large(要求のURIが長すぎます)のエラーが返された場合には、対応している長さよりもクエリ文字列が長いことを示しています。その場合には、検索を絞り込みます。- ログフィールドはトークン化されていないため、
description:ruleはCreate a rule(ルールの作成)やUpdate a rule(ルールの更新)の値を持つ説明には一致しません。この場合は、description:*ruleを使用します。ワイルドカード検索と完全一致を参照してください。 .rawフィールド拡張子には対応していません。フィールドは提供された値全体と照合され、トークン化はされません。
ページネーション
include_totalsパラメーターを使ってGET /api/v2/logsまたはGET /api/v2/users/{user_id}/logsエンドポイントを呼び出すと、結果の要約と要求されたログを含むJSONオブジェクトが返されます。以下のようなJSONオブジェクトになります。