Repository navigation
Cisco Meraki metrics package [WIP] - #11069
34 commits merged into
Conversation
Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com>
|
Here's the full mappings, hopefully I didn't miss any. Tried to add Details
- name: meraki
type: group
fields:
- name: organization_id
type: keyword
dimension: true
- name: device
type: group
fields:
- name: serial
type: keyword
dimension: true
- name: address
type: keyword
- name: firmware
type: keyword
- name: imei
type: keyword
- name: lan_ip
type: ip
- name: location
type: keyword
- name: mac
type: keyword
dimension: true
- name: model
type: keyword
- name: name
type: keyword
- name: network_id
type: keyword
dimension: true
- name: notes
type: keyword
- name: product_type
type: keyword
- name: tags
type: keyword
- name: details
type: object
- name: status
type: group
fields:
- name: gateway
type: ip
- name: ip_type
type: keyword
- name: last_reported_at
type: date
- name: primary_dns
type: keyword
- name: public_ip
type: ip
- name: secondary_dns
type: keyword
- name: value
type: keyword
- name: uplink
type: group
fields:
- name: high_availablity
type: group
fields:
- name: enabled
type: boolean
- name: role
type: keyword
- name: last_reported_at
type: date
- name: interface
type: keyword
dimension: true
- name: status
type: keyword
- name: ip
type: ip
- name: gateway
type: ip
- name: public_ip
type: ip
- name: primary_dns
type: keyword
- name: secondary_dns
type: keyword
- name: ip_assigned_by
type: keyword
- name: loss_latency
type: group
fields:
- name: ip
type: ip
- name: loss_percent
type: float
metric_type: gauge
unit: percent
- name: latency_ms
type: float
metric_type: gauge
unit: ms
- name: cellular
type: group
fields:
- name: gateway
type: group
fields:
- name: uplink
type: group
fields:
- name: network_id
type: keyword
dimension: true
- name: last_reported_at
type: date
- name: apn
type: keyword
- name: connection_type
type: keyword
- name: dns1
type: keyword
- name: dns2
type: keyword
- name: gateway
type: ip
- name: iccid
type: keyword
dimension: true
- name: interface
type: keyword
- name: ip
type: ip
- name: model
type: keyword
- name: provider
type: keyword
- name: public_ip
type: ip
- name: signal_stat
type: group
fields:
- name: rsrp
type: float
metric_type: gauge
- name: rsrq
type: float
metric_type: gauge
- name: signal_type
type: keyword
- name: status
type: keyword
- name: network
type: group
fields:
- name: appliance
type: group
fields:
- name: vpn
type: group
fields:
- name: site_to_site
type: group
fields:
- name: network_id
type: keyword
dimension: true
- name: mode
type: keyword
- name: hub
type: group
fields:
- name: hub_id
type: keyword
- name: use_default_route
type: boolean
- name: subnet
type: group
fields:
- name: local_subnet
type: ip_range
- name: use_vpn
type: boolean
- name: health
type: group
fields:
- name: channel
type: group
fields:
- name: radio
type: group
fields:
- name: serial
type: keyword
dimension: true
- name: model
type: keyword
- name: tags
type: keyword
- name: wifi0
type: group
fields:
- name: start_time
type: date
- name: end_time
type: date
- name: utilization80211
type: float
metric_type: gauge
unit: percent
- name: utilizationNon80211
type: float
metric_type: gauge
unit: percent
- name: utilizationTotal
type: float
metric_type: gauge
unit: percent
- name: wifi1
type: group
fields:
- name: start_time
type: date
- name: end_time
type: date
- name: utilization80211
type: float
metric_type: gauge
unit: percent
- name: utilizationNon80211
type: float
metric_type: gauge
unit: percent
- name: utilizationTotal
type: float
metric_type: gauge
unit: percent
- name: switch
type: group
fields:
- name: port
type: group
fields:
- name: port_id
type: keyword
dimension: true
- name: name
type: keyword
- name: tags
type: keyword
- name: enabled
type: boolean
- name: poe_enabled
type: boolean
- name: vlan
type: integer
- name: voice_vlan
type: integer
- name: allowed_vlans
type: keyword
- name: rstp_enabled
type: boolean
- name: stp_guard
type: keyword
- name: link_negotiation
type: keyword
- name: access_policy_type
type: keyword
- name: sticky_mac_allow_list
type: keyword
- name: sticky_mac_allow_list_limit
type: integer
- name: status
type: group
fields:
- name: enabled
type: boolean
- name: status
type: keyword
- name: spanning_tree
type: group
fields:
- name: statuses
type: keyword
- name: is_uplink
type: boolean
- name: errors
type: keyword
- name: warnings
type: keyword
- name: speed
type: keyword
- name: duplex
type: keyword
- name: usage_in_kb
type: group
fields:
- name: sent
type: long
unit: byte
- name: recv
type: long
unit: byte
- name: total
type: long
unit: byte
- name: client_count
type: integer
metric_type: gauge
- name: power_usage_in_wh
type: float
metric_type: gauge
- name: traffic_in_kbps
type: group
fields:
- name: total
type: float
metric_type: gauge
unit: byte
- name: sent
type: float
metric_type: gauge
unit: byte
- name: recv
type: float
metric_type: gauge
unit: byte
- name: secure_port
type: group
fields:
- name: enabled
type: boolean
- name: active
type: boolean
- name: authentication_status
type: keyword
- name: config_overrides
type: group
fields:
- name: type
type: keyword
- name: vlan
type: integer
- name: voice_vlan
type: integer
- name: allowed_vlans
type: keyword
- name: cdp
type: group
fields:
- name: system_name
type: keyword
- name: platform
type: keyword
- name: device_id
type: keyword
- name: port_id
type: keyword
- name: native_vlan
type: integer
- name: address
type: ip
- name: management_address
type: ip
- name: version
type: keyword
- name: vtp_management_domain
type: keyword
- name: capabilities
type: keyword
- name: lldp
type: group
fields:
- name: system_name
type: keyword
- name: system_description
type: keyword
- name: chassis_id
type: keyword
- name: port_id
type: keyword
- name: management_vlan
type: integer
- name: port_vlan
type: integer
- name: management_address
type: ip
- name: port_description
type: keyword
- name: system_capabilities
type: keyword
- name: wireless
type: group
fields:
- name: device
type: group
fields:
- name: channel
type: group
fields:
- name: utilization
type: object
- name: appliance
type: group
fields:
- name: network
type: group
fields:
- name: port
type: group
fields:
- name: number
type: integer
- name: enabled
type: boolean
- name: type
type: keyword
- name: drop_untagged_traffic
type: boolean
- name: vlan
type: integer
- name: allowed_vlans
type: keyword
- name: access_policy
type: keyword
- name: license
type: group
fields:
- name: device_model
type: keyword
- name: expiration_date
type: date
- name: status
type: keyword
- name: count
type: long
metric_type: gauge
- name: state
type: keyword
- name: expiration_state
type: keyword
- name: expiration_threshold_days
type: long
- name: soonest_activation_date
type: date
- name: soonest_activation_count
type: long
metric_type: gauge
- name: oldest_activation_date
type: date
- name: oldest_activation_count
type: long
metric_type: gauge
- name: type
type: keyword
- name: systems_manager
type: group
fields:
- name: active_seats
type: long
metric_type: gauge
- name: org_wide_enrolled_devices
type: long
metric_type: gauge
- name: total_seats
type: long
metric_type: gauge
- name: unassigned_seats
type: long
metric_type: gauge |
|
I added agent fields mappings (048665e) because we need mappings for
|
|
@gpop63 do we need all the extra mappings, or can we get away with just |
|
I've added some comments. Everything else looks good! |
Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>
| - security | ||
| conditions: | ||
| kibana: | ||
| version: "^8.15.2" |
There was a problem hiding this comment.
FYI - we need to leave this at 8.15.2 for this to work with the 8.15.2-SNAPSHOT build, but we should be aware that this will NOT work with the public 8.15.2 version. because this is a beta package this is ok, but as soon as 8.15.3 is released we need to bump this version to 8.15.3. please open a ticket on this so we don't forget. thanks!!
shmsr
left a comment
There was a problem hiding this comment.
I've put one comment. Rest LGTM. Approving!
|
💚 Build Succeeded
History
|
|
Can we consider re-arranging the order of the input control selector to a more hierarchical ordering |
| - name: voice_vlan | ||
| type: long | ||
| description: The voice VLAN of the switch port. Only applicable to access ports. | ||
| - name: status |
There was a problem hiding this comment.
In the dashboard, can we maintain a table to display all the statuses (client count, duplex, errors, is_uplink, power_usage_in_wh, speed, status, warning, stp_statuuses) for the specific device ?
| "stop": 3.33 | ||
| }, | ||
| { | ||
| "color": "#d6bf57", |
There was a problem hiding this comment.
Will it be good to show the list of devices that are not in Green status?
| "palette": { | ||
| "name": "custom", | ||
| "params": { | ||
| "colorStops": [ |
There was a problem hiding this comment.
Will it be good to show the list of devices having unlink latency outside the green status?
|
Please consider adding the unit of the metric, either in the Y-axis or in the panel title label. Example: Switch port data throughput, Channel utilisation, Switch Port power usage |
| } | ||
| ], | ||
| "timeRestore": false, | ||
| "title": "[Metrics Cisco Meraki] Device Health Overview", |
There was a problem hiding this comment.
In the screenshot file, the name is appearing as Device Health Overview(1). Looks like the screenshot was taken from a cloned dashboard.
| - name: enabled | ||
| type: boolean | ||
| description: Whether the port is configured to be enabled. | ||
| - name: errors |
There was a problem hiding this comment.
Kindly include a metric visualisation to capture this information.
There was a problem hiding this comment.
If there is a possibility of recurring errors, showing the trend of errors using a line visualisation can be considered.
| - name: status | ||
| type: keyword | ||
| description: The current connection status of the port. | ||
| - name: warnings |
There was a problem hiding this comment.
Similar to the errors (please see the above comment), showing the number of warnings or trend of the warnings will be helpful
| - name: voice_vlan | ||
| type: long | ||
| description: The voice VLAN of the . Only applicable to access ports. | ||
| - name: throughput |
There was a problem hiding this comment.
Can we consider including throughput values in the dashboard?
|
Please revisit the logo used. I guess, there exist a more relevant one. |
I understand that the current logo is selected to be consistent with other cisco integrations. Marking it as resolved. |
|
Package cisco_meraki_metrics - 0.1.0 containing this change is available at https://epr.elastic.co/search?package=cisco_meraki_metrics |
* meraki metrics package initial commit * fix metricset name * fix indentation of 'uplink' field mappings * Update packages/cisco_meraki_metrics/changelog.yml Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com> * update mappings * fix validation errors in mappings * add store:true to text mappings to allow integration install * add fields descriptions * add sample event * add ecs version * update readme docs * add missing unit mappings * improve titles and descriptions * fix owner add CODEOWNERS entry * automatic lint * add organization_id field * add agent fields * add ecs field reference in docs * add ingest pipeline transforms uplink loss pct field converts rsrp and rsrq to floats * fix field types fix descriptions * remove unused agent fields * add tags and processors * add configuration steps in docs * make organizations an array in agent config * add dashboard * use average instead of sum for uplink latency * add device map lens * update dashboard add dashboard image in integration remove old dashboard remove sample screenshot * capitalize 'metrics' in integration title * fix dashboard title * delete wrongly added dashboard * address reviews * Update version to 0.1.0 Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com> * fix manifest version --------- Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com> Co-authored-by: Gabriel Pop <gabriel.pop@elastic.co> Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>
* meraki metrics package initial commit * fix metricset name * fix indentation of 'uplink' field mappings * Update packages/cisco_meraki_metrics/changelog.yml Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com> * update mappings * fix validation errors in mappings * add store:true to text mappings to allow integration install * add fields descriptions * add sample event * add ecs version * update readme docs * add missing unit mappings * improve titles and descriptions * fix owner add CODEOWNERS entry * automatic lint * add organization_id field * add agent fields * add ecs field reference in docs * add ingest pipeline transforms uplink loss pct field converts rsrp and rsrq to floats * fix field types fix descriptions * remove unused agent fields * add tags and processors * add configuration steps in docs * make organizations an array in agent config * add dashboard * use average instead of sum for uplink latency * add device map lens * update dashboard add dashboard image in integration remove old dashboard remove sample screenshot * capitalize 'metrics' in integration title * fix dashboard title * delete wrongly added dashboard * address reviews * Update version to 0.1.0 Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com> * fix manifest version --------- Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com> Co-authored-by: Gabriel Pop <gabriel.pop@elastic.co> Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>


Proposed commit message
Checklist
changelog.ymlfile.Author's Checklist
How to test this PR locally
Related issues
Screenshots