Document toolboxDocument toolbox

Cisco Meraki collector

Owned by Juan Tomás Alonso Nieto (Deactivated)
Last updated: Aug 01, 2024
10 min read
[ 1 Overview ] [ 2 Data source description ] [ 3 Vendor setup ] [ 4 Run the collector ] [ 5 Activeboards ] [ 6 Change log ]

Overview

Cisco Meraki offers the only solution that provides unified management of mobile devices, Macs, PCs, and the entire network from a centralized dashboard. Enforce device security policies, deploy software and apps, and perform remote, live troubleshooting on thousands of managed devices.

Cisco Meraki products are built from the ground up for cloud management and come out of the box with centralized management, layer 7 device and application visibility, real-time web-based diagnostics, monitoring, reporting, and much, much more.

Data source description

Source

Description

Devo data tables

Meraki organization changelog

Displays changes made in any network within the current Organization since it was created. This includes configuration changes made to all types of devices, not just administrative changes to the Dashboard. Each time a change is made an event in the ChangeLog will be generated.

cloud.meraki.api.changelog

MX security events

Display security events generated by MX Appliances for each existing network.
These events are logged as a result of the Connection Monitoring tests failing.

network.meraki.api.security_events

Appliance/Switch/Wireless Event Log

Display network events generated by all managed MR/SM/MS/MV devices for each existing network.

 network.meraki.api.events

For more info about the Cisco Meraki, visit the Cisco Meraki user guide.

Vendor setup

Meraki collector works over the API to retrieve the data, so is needed to enable the access via API Key and generate a Key to allow the collector to get the data following the steps below:

  • If Meraki dashboard IP filtering is enabled, make sure to allow access for the collector IP or IP range.

  • Be careful, the API key will inherit the permissions of the user who creates it, so it must be created with a user with at least "organization - read only" permissions.

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Activeboards

A number of predefined dashboards that make use of the configured collectors can be downloaded here. To instantiate them, follow these instructions:

  1. Create a new Devo Activeboard in your domain.

  2. In edit mode, click on the ellipsis button and select Edit raw configuration.

  3. Open the downloaded file, select all the text, and copy it to the clipboard.

  4. Paste the contents of the file in the raw editor. Make sure you replace completely the existing configuration.

  5. Click on Save changes. The dashboard should show up immediately.

Change log

Release

Released on

Release type

Details

Recommendations

v1.7.0

Jul 26, 2024

IMPROVEMENTSBUG FIX

Bug fixes:

  • Changed the api_mode to false in metadata file.

Improvements:

  • Update DCSDK from 1.11.1 to 1.12.2

    • Added new sender for relay in house + TLS

    • Added persistence functionality for gzip sending buffer

    • Added Automatic activation of gzip sending

    • Improved behaviour when persistence fails

    • Upgraded DevoSDK dependency

    • Fixed console log encoding

    • Restructured python classes

    • Improved behavior with non-utf8 characters

    • Decreased defaut size value for internal queues (Redis limitation, from 1GiB to 256MiB)

    • New persistence format/structure (compression in some cases)

    • Removed dmesg execution (It was invalid for docker execution)

    • DevoSDK has been updated to version 5.4.0

  • Updated the docker base image to 1.3.0

Recommended version

v1.6.0

Apr 3, 2024

IMPROVEMENTSBUG FIX

Improvements:

  1. Update DCSDK from 1.10.2 to 1.11.1

    • Updated DevoSDK to v5.1.10

    • Fix for SyslogSender related to UTF-8

    • Enhace of troubleshooting. Trace Standardization, Some traces has been introduced.

    • Introduced a mechanism to detect "Out of Memory killer" situation.

    • Updated DevoSDK to v5.1.9.

    • Fixed some bug related to development on MacOS.

    • Added an extra validation and fix when the DCSDK receives a wrong timestamp format.

    • Added an optional config property for use the Syslog timestamp format in a strict way.

Bug fixing:

  • Programmatically updated the start date if more than 7 days old.

Upgrade

v1.5.1

Dec 18, 2023

IMPROVEMENTS BUG FIX

Improvements:

  1. Update DCSDK from 1.9.0 to 1.10.2

    • Changed log level to some messages from info to debug

    • Changed some wrong log messages

    • Upgraded some internal dependencies

    • Changed queue passed to setup instance constructor

    • Ability to validate collector setup and exit without pulling any data

    • Ability to store in the persistence the messages that couldn't be sent after the collector stopped

    • Ability to send messages from the persistence when the collector starts and before the puller begins working

    • Ensure special characters are properly sent to the platform

Bug fixing:

  • Fixed the API parameters to get the correct data to avoid repeated API calls and hence the delay in security events.

Upgrade

v1.4.0

Aug 9, 2023

IMPROVEMENTS BUG FIX

Improvements:

  1. Update DCSDK from 1.1.4 to 1.9.0

    • Ability to validate collector setup and exit without pulling any data

    • Ability to store in the persistence the messages that couldn't be sent after the collector stopped

    • Ability to send messages from the persistence when the collector starts and before the puller begins working

    • Ensure special characters are properly sent to the platform

    • Added a lock to enhance sender object

    • Added new class attrs to the setstate and getstate queue methods

    • Fix sending attribute value to the setstate and getstate queue methods

    • Added log traces when queues are full and have to wait

    • Added log traces of queues time waiting every minute in debug mode

    • Added method to calculate queue size in bytes

    • Block incoming events in queues when there are no space left

    • Send telemetry events to Devo platform

    • Upgraded internal Python dependency Redis to v4.5.4

    • Upgraded internal Python dependency DevoSDK to v5.1.3

    • Fixed obfuscation not working when messages are sent from templates

    • New method to figure out if a puller thread is stopping

    • Upgraded internal Python dependency DevoSDK to v5.0.6

    • Improved logging on messages/bytes sent to Devo platform

    • Fixed wrong bytes size calculation for queues

    • New functionality to count bytes sent to Devo Platform (shown in console log)

    • Upgraded internal Python dependency DevoSDK to v5.0.4

    • Fixed bug in persistence management process, related to persistence reset

    • Aligned source code typing to be aligned with Python 3.9.x

    • Inject environment property from user config

    • Obfuscation service can be now configured from user config and module definiton

    • Obfuscation service can now obfuscate items inside arrays

Bug fixing:

  • Updated the limits of the API: The limits have been modified with the official values. This fixes throttling issues.

Upgrade

v1.3.7

Aug 3, 2022

BUG FIX

Bug fixing:

  • Fixed a bug in the security-events service (MX events) when no new events are received.

Upgrade

v1.3.6

Aug 3, 2022

IMPROVEMENTS BUG FIX

Improvements:

  • The number of debug traces has been increased to provide better visibility when troubleshooting.

  • The network_security_events (MX) service has been enhanced with new logic that avoids requesting MX events from networks without MX appliances. This reduces the number of unnecessary API requests to Meraki that were returning 400 HTTP CODE.

  • Meraki Python package has been upgraded from v1.18.2 to v1.22.1

  • The events are sent to Devo in batches, increasing the performance.

Bug fixing:

  • Fixed a bug where the data extraction services via network_event_log and network_security_events stopped pulling events after retrieving the first page of 1,000 events. This behavior was causing some delay in the ingest in networks with a high volume of events.

  • Fixed how persistence of the network_security_events service is handled and it now stores a unique save point for each available network instead of one for all networks.

  • Fixed a bug where events were being sent to Devo without proper ordering. Now all events are ordered from the origin by the API.

Upgrade

v1.3.5

Jul 11, 2022

IMPROVEMENTS BUG FIX

Improvements:

  • The number of debug traces has been increased to provide better visibility when troubleshooting.

Bug fixes:

  • Logging AssertionError trace thrown when requesting invalid product types from networks without those product types is now logged in debug level.

Upgrade

v1.3.4

May 5, 2022

IMPROVEMENTS BUG FIX

Improvements:

  • When the Meraki API returns an HTTP CODE 429 (Too many requests), the collector handle it to avoid overflooding.

Bug fixes:

  • Some error messages were logged at the debug level and are now logged at the error level correctly.

Upgrade

v1.3.2

Apr 6, 2022

VULNS

Vulnerabilities mitigation:

  • All critical and high vulnerabilities have been mitigated.

Upgrade

v1.3.0

Mar 21, 2022

FEATURE VULNS IMPROVEMENTS

New features:

  • The resilience has been improved with a new feature that restart the collector when the Devo connections is lost and it cannot be recovered.

Improvements:

  • The underlay IFC SDK has been updated to v1.1.3.

Vulnerabilities mitigation:

  • All critical and high vulnerabilities have been mitigated.

Upgrade