ネットワーク監視の高度な構成

ネットワークの監視を構成するときに使用できるすべてのオプションを確認したい場合は、次のセクションを参照してください。

`snmp-base.yaml` サンプルファイル

以下は、SNMP およびフローデータデバイスをポーリングするためにktranslate Docker イメージによって使用されるsnmp-base.yamlファイルで使用できるさまざまな構成オプションの例です。GitHub の KTranslate リポジトリで、多くのコメントが付けられたサンプルを参照することもできます。

# Configuration of every device monitored by this container
devices:
  # Sample of SNMP v2c device
  ups_snmpv2c__10.10.0.201:
    device_name: ups_snmpv2c
    device_ip: 10.10.0.201
    snmp_comm: $YOUR_COMMUNITY_STRING
    oid: .1.3.6.1.4.1.318.1.3.27
    description: "APC Web/SNMP Management Card (MB:v4.1.0 PF:v6.2.1 PN:apc_hw05_aos_621.bin AF1:v6.2.1 AN1:apc_hw05_sumx_621.bin MN:AP9537SUM HR:05 SN: ABC123DEF456 MD:05/21/2016) (Embedded PowerNet SNMP Agent SW v2.2 compatible)"
    last_checked: 2021-11-09T18:14:59.907821489Z
    mib_profile: apc_ups.yml
    provider: kentik-ups
    poll_time_sec: 300
    retries: 1
    timeout_ms: 5000
    user_tags:
      owning_team: dc_ops
    discovered_mibs:
    - PowerNet-MIB_UPS
    - TCP-MIB
    - UDP-MIB
    purge_after_num: 1
  # Sample of SNMP v3 device
  router_snmpv3__10.10.0.202:
    device_name: router_snmpv3
    device_ip: 10.10.0.202
    snmp_v3:
      user_name: $YOUR_USER_NAME
      authentication_protocol: $YOUR_AUTH_PROTOCOL
      authentication_passphrase: $YOUR_AUTH_PASSPHRASE
      privacy_protocol: $YOUR_PRIVACY_PROTOCOL
      privacy_passphrase: $YOUR_PRIVACY_PASSPHRASE
    oid: .1.3.6.1.4.1.9.1.544
    description: "Cisco IOS Software, 3800 Software (C3845-ADVENTERPRISEK9-M), Version
      15.1(3)T4, RELEASE SOFTWARE (fc1)\r\nTechnical Support: http://www.cisco.com/techsupport\r\nCopyright
      (c) 1986-2012 by Cisco Systems, Inc.\r\nCompiled Thu 24-May-12 04:27 by prod_rel_team"
    last_checked: 2021-11-09T18:14:59.907821489Z
    mib_profile: cisco-asr.yml
    provider: kentik-router
    user_tags:
      owning_team: core-networking
    discovered_mibs:
    - BGP4-MIB
    - CISCO-MEMORY-POOL-MIB
    - CISCO-PROCESS-MIB
    - IF-MIB
    - OSPF-MIB
    engine_id: "80:00:01:01:0a:14:1e:28"
    match_attributes:
      if_interface_name: "^Ten.*|^Gig.*"
      "!if_Alias": "[Uu]plink"
  # Sample of SNMP v1 device
  netbotz_snmpv1__10.10.0.203:
    device_name: netbotz_snmpv1
    device_ip: 10.10.0.201
    snmp_comm: $YOUR_COMMUNITY_STRING
    use_snmp_v1: true
    oid: .1.3.6.1.4.1.5528.100.20.10.2013
    description: "Linux netbotz930A7A 2.6.12 #307 Wed Dec 29 15:25:32 EST 2010 ppc"
    last_checked: 2021-11-09T18:14:59.907821489Z
    mib_profile: apc-netbotz.yml
    provider: kentik-netbotz
    user_tags:
      owning_team: sys_ops
    discovered_mibs:
    - IF-MIB
    - IP-MIB
    - TCP-MIB
    - UDP-MIB
    no_use_bulkwalkall: true
  # Sample of "flow only" device
  flow_only__10.10.0.210:
    device_name: flow_only
    device_ip: 10.10.0.210
    user_tags:
      owning_team: net_eng
    flow_only: true
  # Sample of "ping only" device
  ping_only__10.10.0.220:
    device_name: ping_only
    device_ip: 10.10.0.220
    provider: kentik-ping
    user_tags:
      owning_team: load_balancing
    ping_only: true
    ping_interval_sec: 5
  # Sample of Arista eAPI device
  arista_eapi_10.10.0.230:
    device_name: arista_eapi
    device_ip: 10.10.0.230
    snmp_comm: public
    oid: .1.3.6.1.4.1.30065.1.3011.7020.3735.24.2878.2
    description: "Arista Networks EOS version 4.22.9M running on an Arista
      Networks DCS-7020SR-24C2"
    last_checked: 2021-11-09T18:14:59.907821489Z
    mib_profile: arista-switch.yml
    provider: kentik-switch
    discovered_mibs:
    - ARISTA-BGP4V2-MIB
    - ARISTA-QUEUE-MIB
    - BGP4-MIB
    - HOST-RESOURCES-MIB
    - IF-MIB
    ext:
      ext_only: false
      eapi_config:
        username: $YOUR_ARISTA_API_USERNAME
        password: $YOUR_ARISTA_API_PASSWORD
        transport: https
        port: 443
  # Sample of Meraki Dashboard API device
  meraki_dashboard_api:
    device_name: meraki_controller
    device_ip: snmp.meraki.com
    provider: meraki-cloud-controller
    ext:
      ext_only: true
      meraki_config:
        api_key: $YOUR_MERAKI_API_KEY
        monitor_devices: true
        monitor_org_changes: true
        monitor_uplinks: true
        monitor_vpn_status: true
        organizations:
          - "Top Org.*"
        networks:
          - "Production"
          - "Guest"
        product_types:
          - wireless
        preferences:
          device_status_only: true
          show_vpn_peers: true
          hide_uplink_usage: false
# Configuration for receipt of SNMP Traps
trap:
  listen: 0.0.0.0:1620
  community: public
  version: ""
  transport: ""
  v3_config: null
  trap_only: false
# Configuration for the SNMP discovery job
discovery:
  cidrs:
  - 10.0.0.0/24
  - 10.0.0.202/32
  ignore_list:
  - 10.0.0.98
  - 10.0.0.99
  debug: false
  ports:
  - 161
  - 1161
  default_communities:
  - $YOUR_COMMUNITY_STRING_1
  - $YOUR_COMMUNITY_STRING_2
  - $YOUR_COMMUNITY_STRING_3
  use_snmp_v1: false
  default_v3: null
  add_mibs: true
  threads: 4
  add_devices: true
  replace_devices: true
  no_dedup_engine_id: false
  check_all_ips: true
global:
  poll_time_sec: 60
  drop_if_outside_poll: false
  mib_profile_dir: /etc/ktranslate/profiles
  mibs_db: /etc/ktranslate/mibs.db
  mibs_enabled:
  - ARISTA-BGP4V2-MIB
  - ARISTA-QUEUE-MIB
  - BGP4-MIB
  - CISCO-MEMORY-POOL-MIB
  - CISCO-PROCESS-MIB
  - HOST-RESOURCES-MIB
  - IF-MIB
  - OSPF-MIB
  - PowerNet-MIB_UPS
  timeout_ms: 3000
  retries: 0
  global_v3: null
  response_time: false
  user_tags:
    environment: production
  match_attributes:
    if_Description: ".*WAN.*"
  purge_devices_after_num: 0

キー名	必須	説明
device_name	✓✓	デバイスの名前。これは、NewRelic内のデバイスの一意の識別子です。
device_ip	✓✓	デバイスのターゲットIP。
snmp_comm	✓（SNMPv1 / 2cに必要）	`SNMPv1/2c` 使用するコミュニティ文字列。
use_snmp_v1	✓（SNMPv1に必要）	SNMPv1を使用するかどうかを示します。デフォルトでは、 `false`に設定されています。
snmp_v3	✓（SNMPv3に必要）	SNMPv3構成
debug		SNMPポーリング中にデバッグレベルのログを有効にするかどうかを示します。デフォルトでは、 `false`に設定されています。
port		SNMPクエリを送信するポート。デフォルトでは、ポート`161`に設定されています。
oid	✓（SNMPポーリングに必要）	デバイスで検出された`systemObjectID \| sysObjectID \| sysOID` 。これは、デバイスを既知のSNMPプロファイルに一致させ、 `provider`属性を設定するために使用されます。一致するものが見つからない場合、これにより`provider`がkentik-defaultデバイスとして設定されます。
description		デバイスの検出された`sysDescr` 。このフィールドは情報です。
last_checked		このデバイスが`ktranslate` dockerイメージによって最後に検出されたときのタイムスタンプ。このフィールドは情報です。
mib_profile	✓（SNMPポーリングに必要）	`sysOID`に基づいて検出実行中にこのデバイスに関連付けられたSNMPプロファイルファイル。これがバング（！）トークンで始まる場合、 `sysOID`からの自動マッチングをオーバーライドし、手動オーバーライドを使用します。例： `"!cisco-asa.yml"` （引用符が必要です）。
provider	✓（New Relicに必要）	NewRelicのエンティティ合成中に使用される値。これは、一致した`mib_profile`に基づいて自動的に作成され、エンティティを作成するには、 entity-definitionsリポジトリ内のルールの1つと一致する必要があります。デバイスを手動で追加する場合は、この値が有効であることを確認するように注意する必要があります。
poll_time_sec		SNMPポーリング頻度を秒単位で示します。この設定は、 `global.poll_time_sec`属性を上書きするために使用されます。
retries		SNMPOIDのポーリングを再試行する試行回数を示します。この設定は、 `global.retries`属性を上書きするために使用されます。
timeout_ms		SNMPポーリングタイムアウトをミリ秒単位で示します。この設定は、 `global.timeout_ms`属性を上書きするために使用されます。
user_tags		`key:value` 属性をペアにして、デバイスにより多くのコンテキストを提供します。このレベルのタグは、 `global.user_tags`属性で適用されるすべてのタグに追加されます。
discovered_mibs		このデバイスが応答できる、一致した`mib_profile`からプルされたMIBのリスト。このフィールドは情報です。
engine_id		このデバイスのSNMPエージェントに対して検出された一意のエンジンID。通常、SNMPv3の検出中に検出されます。このフィールドは情報です。
match_attributes		`attribute:regex` ペアを使用して、メトリックを許可リストに追加します。このレベルのペアは、 `global.match_attributes`属性で適用されるすべてのペアに追加されます。RE2構文を使用し、デフォルトの`OR`演算子があります。キーの前に`!`を付けて、 `AND`演算子を強制します。
monitor_admin_shut		`Administratively Shutdown`ステータスのインターフェースを監視するかどうかを示します。デフォルトでは、 `false`に設定されています。
no_use_bulkwalkall		`true`の場合、SNMP `GETBULK`要求アクションを無効にします。デフォルトでは、 `false`に設定されています。
response_time		このデバイスで応答時間ポーリングが有効になっているかどうかを示します。デフォルトでは、 `false`に設定されています。
ping_only		`true`の場合、すべての SNMP ポーリングを無効にし、このデバイスの応答時間ポーリングを有効にします。この設定は、 `global.response_time` 属性をオーバーライドします。デフォルトでは、 `false`に設定されています。各 ping_only デバイスに行 `provider: kentik_ping` が含まれていることを確認してください。
ping_interval_sec		この設定は、 `ping_only` \|の間に使用される1パケット/秒のデフォルトレートを上書きするために使用されます。 `response_time`ポーリング。
flow_only		`true`の場合、すべてのSNMPポーリングを無効にします。デフォルトでは、 `false`に設定されています。
purge_after_num		X 個のスケジュールされた検出ジョブが失敗した後、構成ファイルからデバイスを削除します。この設定はグローバルな`purge_devices_after_num`設定をオーバーライドします。デバイスを永久に保持するにはこれを`-1`に設定し、パージしきい値を設定するには`1`以上の整数を設定します。(デフォルト: `0` )
ext	✓（APIポーリングに必要）	APIポーリング構成
ext.ext_only		この `device_name` 構成のすべての SNMP ポーリングを無効にします。デフォルト: `false` 。

キー名	必須	説明
listen	✓✓	SNMPトラップを受信するためのリスニングIPポート。デフォルトでは`0.0.0.0:1620`に設定されており、 `docker run ...`コマンドでリダイレクトを使用して、ホスト上のより一般的な UDP 162 をコンテナー内の UDP 1620 にリダイレクトします。リダイレクトはこのフラグで行われます `-p 162:1620/udp`
community		SNMP トラップを受信するための SNMPv1/v2c コミュニティストリング。デフォルトでは、受信トラップがこのコミュニティに一致しない場合でも、受信トラップを処理します。
version		使用するSNMPバージョン。オプションは、 `v1` 、 `v2c` 、および`v3`です。デフォルトでは、 `v2c`に設定されています。
transport		使用するSNMPトランスポートプロトコル。オプションは`TCP`と`UDP`です。デフォルトでは、 `UDP`
v3_config		使用するSNMPv3構成。`version: v3`の場合にのみ使用されます。
トラップのみ		これを`true`に設定すると、コンテナーは SNMP または ICMP ポーリングを試行しなくなります。これは、着信トラップのみをリッスンするコンテナーが必要な場合に使用されます。

キー名	必須	説明
cidrs	✓✓	CIDR 表記のターゲット IP 範囲の配列。タイムアウトを避けるために、これらの範囲のサイズに注意してください。
ignore_list		すべての検出ジョブで明示的に無視するIPアドレスの配列。
debug		検出中にデバッグレベルのログを有効にするかどうかを示します。デフォルトでは、 `false`
ports	✓✓	SNMPポーリング中にスキャンするターゲットポートの配列。
default_communities	✓（SNMPv1 / 2cに必要）	SNMPポーリング中にスキャンするSNMPv1/v2cコミュニティストリングの配列。この配列は順番に評価され、検出は最初に通過するコミュニティを受け入れます。
use_snmp_v1	✓（SNMPv1に必要）	検出中にSNMPv1を使用するかどうかを示します。デフォルトでは、 `false`
default_v3	✓（SNMPv3に必要）	SNMPポーリング中にスキャンする単一のSNMPv3構成。
other_v3s	✓（SNMPv3に必要）	SNMPポーリング中にスキャンする複数のSNMPv3構成。このオプションまたは`default_v3`を使用します。両方ではありません
add_devices	✓✓	検出されたデバイスを`snmp-base.yaml`ファイルの`devices`セクションに追加するかどうかを示します。デフォルトでは、 `true`に設定されています。
add_mibs	✓✓	検出されたMIBを`snmp-base.yaml`ファイルの`global.mibs_enabled`セクションに追加するかどうかを示します。デフォルトでは、 `true`に設定されています。
threads	✓✓	検出中に使用するスレッドの整数制限。コンテナで使用可能なコアの数よりも少なくする必要があります。デフォルトでは、 `4`に設定されています。
replace_devices	✓✓	検出されたデバイスが`snmp-base.yaml`ファイルの`devices`セクションにすでに存在する場合、それらを置き換えるかどうかを示します。デフォルトでは、 `true`に設定されています。
no_dedup_engine_id		`true`に設定すると、報告されたSNMPエンジンIDに基づいて、検出されたデバイスが同じデバイスであると思われる場合に、それらのデバイスの重複排除を無効にします。デフォルトでは、 `false`
check_all_ips		`true`に設定すると、TCPポートスキャンを介して最初に活気をチェックせずに、検出ジョブが`cidrs`アレイのすべてのターゲットIPアドレスに対してSNMP接続を試行するように強制します。この設定は検出ジョブの速度を低下させますが、 `/32`オーバーライドを使用して`cidrs`アレイにリストされていないデバイスに対して検出が失敗する問題を回避するのに役立ちます。デフォルトでは、 `false`

キー名	必須	説明
poll_time_sec	✓✓	デバイスをポーリングする時間（秒単位）。これは、 `devices.<deviceName>.poll_time_sec`属性を使用してデバイスごとにオーバーライドできます。デフォルトでは、 `60`に設定されています。
drop_if_outside_poll		ポーリングに`poll_time_sec`で設定された値よりも時間がかかる場合に、このサイクルからすべての値を削除するかどうかを示します。デフォルトでは、 `false`
mib_profile_dir		キュレートされたMIBプロファイルを見つけるためのディレクトリ。これらは、Kentikのsnmp-profilesリポジトリから自動的に`ktranslate`イメージにプルされ、Dockerランタイムで、プロファイルの独自のローカルディレクトリのボリュームマウントを作成することでオーバーライドできます。
mibs_db
mibs_enabled	✓✓	`ktranslate` dockerイメージがポーリングするすべてのアクティブなMIBの配列。`discovery_add_mibs`属性が`true`の場合、このリストは検出中に自動的に生成されます。ここにリストされていないMIBは、構成ファイル内のどのデバイスでもポーリングされません。`MIB-NAME.tableName`構文を使用して、MIBファイルでSNMPテーブルを直接指定できます。例： `HOST-RESOURCES-MIB.hrProcessorTable` 。
timeout_ms	✓✓	ミリ秒単位の時間SNMPクエリのタイムアウト。これは、 `devices.<deviceName>.timeout_ms`属性を使用してデバイスごとにオーバーライドできます。デフォルトでは、 `3000`
retries	✓✓	失敗したSNMPポーリングの再試行回数。これは、 `devices.<deviceName>.retries`属性を使用してデバイスごとにオーバーライドできます。デフォルトでは、 `0`
user_tags		`key:value` 属性をペアにして、デバイスにより多くのコンテキストを提供します。このレベルのタグは、構成ファイル内のすべてのデバイスに適用されます。
match_attributes		`attribute:regex` ペアを使用して、メトリックを許可リストに追加します。このレベルのペアは、構成ファイル内のすべてのデバイスと照合されます。RE2構文を使用し、デフォルトの`OR`演算子があります。キーの前に`!`を付けて、強制的に`AND`演算子にします。
response_time		構成ファイル内のすべてのデバイスに対して応答時間ポーリングが有効になっているかどうかを示します。デフォルトでは、 `false`に設定されています。
purge_devices_after_num		X 個のスケジュールされた検出ジョブが失敗した後、構成ファイルからデバイスを削除します。デバイスを永久に保持するにはこれを`-1`に設定し、パージしきい値を設定するには`1`以上の整数を設定します。(デフォルト: `0` )

SNMPv3 オプション

キー名	必須	説明
user_name	✓✓	SNMPv3認証のユーザー名
authentication_protocol	✓✓	SNMPv3認証プロトコル。可能な値は、 `NoAuth` 、 `MD5` 、または `SHA`
authentication_passphrase		SNMPv3認証パスフレーズ
privacy_protocol	✓✓	SNMPv3プライバシープロトコル。可能な値は、 `AuthNoPriv` 、 `DES` 、 `AES` 、 `AES192` 、 `AES256` 、 `AES192C` 、または `AES256C`
privacy_passphrase		SNMPv3プライバシーパスフレーズ
context_engine_id		SNMPv3コンテキストエンジンID
context_name		SNMPv3コンテキスト名

例：

discovery:
  default_v3:
    user_name: test1
    authentication_protocol: MD5
    authentication_passphrase: authPass1
    privacy_protocol: AES256
    privacy_passphrase: privacyPass1
    context_engine_id: ""
    context_name: ""

AWS シークレットを使用して認証情報を渡すため。次のように SNMPv3 構成スニペットを更新し、 $SECRET_NAMEの前にaws.sm.を付けます。

default_v3: aws.sm.$SECRET_NAME

AWS では、関連するすべてのkey:valueペアとともにシークレットを JSON 形式で保存する必要があります。これは例です:

{
  "user_name": "$YOUR_USER_NAME",
  "authentication_protocol": "$YOUR_AUTHENTICATION_PROTOCOL",
  "authentication_passphrase": "$YOUR_AUTHENTICATION_PASSPHRASE",
  "privacy_protocol": "$YOUR_PRIVACY_PROTOCOL",
  "privacy_passphrase": "$YOUR_PRIVACY_PASSPHRASE"
}

複数のSNMPv3プロファイルでの検出ジョブの実行をサポートするために、 discovery.default_v3キーをSNMPv3構成の配列を保持するdiscovery.other_v3sキーに置き換えることができます。

discovery:
  other_v3s:
  - user_name: $YOUR_USER_NAME_1
    authentication_protocol: $YOUR_AUTHENTICATION_PROTOCOL_1
    authentication_passphrase: $YOUR_AUTHENTICATION_PASSPHRASE_1
    privacy_protocol: $YOUR_PRIVACY_PROTOCOL_1
    privacy_passphrase: $YOUR_PRIVACY_PASSPHRASE_1
    context_engine_id: ""
    context_name: ""
  - user_name: $YOUR_USER_NAME_2
    authentication_protocol: $YOUR_AUTHENTICATION_PROTOCOL_2
    authentication_passphrase: $YOUR_AUTHENTICATION_PASSPHRASE_2
    privacy_protocol: $YOUR_PRIVACY_PROTOCOL_1
    privacy_passphrase: $YOUR_PRIVACY_PASSPHRASE_2
    context_engine_id: ""
    context_name: ""

APIポーリング構成

ヒント

aws.sm.$SECRET_NAME構文を使用して API 設定でAWS Secrets Manager をネイティブに使用できます。必要に応じて$SECRET_NAMEを置き換えて、Docker 実行時にktranslateが認証情報を取得できるようにします。

Arista eAPI 統合は、通常 SNMP ポーリングでは利用できない追加の BGP および MLAG テレメトリを収集します。

BGP の詳細は次のコマンドから収集されます。 show ip bgp summary vrf all

NRQL を使用して BGP テレメトリを検索します。

FROM Metric SELECT
  max(kentik.eapi.bgp.InMsgQueue) AS 'InQ', // Messages Queued from the Neighbor
  max(kentik.eapi.bgp.MsgReceived) AS 'MsgSent', // Messages Received from the Neighbor
  max(kentik.eapi.bgp.MsgSent) AS 'MsgRcvd', // Messages Sent to the Neighbor
  latest(peer_state) AS 'State', // State of the BGP session
  latest(kentik.eapi.bgp.UpDownTime) AS 'Up/Down', // Period the BGP session has been in current state
  latest(kentik.eapi.bgp.Version) AS 'V' // BGP version number
FACET
  entity.name AS 'Device',
  router_id AS 'Device IP',
  peer AS 'BGP Peer',
  peer_asn AS 'BGP Peer ASN',
  vrf AS 'VRF Name'

MLAG の詳細は、次のコマンドから収集されます。 show mlag detail

NRQL で MLAG テレメトリを検索します。

FROM Metric SELECT
  latest(kentik.eapi.mlag.PortsConfigured) AS 'Ports Configured', // Count of MLAG ports currently configured
  latest(kentik.eapi.mlag.PortsDisabled) AS 'Ports Disabled', // Count of MLAG ports in 'Disabled' state
  latest(kentik.eapi.mlag.PortsActivePartial) AS 'Ports Active-partial', // Count of MLAG ports in 'Active-partial' state 
  latest(kentik.eapi.mlag.PortsInactive) AS 'Ports Inactive', // Count of MLAG ports in 'Inactive' state
  latest(kentik.eapi.mlag.PortsActiveFull) AS 'Ports Active-full', // Count of MLAG ports in 'Active-full' state
  latest(kentik.eapi.mlag.PortsErrdisabled) AS 'Ports Err-disabled', // Count of MLAG ports in 'Err-disabled' state
  latest(config_sanity) AS 'Config-Sanity', // Current result of 'config-sanity' check
  latest(state) AS 'State', // Current MLAG state
  latest(neg_status) AS 'Negotiation Status', // Current negotiation status between switches
  latest(peer_address) AS 'Peer Address', // Address of MLAG peer
  latest(peer_link) AS 'Peer Link', // Link name for MLAG peer
  latest(peer_link_status) AS 'Peer Link Status', // Status of MLAG peer
  latest(local_interface) AS 'Local Interface', // Local interface used for MLAG configuration
  latest(local_intf_status) AS 'Local Interface Status' // Status of local interface used for MLAG configuration
FACET
  entity.name AS 'Device',
  domain_id AS 'MLAG Domain ID'

設定オプション

キー名	必須	説明
eapi_config.ユーザー名	✓✓	eAPI 認証を認証するためにデバイスに渡すユーザー名。
eapi_config.パスワード	✓✓	eAPI 認証を認証するためにデバイスに渡すパスワード。
eapi_config.transport		使用する接続トランスポートのタイプを指定します。可能な値は `https` と `http`です。デフォルト: `https` 。
eapi_config.port	✓✓	eAPI 接続のエンドポイントの TCP ポート。

Meraki ダッシュボード API 統合は、Meraki 環境の健全性に関連するさまざまなメトリクスを取得します。さまざまな構成オプションを組み合わせることで、ニーズに合わせたさまざまな監視シナリオをセットアップできます。

meraki_config.monitor_devices: true && meraki_config.preferences.device_status_only: true：組織デバイスステータスの取得エンドポイントを使用して、組織内のすべての Meraki デバイスのステータスを一覧表示します。

NRQL を使用してデバイスステータステレメトリを検索します。

FROM Metric SELECT
  latest(status) AS 'Device Status' // Current status of this device
FACET
  org_id AS 'Organization ID',
  org_name AS 'Organization Name',
  network_id AS 'Network ID',
  network AS 'Network Name',
  device_name AS 'Device Name',
  src_addr AS 'Device Public IP',
  mac AS 'Device MAC',
  model AS 'Device Model',
  serial AS 'Device Serial',
  address AS 'Device Address',
  lat AS 'Device Latitude',
  lng AS 'Device Longitude',
  notes AS 'Device Notes'
WHERE instrumentation.name = 'meraki.device_status'

meraki_config.monitor_org_changes: true:組織構成変更の取得エンドポイントを使用して、組織の変更ログを表示します。
NRQL を使用して組織構成変更テレメトリを検索します。
```
FROM KExtEvent SELECT *
```

meraki_config.monitor_uplinks: true && meraki_config.preferences.hide_uplink_usage: false：組織のアップリンクステータスの取得エンドポイントを使用して、組織内のすべての Meraki MX、MG、および Z シリーズデバイスのアップリンクステータスとパフォーマンスを一覧表示します。

NRQL を使用してデバイスのアップリンクテレメトリを検索します。

FROM Metric SELECT
  max(kentik.meraki.uplinks.LatencyMS) AS 'Uplink Latency', // Uplink measured latency in milliseconds
  max(kentik.meraki.uplinks.LossPct) AS 'Uplink Loss %', // Uplink measured loss percentage
  max(kentik.meraki.uplinks.Recv) AS 'Uplink Receive Bytes', // Uplink bytes received
  max(kentik.meraki.uplinks.Sent) AS 'Uplink Transmit Bytes', // Uplink bytes sent
  latest(status) AS 'Uplink Status' // Latest status of the uplink
FACET
  org_id AS 'Organization ID',
  org_name AS 'Organization Name',
  network_id AS 'Network ID',
  network AS 'Network Name',
  device_name AS 'Device Name',
  interface AS 'Device Uplink Interface',
  model AS 'Device Model',
  serial AS 'Device Serial'
WHERE org_id IS NOT NULL

meraki_config.monitor_uplinks: true && meraki_config.preferences.hide_uplink_usage: true：組織のアップリンクステータスの取得エンドポイントを使用して、組織内のすべての Meraki MX、MG、および Z シリーズデバイスのアップリンクステータスのみを一覧表示します。
NRQL を使用してデバイスのアップリンクステータステレメトリを検索します。
```
FROM Metric SELECT
  latest(status) AS 'Uplink Status' // Latest status of the uplink
FACET
  org_id AS 'Organization ID',
  org_name AS 'Organization Name',
  network_id AS 'Network ID',
  network AS 'Network Name',
  device_name AS 'Device Name',
  interface AS 'Device Uplink Interface',
  model AS 'Device Model',
  serial AS 'Device Serial'
WHERE org_id IS NOT NULL
```

meraki_config.monitor_vpn_status: true && meraki_config.preferences.show_vpn_peers: false:組織アプライアンスの VPN ステータスの取得エンドポイントを使用して、組織内のネットワーク全体の VPN ステータスを表示します。

NRQL を使用して VPN ステータステレメトリを検索します。

FROM Metric SELECT
  latest(status) AS 'VPN Status' // Latest status of this VPN
FACET
  org_id AS 'Organization ID',
  org_name AS 'Organization Name',
  network_id AS 'Network ID',
  network AS 'Network Name',
  device_name AS 'Device Name',
  serial AS 'Device Serial',
  vpn_mode AS 'VPN Mode',
  wan1 OR wan2 AS 'WAN Interface IP'
WHERE instrumentation.name = 'meraki.vpn_status'
AND org_id IS NOT NULL

meraki_config.monitor_vpn_status: true && meraki_config.preferences.show_vpn_peers: true:組織アプライアンスの VPN ステータスの取得エンドポイントを使用して、組織内のネットワーク全体の VPN ピアに関する情報を追加します。

NRQL を使用して VPN ピアのテレメトリを検索します。

FROM Metric SELECT
  latest(status) AS 'Peer Status' // Current status of this VPN peer
FACET
  network_id AS 'Network ID',
  network AS 'Network Name',
  device_name AS 'Device Name',
  serial AS 'Device Serial',
  vpn_mode AS 'VPN Mode',
  wan1 AS 'WAN 1 IP',
  wan2 AS 'WAN 2 IP',
  peer_name AS 'Peer Name', // Name of this peer
  peer_reachability AS 'Peer Reachability', // Latest results of reachability test for this peer
  peer_network_id AS 'Peer Network ID', // Network ID for this peer
  peer_type AS 'Peer Type' // Type of Peer (Meraki vs Third-party)
WHERE metricName = 'kentik.meraki.vpn_status.PeerStatus'

主な構成オプション

ヒント

KENTIK_MERAKI_API_KEY環境変数を使用すると、API キーを設定ファイルにプレーンテキストで保存せずに Meraki 統合に渡すことができます。

キー名	必須	入力	説明
meraki_config.api_key	✓ ( KENTIK_MERAKI_API_KEY環境変数を使用する場合は不要)	APIキー(文字列)	認証用のMeraki ダッシュボード API キー。
meraki_config.monitor_devices		本当 \| false (デフォルト: false)	組織内のすべての Meraki デバイスのステータスを監視します。
meraki_config.monitor_org_changes		本当 \| false (デフォルト: false)	組織の変更ログを監視します。
meraki_config.monitor_uplinks		本当 \| false (デフォルト: true)	組織内のすべての Meraki MX、MG、および Z シリーズデバイスのアップリンクステータスとパフォーマンスを監視します。
meraki_config.monitor_vpn_status		本当 \| false (デフォルト: false)	組織内のネットワーク全体の VPN ステータスを監視します。

フィルタリングオプション

これらのオプションを使用すると、Meraki 環境内の特定の対象オブジェクトへの監視を制限できます。

キー名	入力	説明
meraki_config.organizations	RE2 構文の正規表現 (デフォルト: null)	すべての監視をフィルタリングして、組織の特定のリストを絞り込みます。
meraki_config.networks	RE2 構文の正規表現 (デフォルト: null)	すべての監視をフィルタリングして、ネットワークの特定のリストを絞り込みます。
meraki_config.product_types	有効なタイプは、ワイヤレス、アプライアンス、スイッチ、systemsManager、カメラ、セルラーゲートウェイ、センサー、およびクラウドゲートウェイです。(デフォルト: null)	特定のタイプのデバイスでフィルタリングするためのパラメータを monitor_devices APIリクエストに追加します。

追加の設定

これらのオプションを使用すると、メインの構成オプションから収集されたデータをさらに定義できます。上記の例のセクションでは、さまざまな組み合わせが説明されています。

キー名	入力	説明
meraki_config.preferences.device_status_only	本当 \| false (デフォルト: false)	`monitor_devices: true` を使用してポーリングをステータス情報のみに制限する場合に必須です。(これはタイムアウトの問題を防ぐために使用されます。)
meraki_config.preferences.hide_uplink_usage	本当 \| false (デフォルト: false)	`monitor_uplinks` と組み合わせて使用すると、パフォーマンスメトリックを削除し、アップリンクのステータス情報のみを返します。
meraki_config.preferences.show_vpn_peers	本当 \| false (デフォルト: false)	`monitor_vpn_status` と組み合わせて使用して、VPN ピアにテレメトリを追加します。

最小構成例

# This represents the minimal configuration required for a container that only performs Meraki API polling.
# By default we only monitor uplinks. All other items are optional.
---
 devices:
    meraki_cloud_controller:
      device_name: meraki_cloud_controller
      device_ip: snmp.meraki.com
      provider: meraki-cloud-controller
      ext:
        ext_only: true
        meraki_config:
          api_key: "$YOUR_API_KEY"
 trap: {}
 discovery: {}
 global:
   poll_time_sec: 300
   timeout_ms: 30000

完全な構成例

# This represents a configuration using all available options that creates multiple entities in New Relic.
---
 devices:
    # Entity 1 - monitor everything this API key has access to
    meraki_all:
      device_name: meraki_all
      device_ip: snmp.meraki.com
      provider: meraki-cloud-controller
      ext:
        ext_only: true
        meraki_config:
          api_key: "$YOUR_API_KEY_1"
          monitor_devices: true
          monitor_org_changes: true
          monitor_uplinks: true
          monitor_vpn_status: true
          preferences:
            device_status_only: true
            show_vpn_peers: true
            hide_uplink_usage: false
    # Entity 2 - Monitor these specific organizations under this API key
    meraki_single_org:
      device_name: meraki_single_org
      device_ip: snmp.meraki.com
      provider: meraki-cloud-controller
      ext:
        ext_only: true
        meraki_config:
          api_key: "$YOUR_API_KEY_2"
          monitor_devices: true
          monitor_org_changes: true
          monitor_uplinks: true
          monitor_vpn_status: true
          preferences:
            device_status_only: true
            show_vpn_peers: true
            hide_uplink_usage: false
          organizations:
            - "Org 1 - Prod.*"
            - "Org 2 - Staging"
    # Entity 3 - Monitor specific devices filtered by organization, network, and product types; using the same API key from Entity 2
    meraki_filtered:
      device_name: meraki_filtered
      device_ip: snmp.meraki.com
      provider: meraki-cloud-controller
      ext:
        ext_only: true
        meraki_config:
          api_key: "$YOUR_API_KEY_2"
          monitor_devices: true
          monitor_uplinks: false
          preferences:
            device_status_only: true
          organizations:
            - "Org 3 - Remote Sites"
          networks:
            - "Corp.*99"
            - "Retail.*"
          product_types:
            - wireless
            - appliance
 trap: {}
 discovery: {}
 global:
   poll_time_sec: 300
   timeout_ms: 30000

AWS の秘密

ktranslate には、AWS Secrets Managerからキーを取得するためのサポートが組み込まれています。

この機能を使用するには、次の3つの環境変数を設定し、実行時にそれらをDockerに提供する必要があります。

名前	説明
AWS_ACCESS_KEY_ID	ユーザーを認証するためのクレデンシャルの一部として使用されるAWSアクセスキーを指定します。
AWS_SECRET_ACCESS_KEY	ユーザーを認証するための認証情報の一部として使用されるAWSシークレットキーを指定します。
AWS_REGION	このプロファイルを使用してリクエストされたコマンドのリクエストを送信するAWSリージョンを指定します。

Dockerランタイムの例：

bash

$docker run -d --name ktranslate-$UNIQUE_NAME --restart unless-stopped --pull=always -p 162:1620/udp \
>  -v `pwd`/snmp-base.yaml:/snmp-base.yaml \
>  -e NEW_RELIC_API_KEY=$YOUR_NR_LICENSE_KEY \
>  -e AWS_ACCESS_KEY_ID=$YOUR_AWS_ACCESS_KEY_ID \
>  -e AWS_SECRET_ACCESS_KEY=$YOUR_AWS_SECRET_ACCESS_KEY \
>  -e AWS_REGION=$YOUR_AWS_REGION \
>  kentik/ktranslate:v2 \
>    -snmp /snmp-base.yaml \
>    -nr_account_id=$YOUR_NR_ACCOUNT_ID \
>    -log_level=info \
>    -metrics=jchf \
>    -tee_logs=true \
>    -service_name=$UNIQUE_NAME \
>    -snmp_discovery_on_start=true \
>    -snmp_discovery_min=180 \
>    nr1.snmp

外部設定ファイル

さまざまな構成と自動化のニーズをサポートするために、Dockerコンテナーにボリュームマウントする外部ファイルを使用して、標準構成ファイルの特定の要素を分離できます。

これらのファイルの構文は、二重引用符を含めて"@fileName.extension"です。

例：

devices:
  "@neteng-devices.yaml"

デバイスファイルは、メイン構成ファイルの標準devicesセクションと同じ構文を使用する必要がありますが、検出中に生成されるオプションのフィールドは省略されます。

devices:
  # Sample of SNMP v2c device
  ups_snmpv2c__10.10.0.201:
    device_name: ups_snmpv2c
    device_ip: 10.10.0.201
    snmp_comm: $YOUR_COMMUNITY_STRING
    oid: .1.3.6.1.4.1.318.1.3.27
    mib_profile: apc_ups.yml
    provider: kentik-ups
    poll_time_sec: 300
    retries: 1
    timeout_ms: 5000
    user_tags:
      owning_team: dc_ops

`match_attributes`属性

可観測性のニーズに見合う価値を生み出さないデータのフィルタリングをサポートするために、 global.match_attributes.{}またはdevices.[].match_attributes.{}属性マップを設定できます。

これにより、New Relic にデータを送信する前に、 ktranslateレベルでフィルタリングが提供され、インターフェースなどの監視をきめ細かく制御できるようになります。

このマップのデフォルトの動作はOR条件ですが、これをオーバーライドして、キー名の前に!を付けることでAND演算子を強制することができます。これは、一致したアイテムのみを返し、すべてのnullおよび"" （空の）結果を省略する場合にも役立ちます。

if_AliasがUplinkで始まる場合、またはif_interface_nameがGigで始まる場合に一致し、すべてのnullと""の値を保持します。

devices:
  deviceName:
    ...
    match_attributes:
      if_Alias: "^Uplink.*"
      if_interface_name: "^Gig.*"

if_AliasがUplinkで始まる場合、およびif_interface_nameがGigで始まる場合に一致し、すべてのnullと""の値を削除します。

devices:
  deviceName:
    ...
    match_attributes:
      if_Alias: "^Uplink.*"
      "!if_interface_name": "^Gig.*"

`response_time`属性と`ping_only`属性

パフォーマンス統計にアクセスできない、または利用できないデバイスの監視をサポートするため、または基本的なラウンドトリップ時間（RTT）の監視が必要な単純な場合に、 global.response_timeまたはdevices.[].ping_only属性をtrueに設定できます。

この機能は、平均、最小、最大、および stddev ラウンドトリップ時間 (RTT) を収集するために、 go-pingパッケージを使用して ICMP または非特権 UDP パケットをデバイスに送信します。このパッケージは、 ktranslateからデバイスの IP アドレスに 1 秒あたり 1 パケットを送信することに基づいて、エンドポイントのパケット損失率も示します。これは、 devices.[].ping_interval_sec属性を設定することでオーバーライドできます。Docker ランタイム中にKENTIK_PING_PRIV=false環境変数を設定することにより、特権 ICMP パケットまたは UDP のデフォルトの使用から切り替えることができます。

global.response_time属性をtrueに設定すると、既存のSNMPポーリングに加えてRTT監視が追加されます。RTTのUDP|ICMPパケットのみを使用し、SNMPポーリングを使用しないデバイスを監視するには、 devices.[].ping_only: trueを使用します。

New Relicでは、次のメトリックを調査することで、このポーリングの結果を確認できます。

FROM Metric SELECT
  average(kentik.ping.AvgRttMs) AS 'Average',
  max(kentik.ping.MaxRttMs) AS 'Max',
  min(kentik.ping.MinRttMs) AS 'Min',
  average(kentik.ping.StdDevRtt) AS 'StdDev',
  latest(kentik.ping.PacketLossPct) AS 'Packet Loss %'
FACET device_name

ヒント

フローデバイスからRTTメトリックを収集する場合は、 flow_only属性の代わりにping_only属性を使用できます。ping_onlyとflow_onlyの両方がtrueの場合、デバイスはflow_onlyデバイスとして扱われます。

`flow_only`属性

フローデータのみを収集するデバイスのモニタリングをサポートするには、 devices.<deviceName>.flow_only属性をtrueに設定します。

これにより、 KFlowイベント名前空間にのみテレメトリを持つフローデバイスエンティティが生成されます。または、構成ファイルにSNMPデバイスとして含まれているデバイスからフローテレメトリを収集すると、ルーターやファイアウォールなどの既存のエンティティにKFlowデータの装飾が追加されます。

New Relicでは、次のイベントを調査することで、このポーリングの結果を確認できます。

FROM KFlow SELECT *
WHERE instrumentation.name = 'netflow-events'

フローデータアプリケーションマッピング

デフォルトでは、フローテレメトリは、特定のフロー会話で使用されているレイヤー4ポートの評価に基づいて、既知のアプリケーションにマッピングされます。必要に応じて、Dockerの実行時に-application_mapフラグにYAMLファイルを提供することで、デフォルトのマッピングをオーバーライドできます。これにより、識別したポートに基づいてアプリケーション名を指定できます。

構文例：

applications:
  - ports: [9092, 9093]
    name: kafka
  - ports: [80, 8080]
    name: http
  - ports: [443, 8443]
    name: https

フローデータ入力フィルタリング

デフォルトでは、フローデータコンテナは受信したすべてのフローパケットを収集して処理します。必要に応じて、指定したフィルターと一致しないすべてのトラフィックを無視する包含フィルターを-nf.sourceフラグに追加できます。

構文： --filters $TYPE,$FIELD,$FUNCTION,$MATCH

引数名	必須	説明
$ TYPE	✓✓	適用するフィルターのタイプ。可能な値は、 `string` 、 `int` 、および`addr`です。
$ FIELD	✓✓	一致パターンを評価するフィールドの名前。
$ FUNCTION	✓✓	評価中に使用する関数のタイプ。可能な値は`Equal: ==` 、 `NotEqual: !=` 、 `LessThan: <` 、 `GreaterThan: >` 、 `Contains: %`
$ MATCH	✓✓	一致パターンとして使用される値。

10.0.0.0/24 CIDR範囲の送信元アドレスからのみフローデータを収集します
```
-nf.source sflow --filters addr,src_addr,%,10.10.0.0/24
```
宛先ポートがと等しくないフローデータのみを収集します 8531
```
-nf.source netflow5 --filters int,l4_dst_port,!=,8531
```
10.0.0.0/24 CIDR 範囲内の送信元アドレス、かつ宛先ポートが8531に等しくない送信元アドレスからのみフローデータを収集します (暗黙的なAND演算子)
```
--filters addr,src_addr,%,10.0.0.0/24 --filters int,l4_dst_port,!=,8531
```

この機械翻訳は参考用に提供されます。

ネットワーク監視の高度な構成

`snmp-base.yaml` サンプルファイル

デバイスセクション

トラップセクション

ディスカバリーセクション

グローバルセクション

SNMPv3 オプション

SNMPv3設定

SNMPv3-AWSシークレット

複数のSNMPv3プロファイルを使用した検出の実行

APIポーリング構成

ヒント

Arista eAPI

設定オプション

Meraki ダッシュボード API

主な構成オプション

ヒント

フィルタリングオプション

追加の設定

最小構成例

完全な構成例

AWS の秘密

AWS シークレットの構成

外部設定ファイル

ディスカバリーCIDR

デバイス

`match_attributes`属性

null値と空の値を持つデフォルトの「OR」

'AND'、nullおよび空の値を省略

単一一致、null値と空の値を省略

`response_time`属性と`ping_only`属性

ヒント

`flow_only`属性

フローデータアプリケーションマッピング

フローデータ入力フィルタリング

フィルタの例

この機械翻訳は参考用に提供されます。

ネットワーク監視の高度な構成

snmp-base.yaml サンプルファイル

トラップセクション

ディスカバリーセクション

グローバルセクション

SNMPv3 オプション

SNMPv3設定

SNMPv3-AWSシークレット

複数のSNMPv3プロファイルを使用した検出の実行

APIポーリング構成

ヒント

Arista eAPI

Meraki ダッシュボード API

AWS の秘密

AWS シークレットの構成

外部設定ファイル

ディスカバリーCIDR

デバイス

match_attributes属性

null値と空の値を持つデフォルトの「OR」

'AND'、nullおよび空の値を省略

単一一致、null値と空の値を省略

response_time属性とping_only属性

ヒント

flow_only属性

フローデータアプリケーションマッピング

フローデータ入力フィルタリング

フローフィルターのオプション

フィルタの例

`snmp-base.yaml` サンプルファイル

`match_attributes`属性

`response_time`属性と`ping_only`属性

`flow_only`属性