Docs » Splunk Observability Cloud でサポートされているインテグレーション » Collectorコンポーネント: レシーバー » Windowsパフォーマンス・カウンターレシーバー

Windowsパフォーマンス・カウンターレシーバー 🔗

The Windows Performance Counters receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect configured system, application, or custom performance counter data from the Windows Registry. The supported pipeline type is metrics. See パイプラインでデータを処理する for more information.

注釈

Windowsパフォーマンス・カウンター・レシーバーはWindowsホストでのみ動作します。

The Windows Performance Counters receiver replaces the Smart Agent monitor Windows Performance Counters (deprecated). It’s based on the Telegraf Windows Performance Counters Input Plugin and uses the PDH interface .

はじめに 🔗

以下の手順に従って、コンポーネントの設定とアクティベーションを行ってください：

  1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your Windows host platform as described in インストーラ・スクリプトを使用して Collector for Windows をインストールします。.

  2. 次のセクションで説明するように、Windowsパフォーマンス・カウンター・レシーバーを設定します。

  3. Collector を再起動します。

サンプル構成 🔗

Windows Performance Counters レシーバーをアクティブにするには、Collector 構成ファイルの receivers セクションに windowsperfcounters エントリーを追加します。例：

receivers:
  windowsperfcounters:
    metrics:
      bytes.committed:
        description: the number of bytes committed to memory
        unit: By
        gauge:
    collection_interval: 30s
    perfcounters:
    - object: Memory
      counters:
        - name: Committed Bytes
          metric: bytes.committed

設定を完了するには、設定ファイルの service セクションの metrics パイプラインに、レシーバーを含めます：

service:
  pipelines:
    metrics:
      receivers:
        - windowsperfcounters

Windows パフォーマンス・カウンターからメトリクスを収集するには、例のように metrics フィールドを使用してメトリクスを定義する必要があります。その後、counters.metric フィールドから定義したメトリクスを参照できます。

利用可能なパフォーマンス・カウンターを見る 🔗

利用可能なパフォーマンス・カウンターのリストを見るには、Windows PowerShellまたはWindowsパフォーマンスモニターを使用します。

PowerShellで以下のコマンドを実行し、すべてのパフォーマンス・カウンターセットをリストします：

Get-Counter -ListSet *

各パフォーマンス・カウンターセットのインスタンスを一覧表示するには、以下のコマンドを実行し、<perf_object_name> を検索したいインスタンス名に置き換えます：

Get-Counter -List "<perf_object_name>"

次のことに注意してください：

  • If a specific performance counter can’t be accessed at startup, the receiver emits a warning and continues execution.

  • Some performance counters might not exist on some systems due to different OS configuration.

高度な設定 🔗

収集間隔とカウンターを設定する 🔗

収集間隔とスクレイピングするパフォーマンス・カウンターを設定できます。例：

windowsperfcounters:
  collection_interval: <duration>
  initial_delay: <duration>
  metrics:
    <metric name 1>:
      description: <description>
      unit: <unit type>
      gauge: null
    <metric name 2>:
      description: <description>
      unit: <unit type>
      sum: null
      aggregation: <cumulative or delta>
      monotonic: <true or false>
  perfcounters:
  - object: <object name>
    instances:
      - <instance name>
    counters:
      - name: <counter name>
        metric: <metric name>
        attributes:
        <key>: <value>

異なる収集間隔でスクレイプする 🔗

以下の例は、ターゲットによって異なる収集間隔を使用してパフォーマンス・カウンターをスクレイピングする方法を示しています：

receivers:
  windowsperfcounters/memory:
    metrics:
      bytes.committed:
        description: Number of bytes committed to memory
        unit: By
        gauge:
    collection_interval: 30s
    perfcounters:
      - object: Memory
        counters:
          - name: Committed Bytes
            metric: bytes.committed

  windowsperfcounters/processor:
    collection_interval: 1m
    metrics:
      processor.time:
        description: CPU active and idle time
        unit: "%"
        gauge:
    perfcounters:
      - object: "Processor"
        instances: "*"
        counters:
          - name: "% Processor Time"
            metric: processor.time
            attributes:
              state: active
      - object: "Processor"
        instances: [1, 2]
        counters:
          - name: "% Idle Time"
            metric: processor.time
            attributes:
              state: idle

  # ...

service:
  pipelines:
    metrics:
      receivers: [windowsperfcounters/memory, windowsperfcounters/processor]

Configure instances 🔗

インスタンスは、パフォーマンス・データを生成するあらゆるエンティティです。インスタンスは1つ以上のカウンター値を持つことができます。

レシーバーは instances フィールドを通じて以下の値をサポートします：

値

解釈

Not specified

This is the only valid value if the counter has no instances

"*"

All instances, excluding _Total

"_Total"

The 「total」 instance, that aggregates the values of all other instances. For more information, see Total instance behavior and the aggregation counter

"instance1"

シングルインスタンス

["instance1", "instance2", ...]

インスタンスのセット

["_Total", "instance1", "instance2", ...]

総インスタンスを含むインスタンスのセット

Total instance behavior and the aggregation counter 🔗

To avoid dropping the _Total instance, configure the receiver to collect it individually on its own metric, as in the following example:

windowsperfcounters:
  metrics:
    processor.time.total:
      description: Total CPU active and idle time
      unit: "%"
      gauge:
  collection_interval: 30s
  perfcounters:
    - object: "Processor"
      instances:
        - "_Total"
      counters:
        - name: "% Processor Time"
          metric: processor.time.total

警告

When using an instance value of "*", if the counter uses a value other than _Total, make sure to avoid double counting when aggregating metrics after the receiver scrapes them.

Recreate the query on every scrape 🔗

On some versions of Windows, Counters are sometimes corrupted and continuously return invalid data after the first scrape. If this happens, set the counter setting recreate_query to true (defaults to false) to tell the receiver to recreate the PDH query on every scrape. This might affect performance but should be inconsequential unless collection_interval is very high.

If re-creating the query fails, the previous query will be re-used and an error will be logged.

Define metric format 🔗

Configured metrics consist of a metric description, including unit and type, used by one or more performance counters scraped by the receiver.

特定の形式でメトリクスを報告するには、メトリクスを定義し、該当する属性とともに、対応するカウンターでそれを参照します。デフォルトでは、メトリクス名はカウンターの名前に対応します。

メトリクスは、sum または gauge のタイプが可能です。Sum メトリクスは、aggregation と monotonic フィールドをサポートします。

フィールド

説明

値

デフォルト

name

メトリクスのキーまたは名前。空でない文字列。

文字列

カウンターの名前

description

メトリクスまたは測定の説明

文字列

unit

測定単位

文字列

1

sum

合計メトリクスの表現

合計設定

gauge

ゲージメトリクスの表現

ゲージ設定

Sum metrics 🔗

以下の設定は、合計メトリクスに適用されます：

フィールド

説明

値

aggregation

メトリクスの集計の一時性のタイプ

cumulative または delta

monotonic

メトリクス値が減少するかどうか

false

Gauge metrics 🔗

The gauge configuration doesn’t accept settings. It is specified as an object for forwards compatibility.

The following example emits the Memory/Committed Bytes counter as the bytes.committed metric:

receivers:
  windowsperfcounters:
    metrics:
      bytes.committed:
        description: the number of bytes committed to memory
        unit: By
        gauge:
    collection_interval: 30s
    perfcounters:
    - object: Memory
      counters:
        - name: Committed Bytes
          metric: bytes.committed

service:
  pipelines:
    metrics:
      receivers: [windowsperfcounters]

既知の制限 🔗

  • The network interface is not available inside the container and as a result metrics for the object Network Interface aren’t generated in that scenario. If there is a sub-process it captures Network Interface metrics.

  • The counter category Process is unreliable with multiple instances of the same process.

    • For Windows 11 and higher, use Process V2 instead as it includes the process ID in the instance name.

    • For versions prior to Windows 11, you can configure the Process counter category to include the PID in the instance name. Learn more at Microsoft’s doc Handling Duplicate Instance Names .

設定 🔗

以下の表は、Windows パフォーマンス・カウンター・レシーバーの構成オプションを示します：

トラブルシューティング 🔗

Splunk Observability Cloudをご利用のお客様で、Splunk Observability Cloudでデータを確認できない場合は、以下の方法でサポートを受けることができます。

Splunk Observability Cloudをご利用のお客様

見込み客および無料トライアルユーザー様

  • Splunk Answers のコミュニティサポートで質問し、回答を得る

  • Splunk #observability ユーザーグループの Slack チャンネルに参加して、世界中の顧客、パートナー、Splunk 社員とのコミュニケーションを図る。参加するには、Get Started with Splunk Community マニュアルの チャットグループ を参照してください。

This page was last updated on 2024年10月10日.