UX is inconsistent between slack and sumologic integrations

sensu / catalog

Monitoring as code for Sensu Go. "There's a template for that!"

8 stars 4 forks source link

UX is inconsistent between slack and sumologic integrations #230

Closed aaggarwal-sumo closed 2 years ago

aaggarwal-sumo commented 2 years ago

[Suggestion]: Should be Consistency between Integrations

There should be consistency between each integration as currently it is observed for Sumo logic integration Sesnu by default only allows to specify Source URL as Environment Variable while installing the integration and no option for Secret Management whereas in Slack Integration we saw it allowed to select either of one.

Expected Behavior

If Secret or Environment is not supported still both option should be visible and unsupported should be greyed out or warning message should be put

Current Behavior

Just ask for Source URL in Sumo Integration and and No info is provided if that will be used as Environment or using Secret.

Possible Solution

If Secret or Environment is not supported still both option should be visible and unsupported should be greyed out or warning message should be put

Steps to Reproduce (for bugs)

Try installing Sumo Integration

Context

Your Environment

6.7.0 Sensu Catalog

aaggarwal-sumo commented 2 years ago

@portertech I am not able to add QE label. Please let me know if anything is required

echlebek commented 2 years ago

Consistency between integrations is good, and we should try to achieve it. But, I don't think that there is any way to enforce integration consistency within sensu-go. To achieve consistency, we will have to file issues against individual integrations, and bring them all up to the same standard.

I'm going to move this issue to the catalog repository, as it represents an actionable issue there.

jspaleta commented 2 years ago

@echlebek From discussion, the underlying catalog issue is correctable in the integrations configuration for sumologic . We just didn't realize the built-in SumoLogic metrics handler was able to take a url from an env_var. Ref: https://github.com/sensu/catalog/issues/226 for example approach

jspaleta commented 2 years ago

See PR #235 for updated logic for SumoLogic integration to introduce Secret as an option for url

Note: soooooooo technically we still can't treat this exactly the same as Slack, because the built-in SumoLogic Metrics Handler doesn't allow for env_var definitions as part of the specification. Practically its the same UX we are using in other integrations, giving user 3 options: Option 1: choose nothing, you're gonna rely on the existing environment Option 2: encode as plaintext in the Sensu resource definition (aka env_var or directly into resource spec ) Option 3: refer to Sensu Secret by name and associate with env_var name.

echlebek commented 2 years ago

@jspaleta I'm just the guy who moved this here :sweat_smile:

jspaleta commented 2 years ago

This should be better in the sumologic/sumologic-analytics/20220504.0.0 version.
Please re-open if needed