SQL

設定

例

このインテグレーションを有効にするには、Collector構成に以下を追加します：

receivers:
  smartagent/sql:
    type: sql
    ...  # Additional config

次に、設定ファイルの service.pipelines.metrics.receivers セクションにモニターを追加します：

service:
  pipelines:
    metrics:
      receivers: [smartagent/sql]

コンフィギュレーション設定

以下の表は、このモニターの設定オプションを示しています：

ネストされた queries コンフィギュレーション・オブジェクトには以下のフィールドがあります：

ネストされた metrics コンフィギュレーション・オブジェクトには以下のフィールドがあります：

サポート対象のドライバ

使用するデータベースドライバの名前を含む dbDriver オプションを指定する必要があります。これらの名前は、エージェントで使用される Golang SQL ドライバの名前と同じです。モニターは、指定したドライバに従って、connectionString をフォーマットします。

これは現在サポートされているドライバのリストです：

• hana

• sqlserver

• mysql

• postgres

• pq

• snowflake

パラメータ化された接続文字列

インテグレーションは、connectionString の値を、変数 host と port と params オプションのすべてのパラメータからなるコンテキストを持つ Golang テンプレートとして扱います。テンプレートに変数を追加するには、Golang {{.varname}} テンプレートの構文を使用します。

次の例を参照してください：

smartagent/sql:
  type: sql
  host: localhost
  port: 1433
  dbDriver: sqlserver
  connectionString: 'Server=127.0.0.1;Database=WideWorldImporters;User Id=sa;Password=123456;'
  queries:
    - query: 'SELECT COUNT(*) as count FROM Sales.Orders'
      metrics:
        - metricName: "orders"
          valueColumn: "count"

Snowflakeのパフォーマンスと使用状況のメトリクスを収集する

Snowflakeのパフォーマンスと使用状況のメトリクスを収集するようにエージェントを構成するには、以下の手順を実行します：

1. pkg/sql/snowflake-metrics.yaml ファイルを sql モニターリポジトリから agent.yaml ファイルと同じ場所にコピーします。たとえば、/etc/splunk のようになります。GitHub リポジトリで snowflake-metrics.yaml の最新バージョンを検索します。

2. SQLモニターを以下のように設定します：

   JSONCopy

   receivers: smartagent/sql: type: sql intervalSeconds: 3600 dbDriver: snowflake params: account: "account.region" database: "SNOWFLAKE" schema: "ACCOUNT_USAGE" role: "ACCOUNTADMIN" user: "user" password: "password" connectionString: "{{.user}}:{{.password}}@{{.account}}/{{.database}}/{{.schema}}?role={{.role}}" queries: {"#from": "/etc/signalfx/snowflake-metrics.yaml"}

   receivers:
     smartagent/sql:
       type: sql
       intervalSeconds: 3600
       dbDriver: snowflake
       params:
         account: "account.region"
         database: "SNOWFLAKE"
         schema: "ACCOUNT_USAGE"
         role: "ACCOUNTADMIN"
         user: "user"
         password: "password"
       connectionString: "{{.user}}:{{.password}}@{{.account}}/{{.database}}/{{.schema}}?role={{.role}}"
       queries:
         {"#from": "/etc/signalfx/snowflake-metrics.yaml"}

snowflake-metrics.yaml の内容を agent.yaml の下の queries にコピーすることもできます。snowflake-metrics.yaml を編集し、モニターするメトリクスのみを含めます。

モニターの使用

次の customers データベーステーブルを考えてみます：

以下のモニター設定を使用して、国別のアクティブ・ユーザー数と顧客数のメトリクスを生成します：

receivers:
  smartagent/sql:
    type: sql
    host: localhost
    port: 5432
    dbDriver: postgres
    params:
      user: "${env:SQL_USERNAME}"
      password: "${env:SQL_PASSWORD}"
    # The `host` and `port` values shown in this example (also provided through autodiscovery) are interpolated
    # to the connection string as appropriate for the database driver.
    # Also, the values from the `params` configuration option above can be
    # interpolated.
    connectionString: 'host={{.host}} port={{.port}} dbname=main user={{.user}} password={{.password}} sslmode=disable'
    queries:
      - query: 'SELECT COUNT(*) as count, country, status FROM customers GROUP BY country, status;'
        metrics:
          - metricName: "customers"
            valueColumn: "count"
            dimensionColumns: ["country", "status"]

この構成を使用すると、一連の MTS が取得されます。これらはすべてメトリクス名 customers です。各 MTS には、county および status ディメンションがあります。ディメンション値は country と status のその組み合わせに属する顧客の数です。また、複数の metrics アイテムを指定して、1 つのクエリから複数のメトリクスを生成することもできます。

メトリクス式の使用

列をメトリクス値とディメンションにマッピングするよりも複雑なロジックを実行する必要がある場合は、個々のメトリクス設定で使用可能な datapointExpressions オプションを使用します。expr 式言語を使用して、個々の行からデータポイントを導出するより高度なロジックを作成します。これらの式の評価は、式のコンテキストで使用可能な GAUGE または CUMULATIVE ヘルパー関数によって作成されたデータポイントになる必要があります。特定の行に対してデータポイントを生成する必要がない場合は、式の評価を nil にすることもできます。

GAUGE 、CUMULATIVE の両関数には以下のシグネチャーがあります：

( metricName、dimensions、value )

• metricName:文字列でなければなりません

• dimensions:文字列のキーと値のマップでなければならず、また

• value:数値でなければなりません。

行の各列は、同じ名前の式のコンテキスト内の変数にマッピングされます。たとえば、SQL クエリ結果の列に name という列がある場合、式で name という変数を使用できます。式では、文字列値を一重引用符（''）で囲みます。

メトリクス

このインテグレーションはメトリクスを生成しません。

トラブルシューティング