Cisco Meraki 指标集成

编辑

Cisco Meraki 指标集成

编辑

版本

0.2.0 [beta] 此功能为 beta 版本,可能会发生变化。其设计和代码不如正式 GA 功能成熟,按原样提供,不提供任何保证。Beta 功能不受正式 GA 功能的支持 SLA 约束。 (查看全部)

兼容的 Kibana 版本

8.15.2 或更高版本

支持的无服务器项目类型
这是什么?

安全
可观测性

订阅级别
这是什么?

基本

支持级别
这是什么?

Elastic

此集成定期从 Cisco Meraki 网络获取指标。它收集各种指标,包括设备详细信息和状态、网络性能测量、交换机端口信息、无线信道利用率和上行链路性能。

这些指标可帮助您了解 Meraki 网络的运行状况,并使您更容易监控和管理您的网络设置。

兼容性

编辑

该集成使用 Meraki Dashboard RESTful API 库从 Cisco Meraki 网络收集指标。

要求

编辑

您需要 Elasticsearch 来存储和搜索您的数据,以及 Kibana 来可视化和管理数据。您可以使用我们托管在 Elastic Cloud 上的 Elasticsearch 服务(推荐),或者在您自己的硬件上自行管理 Elastic Stack。

配置

编辑

要在 Elastic 中配置此集成,您需要来自 Cisco Meraki 的以下信息

  • API 密钥
  • 组织 ID
  • API 基本 URL(可选)

有关这些设置的更多详细信息,请参阅 Meraki Dashboard API 文档

在 Elastic 中启用集成

编辑
  1. 在 Kibana 中,导航到 管理 > 集成
  2. 在“搜索集成”搜索栏中,键入 Meraki
  3. 从搜索结果中单击“Cisco Meraki 指标”集成
  4. 单击 添加 Cisco Meraki 指标集成 按钮以添加集成

指标

编辑

设备运行状况

编辑

device_health 数据集提供与 Meraki 设备的运行状况和状态相关的指标。所有 Cisco Meraki 特定字段都在 meraki 字段组中提供。

ECS 字段参考

有关 ECS 字段的详细信息,请参阅以下 文档

导出的字段
字段 描述 类型 单位 指标类型

@timestamp

事件时间戳。

date

data_stream.dataset

数据流数据集。

constant_keyword

data_stream.namespace

数据流命名空间。

constant_keyword

data_stream.type

数据流类型。

constant_keyword

host.ip

主机 IP 地址。

ip

host.mac

主机 MAC 地址。

keyword

host.name

主机名称。它可以包含 Unix 系统上 hostname 返回的内容、完全限定的域名或用户指定的名称。发送方决定使用哪个值。

keyword

meraki.device.address

设备的物理地址。

text

meraki.device.channel_utilization.wifi0.utilization_80211

给定无线电的 wifi 信道利用率百分比。

double

percent

gauge

meraki.device.channel_utilization.wifi0.utilization_non_80211

给定无线电的非 wifi 信道利用率百分比。

double

percent

gauge

meraki.device.channel_utilization.wifi0.utilization_total

给定无线电的总信道利用率百分比。

double

percent

gauge

meraki.device.channel_utilization.wifi1.utilization_80211

给定无线电的 wifi 信道利用率百分比。

double

percent

gauge

meraki.device.channel_utilization.wifi1.utilization_non_80211

给定无线电的非 wifi 信道利用率百分比。

double

percent

gauge

meraki.device.channel_utilization.wifi1.utilization_total

给定无线电的总信道利用率百分比。

double

percent

gauge

meraki.device.firmware

设备的固件版本。

keyword

meraki.device.high_availability.enabled

指示是否为设备启用了高可用性。对于不支持 HA 的设备,此值将为 false

boolean

meraki.device.high_availability.role

设备在网络中的 HA 角色。对于不支持 HA 的设备,此值将为 primary

keyword

meraki.device.imei

设备的 IMEI(如果适用)。

keyword

meraki.device.lan_ip

设备的 LAN IP 地址。

ip

meraki.device.license.activation_date

许可证开始生效的日期。

date

meraki.device.license.claim_date

许可证在组织中被声明的日期。

date

meraki.device.license.duration_in_days

单个许可证的有效期。

long

meraki.device.license.expiration_date

许可证到期日期。

date

meraki.device.license.head_license_id

此许可证排队在其后的主许可证的 ID。如果没有主许可证,则返回 nil。

keyword

meraki.device.license.id

许可证 ID。

keyword

meraki.device.license.license_type

许可证类型。

keyword

meraki.device.license.order_number

订单号。

keyword

meraki.device.license.seat_count

许可证的席位数。仅适用于 SM 许可证。

long

meraki.device.license.state

许可证的状态。所有排队的许可证的状态均为 recentlyQueued

keyword

meraki.device.license.total_duration_in_days

许可证的有效期以及与其关联的所有永久排队许可证的有效期。

long

meraki.device.location

设备的经度和纬度。

geo_point

meraki.device.mac

设备的 MAC 地址。

keyword

meraki.device.model

设备的型号。

keyword

meraki.device.name

设备的名称。

keyword

meraki.device.network_id

设备所属网络的 ID。

keyword

meraki.device.notes

设备的备注,限制为 255 个字符。

text

meraki.device.performance_score

double

gauge

meraki.device.product_type

设备的产品类型。

keyword

meraki.device.serial

设备的序列号。

keyword

meraki.device.status.gateway

IP 网关。

ip

meraki.device.status.ip_type

IP 类型。

keyword

meraki.device.status.last_reported_at

设备上次报告日期。

date

meraki.device.status.primary_dns

主 DNS。

ip

meraki.device.status.public_ip

公共 IP 地址。

ip

meraki.device.status.secondary_dns

辅助 DNS。

keyword

meraki.device.status.value

设备状态。

keyword

meraki.device.tags

分配给设备的标签列表。

keyword

meraki.organization_id

keyword

meraki.switch.port.access_policy_type

交换机端口的访问策略类型。仅适用于接入端口。可以是 OpenCustom access policyMAC allow listSticky MAC allow list 之一。

keyword

meraki.switch.port.allowed_vlans

交换机端口上允许的 VLAN。仅适用于中继端口。

keyword

meraki.switch.port.enabled

交换机端口的状态。

boolean

meraki.switch.port.id

交换机端口的标识符。

keyword

meraki.switch.port.link_negotiation

交换机端口的链路速度。

keyword

meraki.switch.port.name

交换机端口的名称。

keyword

meraki.switch.port.poe_enabled

交换机端口的 PoE 状态。

boolean

meraki.switch.port.rstp_enabled

快速生成树协议状态。

boolean

meraki.switch.port.status.cdp.address

包含接收和发送设备的网络地址。

keyword

meraki.switch.port.status.cdp.capabilities

标识设备类型,指示设备的功能。

keyword

meraki.switch.port.status.cdp.device_id

标识设备名称。

keyword

meraki.switch.port.status.cdp.management_address

设备的管理 IP。

ip

meraki.switch.port.status.cdp.native_vlan

指示每个接口上未标记数据包的假定 VLAN。

long

meraki.switch.port.status.cdp.platform

标识设备的硬件平台。

keyword

meraki.switch.port.status.cdp.port_id

标识发送 CDP 数据包的端口。

keyword

meraki.switch.port.status.cdp.system_name

系统名称。

keyword

meraki.switch.port.status.cdp.version

包含设备软件版本信息。

keyword

meraki.switch.port.status.cdp.vtp_management_domain

通告系统的已配置 VLAN 中继协议 (VTP) 管理域名称。

keyword

meraki.switch.port.status.client_count

通过此端口连接的客户端数量。

long

gauge

meraki.switch.port.status.duplex

连接端口的当前双工模式。

keyword

meraki.switch.port.status.enabled

是否配置为启用端口。

boolean

meraki.switch.port.status.errors

端口上存在的所有错误。

keyword

meraki.switch.port.status.is_uplink

端口是否为交换机的上行链路。

boolean

meraki.switch.port.status.lldp.chassis_id

设备的机箱 ID。

keyword

meraki.switch.port.status.lldp.management_address

设备的管理 IP。

keyword

meraki.switch.port.status.lldp.management_vlan

设备的管理 VLAN。

long

meraki.switch.port.status.lldp.port_description

发送 LLDP 数据包的端口的描述。

keyword

meraki.switch.port.status.lldp.port_id

标识发送 LLDP 数据包的端口。

keyword

meraki.switch.port.status.lldp.port_vlan

端口的 VLAN。

long

meraki.switch.port.status.lldp.system_capabilities

标识设备类型,指示设备的功能。

keyword

meraki.switch.port.status.lldp.system_description

设备的系统描述。

keyword

meraki.switch.port.status.lldp.system_name

设备的系统名称。

keyword

meraki.switch.port.status.power_usage_in_wh

在此时间段内,此端口提供的电量(以瓦时为单位)。

double

gauge

meraki.switch.port.status.secure_port.active

是否为该端口激活了安全端口。

boolean

meraki.switch.port.status.secure_port.authentication_status

当前安全端口状态。

keyword

meraki.switch.port.status.secure_port.config_overrides.allowed_vlans

允许在端口上的 VLAN。仅适用于中继端口。

keyword

meraki.switch.port.status.secure_port.config_overrides.type

中继接入)的类型。

keyword

meraki.switch.port.status.secure_port.config_overrides.vlan

的 VLAN。对于中继端口,这是本机 VLAN。空值将清除为中继端口设置的值。

long

meraki.switch.port.status.secure_port.config_overrides.voice_vlan

的语音 VLAN。仅适用于接入端口。

long

meraki.switch.port.status.secure_port.enabled

是否为该端口启用了安全端口。

boolean

meraki.switch.port.status.speed

端口当前运行的数据传输速率。

keyword

meraki.switch.port.status.status

端口的当前连接状态。

keyword

meraki.switch.port.status.stp_statuses

端口的当前生成树协议状态。

keyword

meraki.switch.port.status.throughput.recv

接收到的数据的平均速度(以千比特每秒为单位)。

double

gauge

meraki.switch.port.status.throughput.sent

发送的数据的平均速度(以千比特每秒为单位)。

double

gauge

meraki.switch.port.status.throughput.total

发送和接收的数据的平均速度(以千比特每秒为单位)。

double

gauge

meraki.switch.port.status.usage.recv

接收到的数据量(以千字节为单位)。

long

gauge

meraki.switch.port.status.usage.sent

已发送的数据量(以千字节为单位)。

long

gauge

meraki.switch.port.status.usage.total

已发送和接收的总数据量(以千字节为单位)。

long

gauge

meraki.switch.port.status.warnings

端口上存在的所有警告。

keyword

meraki.switch.port.sticky_mac_allow_list

粘性 MAC 允许列表的初始 MAC 地址列表。仅当 accessPolicyType粘性 MAC 允许列表 时适用。

keyword

meraki.switch.port.sticky_mac_allow_list_limit

粘性 MAC 允许列表的最大 MAC 地址数。仅当 accessPolicyType粘性 MAC 允许列表 时适用。

long

meraki.switch.port.stp_guard

STP 保护的状态(禁用根保护BPDU 保护环路保护)。

keyword

meraki.switch.port.tags

交换机端口的标签列表。

keyword

meraki.switch.port.type

交换机端口的类型(trunkaccess)。

keyword

meraki.switch.port.vlan

交换机端口的 VLAN。对于 trunk 端口,这是本机 VLAN。空值将清除为 trunk 端口设置的值。

long

meraki.switch.port.voice_vlan

交换机端口的语音 VLAN。仅适用于接入端口。

long

meraki.uplink.apn

接入点名称。

keyword

meraki.uplink.connection_type

连接类型。

keyword

meraki.uplink.gateway

网关 IP。

ip

meraki.uplink.iccid

集成电路卡识别码。

keyword

meraki.uplink.interface

上行链路接口。

keyword

meraki.uplink.ip

上行链路 IP。

ip

meraki.uplink.ip_assigned_by

IP 的分配方式。

keyword

meraki.uplink.last_reported_at

上行链路最后报告日期。

date

meraki.uplink.latency.ms

延迟(以毫秒为单位)。

double

毫秒

gauge

meraki.uplink.loss.pct

丢失百分比。

double

percent

gauge

meraki.uplink.model

上行链路型号。

keyword

meraki.uplink.primary_dns

主 DNS IP。

ip

meraki.uplink.provider

网络提供商。

keyword

meraki.uplink.public_ip

公网 IP。

ip

meraki.uplink.rsrp

参考信号接收功率。

浮点数

meraki.uplink.rsrq

参考信号接收质量。

浮点数

meraki.uplink.secondary_dns

辅助 DNS IP。

ip

meraki.uplink.signal_type

信号类型。

keyword

meraki.uplink.status

上行链路状态。

keyword

示例

device_health 的示例事件如下

{
    "@timestamp": "2024-09-30T16:55:38.202Z",
    "agent": {
        "ephemeral_id": "11855dde-6a4a-48ce-ac32-087b1c7999a3",
        "id": "f06c246c-8375-47a9-b0f1-d0fc6c050e4e",
        "name": "docker-fleet-agent",
        "type": "metricbeat",
        "version": "8.15.2"
    },
    "data_stream": {
        "dataset": "cisco_meraki_metrics.device_health",
        "namespace": "default",
        "type": "metrics"
    },
    "ecs": {
        "version": "8.0.0"
    },
    "elastic_agent": {
        "id": "f06c246c-8375-47a9-b0f1-d0fc6c050e4e",
        "snapshot": true,
        "version": "8.15.2"
    },
    "event": {
        "agent_id_status": "verified",
        "dataset": "cisco_meraki_metrics.device_health",
        "duration": 12982553765,
        "ingested": "2024-09-30T16:56:01Z",
        "module": "meraki"
    },
    "host": {
        "architecture": "x86_64",
        "containerized": false,
        "hostname": "docker-fleet-agent",
        "id": "c7f0ac74f5e24f78942164132c2c8ead",
        "ip": "172.21.0.4",
        "mac": "02-42-AC-15-00-04",
        "name": "docker-fleet-agent",
        "os": {
            "codename": "focal",
            "family": "debian",
            "kernel": "6.8.0-45-generic",
            "name": "Ubuntu",
            "platform": "ubuntu",
            "type": "linux",
            "version": "20.04.6 LTS (Focal Fossa)"
        }
    },
    "meraki": {
        "device": {
            "firmware": "switch-17-2",
            "lan_ip": "10.0.15.78",
            "location": {
                "lat": 40.7128,
                "lon": -74.0060
            },
            "mac": "00:1a:2b:3c:4d:5e",
            "model": "MS225-24P",
            "name": "Office Switch 1",
            "network_id": "N_123456789012345678",
            "product_type": "switch",
            "serial": "Q2XY-5N6M-7VK9"
        },
        "organization_id": "987654",
        "switch": {
            "port": {
                "access_policy_type": "Open",
                "allowed_vlans": "all",
                "enabled": true,
                "id": "7",
                "link_negotiation": "Auto negotiate",
                "poe_enabled": true,
                "rstp_enabled": true,
                "status": {
                    "cdp": {
                        "address": "10.0.15.100",
                        "capabilities": "Host",
                        "device_id": "0A:1B:2C:3D:4E:5F",
                        "platform": "CIVS-IPC-7070",
                        "port_id": "eth0",
                        "version": "2.12.2-5"
                    },
                    "client_count": 3,
                    "duplex": "full",
                    "enabled": true,
                    "is_uplink": false,
                    "lldp": {
                        "chassis_id": "0a:1b:2c:3d:4e:5f",
                        "port_description": "eth0",
                        "port_id": "0a:1b:2c:3d:4e:5f",
                        "system_capabilities": "S-VLAN Component of a VLAN Bridge, Two-port MAC Relay",
                        "system_description": "Cisco Network Camera",
                        "system_name": "(none)"
                    },
                    "power_usage_in_wh": 2.5,
                    "secure_port": {
                        "active": false,
                        "authentication_status": "Disabled",
                        "enabled": false
                    },
                    "speed": "1 Gbps",
                    "status": "Connected",
                    "stp_statuses": [
                        "Forwarding",
                        "Is edge",
                        "Is peer-to-peer"
                    ],
                    "throughput": {
                        "recv": 15.6,
                        "sent": 8.2,
                        "total": 23.8
                    },
                    "usage": {
                        "recv": 1024,
                        "sent": 512,
                        "total": 1536
                    }
                },
                "stp_guard": "disabled",
                "type": "trunk",
                "vlan": 10
            }
        }
    },
    "metricset": {
        "name": "device_health",
        "period": 60000
    },
    "service": {
        "type": "meraki"
    }
}

更新日志

编辑
更新日志
版本 详细信息 Kibana 版本

0.2.0

增强 (查看拉取请求)
addressnotes字段的数据类型从keyword更改为text,以启用全文搜索功能。

0.1.0

增强 (查看拉取请求)
软件包的初始草案