Add assets for Cisco SD-WAN integration #17502

TCheruy · 2024-05-02T13:13:11Z

What does this PR do?

Add assets for the Cisco SD-WAN integration
Includes:

One dashboard
Three monitors
A readme doc
Metrics metadata

Motivation

Additional Notes

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Changelog entries must be created for modifications to shipped code
Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

github-actions · 2024-05-02T13:14:43Z

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

estherk15 · 2024-05-03T13:16:03Z

cisco_sdwan/assets/monitors/device_reboot.json

+  "tags": [
+    "integration:cisco-sdwan"
+  ],
+  "description": "This monitor alerts when a Cisco SD-WAN device has rebooted more than 5 times within the last 10 minutes.",


Hi @TCheruy, the description is a duplicate of the title and could also add more information on the impact of this as an issue. See the Best Practices in this documentation. Let me know if you have any questions on this!

Hi @estherk15 👋🏻 Thanks! I tried to update the description following the best practises, let me know what you think 🙇

cisco_sdwan/assets/monitors/device_reboot.json

cisco_sdwan/assets/monitors/device_unreachable.json

cisco_sdwan/assets/monitors/tunnel_down.json

github-actions · 2024-05-13T15:33:39Z

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

cisco_sdwan/assets/monitors/device_reboot.json

Co-authored-by: Esther Kim <esther.kim@datadoghq.com>

steveny91 · 2024-05-14T19:02:31Z

cisco_sdwan/metadata.csv

+cisco_sdwan.bfd_session.status,gauge,,,,The status of the BFD session.,0,cisco_sdwan,,
+cisco_sdwan.control_connection.status,gauge,,,,The status of the control connection.,0,cisco_sdwan,,


non blocking nit. Not sure the values of these metrics, but if they're status metrics like 1 for up 0 for down, would it make sense to document these in the description?

Good point thanks, updated in c31a3b4

steveny91 · 2024-05-14T19:03:19Z

cisco_sdwan/metadata.csv

+cisco_sdwan.disk.usage,gauge,,percent,,The percentage of disk currently being used.,0,cisco_sdwan,,
+cisco_sdwan.interface.rx_bandwidth_usage,gauge,,percent,,The percent rate of used received bandwidth.,0,cisco_sdwan,,
+cisco_sdwan.interface.rx_bits,count,,bit,,The total number of bits received on the interface.,0,cisco_sdwan,,
+cisco_sdwan.interface.rx_bps,gauge,,bit,second,The inbound bandwidth rate in kilobit per second.,0,cisco_sdwan,,


Is the unit here bit or kilobit?

Good catch 🫣 updated f5f8c80

steveny91 · 2024-05-14T19:03:46Z

cisco_sdwan/metadata.csv

+cisco_sdwan.interface.rx_bps,gauge,,bit,second,The inbound bandwidth rate in kilobit per second.,0,cisco_sdwan,,
+cisco_sdwan.interface.rx_drops,count,,packet,,The number of inbound packets chosen to be discarded even though no errors had been detected to prevent them being deliverable to a higher-layer protocol.,0,cisco_sdwan,,
+cisco_sdwan.interface.rx_errors,count,,packet,,The number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol.,0,cisco_sdwan,,
+cisco_sdwan.interface.speed,gauge,,,,The interface current speed in bits per second.,0,cisco_sdwan,,


should this one be bit per second as well?

It could, but setting it as bit per second makes the unit scale to Ki/Mi/Gi units in the UI which is very weird for network interfaces (1Gb interface will be displayed as 0,9313 GiB), so we choose to not set units (similarly to SNMP)

steveny91 · 2024-05-14T19:04:22Z

cisco_sdwan/metadata.csv

+cisco_sdwan.interface.tx_drops,count,,packet,,The number of outbound packets chosen to be discarded even though no errors had been detected to prevent them being transmitted.,0,cisco_sdwan,,
+cisco_sdwan.interface.tx_errors,count,,packet,,The number of outbound packets that could not be transmitted because of errors.,0,cisco_sdwan,,
+cisco_sdwan.memory.usage,gauge,,percent,,The percentage of memory currently being used.,0,cisco_sdwan,,
+cisco_sdwan.omp_peer.status,gauge,,,,The status of the OMP Peer connection.,0,cisco_sdwan,,


Same as the other status metrics

…o ThibaudC/cisco-sdwan-assets

github-actions · 2024-05-15T08:18:47Z

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

steveny91 · 2024-05-15T17:30:14Z

cisco_sdwan/manifest.json

+  },
+  "oauth": {}


Suggested change

},

"oauth": {}

}

This field isn't needed anymore. Non blocking

* Add assets for Cisco SD-WAN integration * Sync labeler conf * Fix manifest * Fix manifest (again) * Fix assets (again) * Add NDM as codeowners for Cisco SDWAN * Fix link * Improve monitor description * Network jitter is measured in ms * Shorter monitor descr * Caps * Add beta notice * Add beta notice * Fix typo * Update beta warning * Fix source name * Update monitors * Change reboot monitor threshold * Update dashboard * Update cisco_sdwan/assets/monitors/device_reboot.json Co-authored-by: Esther Kim <esther.kim@datadoghq.com> * Update status metrics description * Fix bps description * quotes * typo * typo * Group by device namespace in query value widgets * fix unreachable widget color * Remove oauth field from manifest --------- Co-authored-by: Esther Kim <esther.kim@datadoghq.com> 9aafcf2

Add assets for Cisco SD-WAN integration

bde6629

datadog-agent-integrations-bot bot added documentation changelog/no-changelog qa/skip-qa Automatically skip this PR for the next QA labels May 2, 2024

Sync labeler conf

16129ae

datadog-agent-integrations-bot bot added dev/testing dev/tooling integration/cisco_sdwan labels May 3, 2024

TCheruy added 4 commits May 3, 2024 13:51

Fix manifest

52687ba

Fix manifest (again)

ec0bced

Fix assets (again)

4ff12e4

Add NDM as codeowners for Cisco SDWAN

8db4b3b

TCheruy marked this pull request as ready for review May 3, 2024 12:47

TCheruy requested review from a team as code owners May 3, 2024 12:47

datadog-agent-integrations-bot bot added team/agent-integrations team/documentation labels May 3, 2024

estherk15 reviewed May 3, 2024

View reviewed changes

TCheruy added 6 commits May 3, 2024 17:39

Fix link

7f3d6f3

Improve monitor description

70df7d3

Network jitter is measured in ms

4c47a61

Shorter monitor descr

16af8aa

Caps

c82f186

Add beta notice

2242212

FlorianVeaux reviewed May 13, 2024

View reviewed changes

TCheruy added 2 commits May 13, 2024 17:30

Add beta notice

c94ce24

Fix typo

24cc00e

Update beta warning

f4e0bf6

Change reboot monitor threshold

971572b

estherk15 previously approved these changes May 14, 2024

View reviewed changes

cisco_sdwan/assets/monitors/device_reboot.json Outdated Show resolved Hide resolved

Update dashboard

0ce9155

TCheruy dismissed estherk15’s stale review via 0ce9155 May 14, 2024 17:16

Update cisco_sdwan/assets/monitors/device_reboot.json

e6c09fb

Co-authored-by: Esther Kim <esther.kim@datadoghq.com>

estherk15 previously approved these changes May 14, 2024

View reviewed changes

steveny91 reviewed May 14, 2024

View reviewed changes

TCheruy added 3 commits May 15, 2024 10:15

Update status metrics description

c31a3b4

Fix bps description

f5f8c80

Merge remote-tracking branch 'origin/ThibaudC/cisco-sdwan-assets' int…

656df2b

…o ThibaudC/cisco-sdwan-assets

TCheruy dismissed estherk15’s stale review via 656df2b May 15, 2024 08:17

TCheruy added 4 commits May 15, 2024 10:23

quotes

821cbca

typo

c57aafe

typo

59109e9

Group by device namespace in query value widgets

3890870

TCheruy requested review from steveny91 and FlorianVeaux May 15, 2024 11:36

FlorianVeaux previously approved these changes May 15, 2024

View reviewed changes

fix unreachable widget color

2182bfb

TCheruy dismissed FlorianVeaux’s stale review via 2182bfb May 15, 2024 13:53

steveny91 reviewed May 15, 2024

View reviewed changes

Remove oauth field from manifest

3cda2be

steveny91 approved these changes May 15, 2024

View reviewed changes

TCheruy merged commit 9aafcf2 into master May 15, 2024
33 checks passed

TCheruy deleted the ThibaudC/cisco-sdwan-assets branch May 15, 2024 17:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add assets for Cisco SD-WAN integration #17502

Add assets for Cisco SD-WAN integration #17502

TCheruy commented May 2, 2024 •

edited

github-actions bot commented May 2, 2024

estherk15 May 3, 2024

TCheruy May 14, 2024

github-actions bot commented May 13, 2024

steveny91 May 14, 2024

TCheruy May 15, 2024

steveny91 May 14, 2024

TCheruy May 15, 2024

steveny91 May 14, 2024

TCheruy May 15, 2024

steveny91 May 14, 2024

github-actions bot commented May 15, 2024

steveny91 May 15, 2024

		cisco_sdwan.bfd_session.status,gauge,,,,The status of the BFD session.,0,cisco_sdwan,,
		cisco_sdwan.control_connection.status,gauge,,,,The status of the control connection.,0,cisco_sdwan,,

Add assets for Cisco SD-WAN integration #17502

Add assets for Cisco SD-WAN integration #17502

Conversation

TCheruy commented May 2, 2024 • edited

What does this PR do?

Motivation

Additional Notes

Review checklist (to be filled by reviewers)

github-actions bot commented May 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 15, 2024

Choose a reason for hiding this comment

TCheruy commented May 2, 2024 •

edited