axiomhq/building-dashboards

building-dashboards は何をしますか？

AxiomダッシュボードをAPI経由で設計・構築します。チャートタイプ、APLおよびメトリクス/MPLクエリパターン、SmartFilters、レイアウト、設定オプションをカバーします。ダッシュボード作成、Splunkからの移行、チャートオプション設定時に使用します。

概要

このスキルは、AxiomのREST APIを使用してダッシュボードを作成および管理する方法を示します。ダッシュボードは、データを視覚化し、インサイトを提供するための強力なツールです。

サポートされるプラットフォーム

• Axiom Cloud
• Axiom Self-Hosted

使用例

ダッシュボードの作成

curl -X POST "https://api.axiom.co/v1/dashboards" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Dashboard",
    "description": "A sample dashboard"
  }'

チャートの追加

ダッシュボードにチャートを追加するには、datasets、queries、およびvisualizationsを指定します。

{
  "chartType": "timeseries",
  "query": {
    "apl": "['my-dataset'] | where ['status'] == 'error' | timeChart('count', '1m')"
  },
  "title": "Error Rate Over Time"
}

チャートタイプ

チャートタイプ	説明
timeseries	時系列データの線グラフ
bar	カテゴリデータの棒グラフ
table	表形式のデータ表示
stat	単一の統計値を表示

クエリパターン

APL (Axiom Processing Language)

APLは、Axiomデータをクエリするための強力な言語です。例：

['my-dataset']
| where ['response_time'] > 500
| summarize count() by ['endpoint']
| sort count_ desc

MPL (Metrics Processing Language)

メトリクスデータのクエリにはMPLを使用します：

rate(metric: 'requests_total')[5m]
| filter status = '5xx'
| group_by endpoint

SmartFilters

SmartFiltersを使用すると、ダッシュボードに動的なフィルターを追加できます。これにより、ユーザーはインタラクティブにデータを絞り込むことができます。

{
  "smartFilter": {
    "field": "service",
    "type": "string"
  }
}

レイアウト設定

ダッシュボードのレイアウトは、positions パラメータでグリッドベースに設定します：

{
  "widgets": [
    {
      "position": {
        "x": 0,
        "y": 0,
        "width": 6,
        "height": 4
      },
      "chart": { ... }
    }
  ]
}

設定オプション

• 時間範囲: ダッシュボードのデフォルトの時間範囲を設定
• テーマ: ダーク/ライトテーマの指定
• 自動更新: ダッシュボードの自動更新間隔

Splunkからの移行

SplunkからAxiomへのダッシュボード移行を容易にするためのガイドライン：

1. SplunkダッシュボードのXML/JSON定義をエクスポート
2. クエリをSplunk SPLからAxiom APLに変換
3. チャートタイプをマッピング（Splunkのchartコマンドなど）
4. APIを使用してAxiomにダッシュボードを作成

参考リンク

• Axiom API ドキュメント
• APL リファレンス
• ダッシュボードの例