Add SLO create callout to service overview, transactions page and transactions details #159958

MiriamAparicio · 2023-06-19T16:06:51Z

We split the work for #157484 into this PR and another one that will add the links to create SLOs from the Alerts and Rules dropdown in APM. Also, the design for the callout was simplified and we will iterate again in 8.10

What was done

Added callout with links to create SLOs in service overview, transactions overview and transaction details.

Screen.Recording.2023-06-20.at.09.44.40.mov

apmmachine · 2023-06-19T16:07:06Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2023-06-20T08:52:02Z

Pinging @elastic/apm-ui (Team:APM)

yngrdyn · 2023-06-20T08:59:19Z

x-pack/plugins/apm/public/components/app/service_overview/index.tsx

@@ -76,13 +79,29 @@ export function ServiceOverview() {
    ? 'column'
    : 'row';

+  const [sloCalloutDismissed, setSloCalloutDismissed] = useLocalStorage(


Are we cleaning this value? if not, this user will not see the callout again unless he is using another computer, incognito mode, another window, etc. Is that the intention? if that's not the intention maybe using sessionStorage could help us here

Yes, as far as I know if the user clicks to hide the callout it's not going to show again as we do in other places

I think that we discussed that the callout will be hidden if the user chooses to hide it or clicks the button to crate an SLO.

yngrdyn · 2023-06-20T09:00:30Z

x-pack/plugins/apm/public/components/app/service_overview/index.tsx

  return (
    <AnnotationsContextProvider
      serviceName={serviceName}
      environment={environment}
      start={start}
      end={end}
    >
+      {!sloCalloutDismissed && (


Shouldn't we also show this callout if an SLO is not current configured for this variables? or are we planning to show it even when the user has one configured?

Good point, I think after creating one we shouldn’t show the callout again, @gbamparop do we know if we can check if there are SLOs already created for the user?

That's a good point, we could reach to the AO team for this, but I would leave it simple for 8.9.

Please create a follow up story for this

We are dismissing the callout after navigating to create SLO, change added here 2a6aa66

What about detecting if an SLO rule is already created? Maybe a follow up for that one?

@yngrdyn I created this issue #160017

We don't offer yet an easy way to search for an SLO with specific params. You could search for all SLOs created with the sli.apm.transactionErrorRate or sli.apm.transactionDuration indicator, but that would require to handle pagination, etc.. I would not recommend doing this.

On a side note, are we planning of supporting creating SLO with the sli.apm.transactionDuration indicator with the threshold value set to a default value like the 95th (99th? avg?) percentile latency of the (service, env, transactionType, transactionName) ?

Thanks @kdelemme, I think for the porpoise of this, checking if there's at least one created will work for us.

gbamparop · 2023-06-20T09:04:35Z

x-pack/plugins/apm/public/components/shared/slo_callout/index.tsx

+          <p>
+            <FormattedMessage
+              id="xpack.apm.slo.callout.description"
+              defaultMessage="How quickly will you respon if the service goes down? Keep the performance, speed and user experience high with a SLO"


Suggested change

defaultMessage="How quickly will you respon if the service goes down? Keep the performance, speed and user experience high with a SLO"

defaultMessage="How quickly will you respond if the service goes down? Keep the performance, speed and user experience high with a SLO"

yngrdyn

LGTM

…fix'

kdelemme · 2023-06-20T13:33:12Z

x-pack/plugins/apm/public/components/shared/slo_callout/index.tsx

+                data-test-subj="apmCreateSloLink"
+                href={basePath.prepend(
+                  `/app/observability/slos/create${sloParams}`
+                )}


😍 Looking forward to see this in APM 👏🏻

kibana-ci · 2023-06-20T13:58:28Z

💚 Build Succeeded

Buildkite Build
Commit: 0890e04

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`apm`	1406	1407	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`apm`	3.6MB	3.6MB	+1.9KB

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	13	15	+2
`securitySolution`	411	415	+4
total			+6

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	14	16	+2
`securitySolution`	494	498	+4
total			+6

History

💛 Build #136423 was flaky 6c081d7
💚 Build #136399 succeeded d1fcdf9
💔 Build #136258 failed 5a5bf40

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

sorenlouv · 2023-06-20T19:59:00Z

@MiriamAparicio @kdelemme I just noticed from your recording that it is possible to create an SLO when "All" environments are selected. There is no environment called environment_all. It's a magic string we use in APM app that we check against. Unless the SLO app does the same it won't work (it's essentially creating an SLO for an environment that doesn't exist).

When "All environments" is selected in APM UI app I suggest passing undefined to the SLO app so no environment is selected.

kdelemme · 2023-06-20T20:13:29Z

You can provide * to the params.environment field, and internally we'll handle it as no environment is selected:

  if (indicator.params.environment !== ALL_VALUE) {
      queryFilter.push({
        match: {
          'service.environment': indicator.params.environment,
        },
      });
    }

…160103) Bug fix for #159958 (comment) ### What was done Provide * to the params.environment field when environment_all, actionable observability will handle it internally

Add SLO callout to service overview

87946d2

MiriamAparicio changed the title ~~Add call out to service overview, transactions page and transactions details~~ Add SLO create callout to service overview, transactions page and transactions details Jun 19, 2023

Add SLO callout to transactions overview and transaction details

76d3d6a

MiriamAparicio force-pushed the 157484-integrate-SLO-apm branch from 5a5bf40 to 76d3d6a Compare June 20, 2023 08:47

MiriamAparicio added Team:APM All issues that need APM UI Team support release_note:feature Makes this part of the condensed release notes apm:release-feature APM UI - Release Feature Goal v8.9.0 labels Jun 20, 2023

MiriamAparicio marked this pull request as ready for review June 20, 2023 08:51

MiriamAparicio requested a review from a team as a code owner June 20, 2023 08:51

yngrdyn reviewed Jun 20, 2023

View reviewed changes

gbamparop reviewed Jun 20, 2023

View reviewed changes

fix typo

d28034d

MiriamAparicio force-pushed the 157484-integrate-SLO-apm branch from d1fcdf9 to d28034d Compare June 20, 2023 09:56

yngrdyn approved these changes Jun 20, 2023

View reviewed changes

dismiss callout when navigating to create SLO

2a6aa66

MiriamAparicio force-pushed the 157484-integrate-SLO-apm branch from 6c081d7 to 2a6aa66 Compare June 20, 2023 11:37

MiriamAparicio and others added 3 commits June 20, 2023 12:38

Merge branch 'main' into 157484-integrate-SLO-apm

b702b95

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

d80152b

…fix'

Merge branch 'main' into 157484-integrate-SLO-apm

0890e04

kdelemme reviewed Jun 20, 2023

View reviewed changes

MiriamAparicio merged commit ea0935f into elastic:main Jun 20, 2023
21 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Jun 20, 2023

MiriamAparicio mentioned this pull request Jun 20, 2023

[APM] Add links to create SLOs from Alerts and Rules dropdown #160024

Open

MiriamAparicio deleted the 157484-integrate-SLO-apm branch June 20, 2023 14:18

MiriamAparicio mentioned this pull request Jun 21, 2023

[APM] Provide * to the params.environment field when environment_all #160103

Merged

kpatticha mentioned this pull request Jul 12, 2023

[APM] SloCallout throws an error when transaction.name has the character % #161776

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SLO create callout to service overview, transactions page and transactions details #159958

Add SLO create callout to service overview, transactions page and transactions details #159958

MiriamAparicio commented Jun 19, 2023 •

edited

apmmachine commented Jun 19, 2023

elasticmachine commented Jun 20, 2023

yngrdyn Jun 20, 2023 •

edited

MiriamAparicio Jun 20, 2023

gbamparop Jun 20, 2023

yngrdyn Jun 20, 2023 •

edited

MiriamAparicio Jun 20, 2023

gbamparop Jun 20, 2023

yngrdyn Jun 20, 2023

MiriamAparicio Jun 20, 2023

yngrdyn Jun 20, 2023 •

edited

MiriamAparicio Jun 20, 2023 •

edited

kdelemme Jun 20, 2023

MiriamAparicio Jun 20, 2023

gbamparop Jun 20, 2023

yngrdyn left a comment

kdelemme Jun 20, 2023

kibana-ci commented Jun 20, 2023

ESLint disabled line counts

Total ESLint disabled count

sorenlouv commented Jun 20, 2023

kdelemme commented Jun 20, 2023

	defaultMessage="How quickly will you respon if the service goes down? Keep the performance, speed and user experience high with a SLO"
	defaultMessage="How quickly will you respond if the service goes down? Keep the performance, speed and user experience high with a SLO"

Add SLO create callout to service overview, transactions page and transactions details #159958

Add SLO create callout to service overview, transactions page and transactions details #159958

Conversation

MiriamAparicio commented Jun 19, 2023 • edited

What was done

apmmachine commented Jun 19, 2023

🤖 GitHub comments

elasticmachine commented Jun 20, 2023

yngrdyn Jun 20, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yngrdyn Jun 20, 2023 • edited

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

yngrdyn Jun 20, 2023 • edited

Choose a reason for hiding this comment

MiriamAparicio Jun 20, 2023 • edited

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

yngrdyn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Jun 20, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

ESLint disabled line counts

Total ESLint disabled count

History

sorenlouv commented Jun 20, 2023

kdelemme commented Jun 20, 2023

MiriamAparicio commented Jun 19, 2023 •

edited

yngrdyn Jun 20, 2023 •

edited

yngrdyn Jun 20, 2023 •

edited

yngrdyn Jun 20, 2023 •

edited

MiriamAparicio Jun 20, 2023 •

edited