Cli-microsoft365: New command: get tenant diagnostics

Created on 1 Aug 2019  路  7Comments  路  Source: pnp/cli-microsoft365

If you look at the issues lists on the sp-dev-fx-webparts, sp-dev-fx-extensions, and sp-dev-docs, the most frequent first response is "what environment are you currently running?". This is especially true when people report issues that occur on one tenant, but not the other.

What if we had a standard command to get tenant diagnostics info, which we could use as a standard way to compare tenant environments?

For example, it would include:

  • Whether the tenant is a first-release tenant
  • Whether the tenant is a dev tenant
  • Version numbers(?)
  • and anything else the community deems useful that can be retrieved from the tenant info

We could make it spit out the results to a JSON file or a .MD file (or both). It needs to be something that is easy to compare so that we can quickly identify the differences.

I'm happy to take this on, but I'll need everyone's help with determining what information would be useful to retrieve. I may also need some ideas about where to retrieve the information.

Any ideas?

On a related note, I'd love to have a similar CLI command to get the SPFx environment so that we can compare why an SPFx solution works for one person but doesn't for another.

feature request help wanted needs design

All 7 comments

This is a great idea @hugoabernier ! We will have to identify all the information that would be initially needed, but we can definitely start with what you added up and investigate if there are apis around it.

I will mark this as needs discusison and we can continue the discussion here. I would like to see what @waldekmastykarz will say on this. He will be back from vacation soon.

What he gets vacation?!?! Must be nice!

Just kidding, I'm sure it is well-deserved. I hope he'll come back with great ideas for this command.

Let me know how I can help.

It's a great suggestion and would be absolutely invaluable. We're however limited with what's exposed by the API. For one I know, that targeted release isn't. I'm all for exposing as much info as we can to help in debug scenarios.

@appieschot @plamber @garrytrinder @mpowney do you happen to have any scripts that you use and which extract information mentioned in this issue that we could use as a starting point for a spec?

I was thinking that we could use the Microsoft 365 DSC project as a starting point

Do you have any additional pointers that we could look at to speed things up?

Sorry @waldekmastykarz I don't have any scripts to hand for this purpose, but I very much like the idea of this command.

Was this page helpful?
0 / 5 - 0 ratings