Proposal for a Summary Mode to Display Diff Status by Resource

[guitarrapc]

Overview of issue:

Reading through the diffs output has been quite challenging. Currently, the tool provides a comprehensive output for each resource in the diff. However, interpreting the exact differences by manually reading the JSON output is not practical for larger datasets or organizations. It requires significant effort to sift through the details.

Proposed changes:

I propose adding a "summary mode" to the diffs command that lists resources where differences exist, without showing the full diff content initially. This summary mode would provide a high-level view of which resources have changes. Users could then apply filters to narrow down the output as needed, making the tool more user-friendly and efficient for real-world usage in Datadog Organizations data migration scenarios.

Here is an example of what the output could look like:

# this is the format
synced resource Title

execution sample.

datadog-sync diffs --summary

output sample.

O monitors "[Auto] Clock sync in NTP"
X monitors "Server system load.1 has increasing"
X dashboards "Foobar dashboard"
X dashboards "Amazon ECS"
O logs_indexes "foo Index"
O logs_indexes "bar Index"
... and so on

With this summary output, I can easily identify which resources have differences (indicated by "X"). Then, I can check the specific details of a resource's difference using a filter, such as:

datadog-sync diffs --filter='Type=dashboard;Name=name;Value=Foobar dashboard'

This workflow would allow users to quickly locate and focus on the resources with changes, and then use filtering options to drill down into the details when necessary, significantly improving the usability of the tool.