NRQLマスターになろう - JSON編

ログなどのデータに含まれるJSON文字列をNRQLを使って解析する方法を解説します。改めて構造化したログを送りたいけど手が加えられない、でもなんとかして今のログは上手く使いたい、そんなときはご参考にしてください。

# はじめに
New Relicにログなどのデータを送る際にメッセージフィールドがJSONの場合は、自動的にKey/Valueに分解されて保存されるので、特に意識する必要なくログデータを簡単に分析することができます。

しかし、すでに出力しているログの中にJSON以外の情報も付与されている場合などは妥当なJSONとして認識されず自動的な解析が行われません。本来、ログを構造化して送るように変更するのが綺麗な対応方法ではありますが、諸事情で改変が行えない、影響範囲が大きすぎるという場合もあるでしょう。

その場合は、ログの取り込み後にログに含まれるJSONを抽出し、解析する方法が必要ですが、New Relicのクエリ言語である[NRQL（New Relic Query Language）](https://docs.newrelic.com/jp/docs/nrql/get-started/introduction-nrql-new-relics-query-language/)を利用すればそれを実現できます。この記事ではNRQLがサポートするJSON解析のための関数を使ってどのように情報が抽出できるかみていきたいと思います。


# ログからのJSONの抽出
まず始めに、単純なJSONではないログ（ログの中の一部にJSONが含まれる）からJSONテキストの部分を抽出します。

例えば以下のログをみてみましょう。前半に時刻やその他の情報があり、その後にJSON文字列が続きます。
```
(1) 2024/12/03 23:33:10.419116 {\"level\":\"debug\",\"msg\":\"transaction ended\",
\"context\":{\"app_connected\":true,\"duration_ms\":1.100159,\"ignored\":false,
\"name\":\"WebTransaction/Go/hipstershop.ShippingService/GetQuote\"}}
```

このような文字列の場合妥当なJSONとは判断される自動的に解析はされないのでNew RelicのUI上でも以下のような形で見えるので検索性が良いとは言えません。

![log_1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/0cb236d1-cafc-47dc-0f30-e75c64b46b5e.png)


この文字列から後半のJSON文字列を抽出してみます。文字列から特定の部分だけを抽出するためには***capture関数***や***aparse関数***を利用します。それらの関数の詳細に関しては以下をご参照ください。

https://qiita.com/ktst79/items/56e49f71487928c5bca1


今回はJSON部分を抽出するのにcapture関数を使ってみます。capture関数は、ログのフォーマットを正規表現込みで指定することで欲しい部分だけを抽出できます。今回は、ログの前半が「(1) 2024/12/04 04:24:16.2222 」のような形になっているのでその部分を正規表現で指定し、後半部分を全てJSONとして抽出するため、```capture(message, r'\(\d\) [\d/]+ [\d:\.]+ (?P<json>.*)')```としています。

```sql:JSON文字列の抽出
WITH capture(message, r'\(\d\) [\d/]+ [\d:\.]+ (?P<json>.*)') as json
SELECT message, json  
FROM Log 
WHERE json is not null
```

NRQLを実行した結果が以下です。Messageがオリジナルのログメッセージ、JSONがJSON部分だけ抽出したものです。意図通り抽出できていることがわかりました。今回はcapture関数を利用しましたが、もっと簡単なフォーマットであればaparse関数を使っても良いです。

![log_2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/34825cd1-7c5d-ca04-acd1-5f4b93e8922b.png)



これで準備は完了です。JSONから情報を取り出す様々な方法を試してみます。

# JSONからの情報抽出
JSONからの情報抽出にはjparseという関数を利用します。jparseは、```jparse(<属性>, ‘<jsonパス>’)```という構文になっており、jsonパスの部分を変えることにより、<属性>に指定したJSON文字列から様々な要素を取り出すことができます。jparse関数の詳細は以下のドキュメントを参照ください。

https://docs.newrelic.com/jp/docs/nrql/nrql-syntax-clauses-functions/#func-jparse


今回は、ドキュメントにある例を実際に動かしてみてどのような結果が得られるかをみていきます。
### 前提
今回簡単のため、以下のようなJSON文字列を前提として情報を抽出してみます。実際にはLogなどのイベントからJSONのデータを引っ張ってきますが、試験的に動かすのでNRQLのWITH句で該当のJSON文字列を直指定しちゃいます。

```json: JSONの例
{
  "valueA": "test",
  "valueB": {
    "nestedValue1": [1, 2, 3],
    "nestedValue2": 100
  },
  "valueC": [
    { "id": 1, "label": "A", "other": 7 },
    { "id": 2, "label": "B", "other": 9 },
    { "id": 3, "label": "C", "other": 13 }
  ]
}
```

### 指定したキーの値を取るNRQL
```sql: 指定したキーの値を取るNRQL
WITH '{"valueA": "test", "valueB": {"nestedValue1": [1, 2, 3], "nestedValue2": 100}, "valueC": [{ "id": 1, "label": "A", "other": 7 }, { "id": 2, "label": "B", "other": 9 }, { "id": 3, "label": "C", "other": 13 }]}' 
  as json 
SELECT jparse(json, 'valueA') as 'Value' 
```
キーvalueAに対応する値であるtestが取得できました。

![log_3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/3842fb7a-38e8-d8d9-96ee-a8a507e4d406.png)


### 指定したキーの値を取るNRQL（ネストされている場合） 
では、値がネストしている場合はどうでしょうか？valueBを指定してみます。
```sql: 指定したキーの値を取るNRQL（ネストされている場合）
WITH '{"valueA": "test", "valueB": {"nestedValue1": [1, 2, 3], "nestedValue2": 100}, "valueC": [{ "id": 1, "label": "A", "other": 7 }, { "id": 2, "label": "B", "other": 9 }, { "id": 3, "label": "C", "other": 13 }]}'
  as json 
SELECT jparse(json, 'valueB') as 'Value' 
```
valueBの値のJSONが取り出せました。

![log_4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/1d8e8bb0-5b8c-3ef1-11e2-0644b32a77c8.png)


ちなみに結果をJSON形式で確認してみると結果は文字列ではなくJSONで返ってきていることがわかります。

![log_5.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/dc69364c-b1ea-d03a-c84e-57bda095641a.png)


### 指定したキーの値を取るNRQL（ネストされている場合#2）
キーvalueBの値はJSONでしたが、さらにその先のキーを指定してみます。valueBのJSONのnestedValue1です。その場合は、'***valueB.nestedValue1***'のようにドット (.) でキー名を連結させます。

```sql: 指定したキーの値を取るNRQL（ネストされている場合#2）
WITH '{"valueA": "test", "valueB": {"nestedValue1": [1, 2, 3], "nestedValue2": 100}, "valueC": [{ "id": 1, "label": "A", "other": 7 }, { "id": 2, "label": "B", "other": 9 }, { "id": 3, "label": "C", "other": 13 }]}'
  as json 
SELECT jparse(json, 'valueB.nestedValue1') as 'Value' 
```
nestedValue1の値 [1,2,3]が取得できました。

![log_6.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/f9f58f64-4600-9caf-7902-06d669ab8bf9.png)


### 指定したキーの値を取るNRQL（配列の場合#1） 
どの程度頻繁に使うか、というのはありますが、値が配列の場合はその要素や一部分を抽出できます。配列から要素を抽出する際は、一般的なプログラミング言語によくみられるように ***[0]*** や ***[1:2]*** などで要素の位置や範囲を指定します。

```sql: 指定したキーの値を取るNRQL（配列の場合#1）
WITH '{"valueA": "test", "valueB": {"nestedValue1": [1, 2, 3], "nestedValue2": 100}, "valueC": [{ "id": 1, "label": "A", "other": 7 }, { "id": 2, "label": "B", "other": 9 }, { "id": 3, "label": "C", "other": 13 }]}'
  as json 
SELECT jparse(json, 'valueB.nestedValue1[0]') as 'Value' 
```

先ほどは配列全体[1,2,3]が返ってきましたが、今回は最初の要素[0]を指定しているので1だけが返ってきています。

![log_7.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/956bec3a-9a8f-4ba1-aa86-a5c75a799748.png)


```sql: 指定したKeyの値を取るNRQL（配列の場合#1）
WITH '{"valueA": "test", "valueB": {"nestedValue1": [1, 2, 3], "nestedValue2": 100}, "valueC": [{ "id": 1, "label": "A", "other": 7 }, { "id": 2, "label": "B", "other": 9 }, { "id": 3, "label": "C", "other": 13 }]}'
  as json 
SELECT jparse(json, 'valueB.nestedValue1[0:2]') as 'Value' 
```
[0:2]とした場合は、0番目以上から2番目未満（つまり1番目）の要素を抽出します。[1, 2]が返ってきました。

![log_8.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/7e146ae6-9c84-8f56-ebed-80b92037d8b0.png)


### 指定したキーの値を取るNRQL（配列の場合#2）
配列の各要素がJSONだったらどうでしょうか？それぞれのJSONの中から特定のキーだけを集めてきたいことはあるでしょう。


今回のデータだとvalueCには{ "id": 1, "label": "A", "other": 7 }という形のJSONが配列で入っていますが、各要素からlabelだけを抜き取ってみます。その場合は、'***valueC[\*].label***'のような形になります。valueCの配列の全要素を対象とし、そのうちlabel属性だけを抽出する感じです。


```sql: 指定したキーの値を取る（配列の場合#2）
WITH '{"valueA": "test", "valueB": {"nestedValue1": [1, 2, 3], "nestedValue2": 100}, "valueC": [{ "id": 1, "label": "A", "other": 7 }, { "id": 2, "label": "B", "other": 9 }, { "id": 3, "label": "C", "other": 13 }]}'
  as json 
SELECT jparse(json, 'valueC[*].label') as 'Value' 
```

配列の各要素からlabelの値だけを抽出することで、[‘A’, ‘B’, ‘C’]という値が返ってきました。

![log_9.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/cb8d071b-e5ed-4ecb-0ec0-97e42a7f1333.png)

色々JSONからのデータの抽出方法をみてきました。この辺りを押さえておけばほぼほぼ間違いないでしょう🙌🙌


# 応用パターン
これまではJSONから抽出した値をSELECT句で返す例を中心にみてきましたが、抽出した値はSELECT句だけでなくWHERE句の絞り込みに利用したり、FACET句でグルーピングで利用したりできます。これを応用することで、単に一行のログを評価するだけでなく複数のログ横断して可視化ができるのでより効率的に面での分析が可能になります。

例えば、冒頭のログにはJSONの中のcontextというキーに、URL (name)の情報やレイテンシ (duration_ms)の情報が入っています。これを抽出した後、URL（name）事にレイテンシーの平均（average(duration))を出したりできます。

```sql: 応用パターン
WITH capture(message, r'\(\d\) [\d/]+ [\d:\.]+ (?P<json>.*)') as json,
numeric(jparse(json, 'context.duration_ms')) as duration,
jparse(json, 'context.name') as name
SELECT average(duration) FROM Log 
WHERE json is not null
FACET name
```

以下の例のようにURL毎にレイテンシーの平均が出せました。

![log_10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/535230/ffe5eada-a61d-6680-c321-fe364df4af38.png)


:::note warn
上記の例はログメッセージに含まれるJSONを解析することで複雑な分析にも利用できる例を示したものですが、例として出したものはAPMがデータとして取るので、いちいちログから抽出して分析する必要はありません。

この例はログファーストの分析をお勧めするものではなく、あくまでテレメトリーデータとしてログしか取得する方法がない場合の例であることをご認識ください。例えばCDNのログを統合した場合などが該当するでしょう。
:::


# まとめ
今回はログのデータに含まれるJSON文字列を抽出し、解析する方法をご紹介しました。すでにログが出力されているが有効な解析手段がない場合にご利用をご検討ください。

今回ご紹介した関数も含めNRQLの使い方の詳細については公式ドキュメントを参照してください。

https://docs.newrelic.com/jp/docs/nrql/nrql-syntax-clauses-functions/#func-jparse


# その他
New Relicでは、**新しい機能やその活用方法**について、QiitaやXで発信しています！
**無料でアカウント作成**も可能なのでぜひお試しください！

:::note info
New Relic株式会社の[X(旧Twitter)](https://x.com/NewRelicJapan) や [Qiita OrganizationOrganization](https://qiita.com/organizations/newrelic)では、
新機能を含む活用方法を公開していますので、ぜひフォローをお願いします。
:::

:::note info
無料のアカウントで試してみよう！
[New Relic フリープランで始めるオブザーバビリティ！](https://qiita.com/ktst79/items/5ee74b34e6adb8a7a6fa)
:::

### NRQLマスターになろうシリーズはこちら
https://qiita.com/ktst79/items/88a80229d226b5c0abcf

https://qiita.com/ktst79/items/c1ddf33e18e9cfeba893

https://qiita.com/ktst79/items/5d84d6a2ceca90efa108

https://qiita.com/ktst79/items/56e49f71487928c5bca1