versatile-data-kit: VEP-1416 vdk-troubleshooting-tools

[doks5]

This change outlines a proposal to introduce data job troubleshooting tools, which can assisst root cause analysis efforts in case of failing deployed data jobs.

Testing Done: N/A

Signed-off-by: Andon Andonov [email protected]

[antoniivanov]

Looks good to me. You can merge it now with or without addressing my comments. Though please note them and address them in the future .

Do include either instructions or the source code for the png diagrams - in case someone needs to edit them (or reuse/extend them) in the future

[antoniivanov]

I did see the "not-ready-for-review" but it appears in a pretty advanced stage. It's quite ok for VEP to be updated in multiple PRs and written iteratively.

[doks5]

Looks good to me. You can merge it now with or without addressing my comments. Though please note them and address them in the future .

Do include either instructions or the source code for the png diagrams - in case someone needs to edit them (or reuse/extend them) in the future

Can you elaborate what you mean by "source code for the png diagrams"? By looking into the other VEPs, none of them seem to have special files for the diagrams (other than the png images themselves), so I assume you mean something different.

[antoniivanov]

Can you elaborate what you mean by "source code for the png diagrams"? By looking into the other VEPs, none of them seem to have special files for the diagrams (other than the png images themselves), so I assume you mean something different.

That's what I mean - specify file for the diagram. It can be a link or instruction as well. There are no in the other VEPs but I missed to request that previously.

[doks5]

Can you elaborate what you mean by "source code for the png diagrams"? By looking into the other VEPs, none of them seem to have special files for the diagrams (other than the png images themselves), so I assume you mean something different.

That's what I mean - specify file for the diagram. It can be a link or instruction as well. There are no in the other VEPs but I missed to request that previously.

The diagrams are made in gliffy, so I have them in .svg and .gliffy formats. The svg file could, in theory, be edited in any svg editor, while for the .gliffy file, a special gliffy editor would be needed.
What types of files would you acceptable as diagram sources?
Also, if we agree on acceptable file formats, we can update the VEP template to mention this, so we have point of reference in the future?

[antoniivanov]

The diagrams are made in gliffy, so I have them in .svg and .gliffy formats. The svg file could, in theory, be edited in any svg editor, while for the .gliffy file, a special gliffy editor would be needed. What types of files would you acceptable as diagram sources? Also, if we agree on acceptable file formats, we can update the VEP template to mention this, so we have point of reference in the future?

The gliffy file is the source then. If you have gliffy subscription you can edit it.

I am not sure I want to impose "our" view on what tool people should use
I'd personally use some free alternatives. In the past, I've used either mermaid-js or plant uml. Lately I use PlantUML more often (I think it's more popular).

[doks5]

The diagrams are made in gliffy, so I have them in .svg and .gliffy formats. The svg file could, in theory, be edited in any svg editor, while for the .gliffy file, a special gliffy editor would be needed. What types of files would you acceptable as diagram sources? Also, if we agree on acceptable file formats, we can update the VEP template to mention this, so we have point of reference in the future?

The gliffy file is the source then. If you have gliffy subscription you can edit it.

I am not sure I want to impose "our" view on what tool people should use I'd personally use some free alternatives. In the past, I've used either mermaid-js or plant uml. Lately I use PlantUML more often (I think it's more popular).

Added the diagram sources. In case additional diagrams are to be added, I'll use PlantUML to make it easier for future modifications.