SQLAlchemy ORM を使って、Python でSplunk データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Splunk は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Splunk にデータ連携するPython アプリケーションを構築し、Splunk データを可視化できます。 本記事では、SQLAlchemy でSplunk に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Splunk をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにSplunk データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSplunk の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でSplunk データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Splunk データに連携するEngne を作成します。

engine = create_engine("splunk///?user=MyUserName&password=MyPassword&URL=MyURL&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

リクエストを認証するには、 User、Password、およびURL プロパティを有効なSplunk クレデンシャルに設定します。デフォルトでは、CData 製品はポート8089 でリクエストを行います。

デフォルトでは、CData 製品はサーバーとのTLS/SSL ネゴシエーションを試みます。TLS/SSL 設定について詳しくは、ヘルプドキュメントの「高度な設定」を参照してください。

Splunk データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、DataModels テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class DataModels(base):
	__tablename__ = "DataModels"
	Name = Column(String,primary_key=True)
	Owner = Column(String)
	...

Splunk データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("splunk///?user=MyUserName&password=MyPassword&URL=MyURL&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(DataModels).filter_by(Id="SampleDataset"):
	print("Name: ", instance.Name)
	print("Owner: ", instance.Owner)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

DataModels_table = DataModels.metadata.tables["DataModels"]
for instance in session.execute(DataModels_table.select().where(DataModels_table.c.Id == "SampleDataset")):
	print("Name: ", instance.Name)
	print("Owner: ", instance.Owner)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Splunk データの挿入（INSERT）

Splunk データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Splunk にすべての追加インスタンスを送ります。

new_rec = DataModels(Name="placeholder", Id="SampleDataset")
session.add(new_rec)
session.commit()

Splunk データを更新（UPDATE）

Splunk データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Splunk にレコードを追加します。

updated_rec = session.query(DataModels).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Id = "SampleDataset"
session.commit()

Splunk データを削除（DELETE）

Splunk データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(DataModels).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Splunk からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。