TI Recipe: Ensure each production component has at least one Datadog SLO #1072

JoaoMartins51 · 2023-07-25T17:24:45Z

https://app.shortcut.com/larder/story/15890/write-ti-tutorial-ensure-each-production-component-has-at-least-one-datadog-slo

Preview: https://deploy-preview-1072--roadie.netlify.app/docs/tech-insights/track-datadog-slos/

shortcut-integration · 2023-07-25T17:24:49Z

This pull request has been linked to Shortcut Story #15890: Write TI Tutorial: Ensure each production component has at least one Datadog SLO.

dtuite · 2023-07-26T08:49:26Z

content/docs/tech-insights/track-datadog-slos/index.md

+Before you begin, make sure you have the following:
+
+- A Datadog account: Sign up for a Datadog account if you don't have one already.
+- Access to your system's components: Ensure you have the necessary permissions to access the components you want to track.


It's not totally clear to me what this means. Do I need access to the Backstage components, or the Datadog "services"? Maybe explain why we're going to need the access. That will make it more clear.

dtuite · 2023-07-26T08:50:34Z

content/docs/tech-insights/track-datadog-slos/index.md

+- Access to your system's components: Ensure you have the necessary permissions to access the components you want to track.
+- Defined SLOs in at least one of the components.
+
+With Roadie’s Tech Insights feature, there’s an easier way. In this tutorial, we’re going to:


This is slightly different content than the "Prerequisites". I'd recommend splitting this out into it's own section called "What you'll learn"

dtuite · 2023-07-26T08:53:16Z

content/docs/tech-insights/track-datadog-slos/index.md

+
+   ![Data Source Listing](./datasources_list.png)
+
+2. You may need to wait some time for the data source to collect all SLOs and Monitors from Datadog. It must contact the Datadog APIs for each component which is captured by the already set filter.


We're missing a step here I think. Don't we need to teach the user how to set the annotations on some components so that this DS will work?

jorgelainfiesta

Great tutorial! Left a few comments that can help improve clarity for the reader if they're not already familiar with Tech Insights.

jorgelainfiesta · 2023-07-31T11:32:34Z

content/docs/tech-insights/track-datadog-slos/index.md

+
+### **What you'll learn**
+
+With Roadie's Tech Insights feature, there's an easier way. In this tutorial, we’re going to:


What is this "easier than" referring to?

jorgelainfiesta · 2023-07-31T11:54:07Z

content/docs/tech-insights/track-datadog-slos/index.md

+
+In order to collect the Datadog SLO count from each component, the Datadog integration needs to be set up on Roadie. To do that, follow these steps:
+
+### Administration → Settings → Datadog


I think steps should be formatted as a numbered list, as you do in the following section.

jorgelainfiesta · 2023-07-31T12:00:24Z

content/docs/tech-insights/track-datadog-slos/index.md

+
+   ![Data Source Listing](./datasources_list.png)
+
+2. You may need to wait some time for the data source to collect all SLOs and Monitors from Datadog. It must contact the Datadog APIs for each component, which is captured by the already set filter.


Might be useful to add more details on what this filter is about (who sets it, when, can it be changed).

jorgelainfiesta · 2023-07-31T12:02:28Z

content/docs/tech-insights/track-datadog-slos/index.md

+
+![Data Source Visualization](./datasource_graph.png)
+
+This chart tells us:


You've been using "you" as a subject throughout most of the article. It's better not to change it to "us" now, but keep it all consistent. The case of "our data source" a bit before this paragraph is also confusing: does it refer to the data source usage you described just now or to Roadie's implementation

jorgelainfiesta · 2023-07-31T12:03:57Z

content/docs/tech-insights/track-datadog-slos/index.md

+2. 33% of the Components that this Data Source targets have 2 SLOs defined and configured.
+3. 33% of the Components that this Data Source targets have no SLOs configured.
+
+In the next section, we will create a Check that can show a pass or fail result to app dev teams to tell them if they are missing any component that doesn’t have an SLO defined.


Considering re-phrasing this sentence, perhaps splitting it into two sentences? I'm not quite sure about what you want to say exactly

jorgelainfiesta · 2023-07-31T12:04:44Z

content/docs/tech-insights/track-datadog-slos/index.md

+
+## Create a check that shows which software doesn’t have an SLO defined and configured
+
+Now that we can determine which components are using Dockerfiles, and we can extract the base image version from those files, let’s write a check to combine both of these properties.


When did Dockerfiles come into play?

jorgelainfiesta · 2023-07-31T12:07:00Z

content/docs/tech-insights/track-datadog-slos/index.md

+
+   ![Create a Check](./create_check.png)
+
+3. In the Conditions section, we’re going to create a condition that compares against the Datadog Slo facts retrieved from the data source.


I think the notion of a 'fact' is rather blurry as it wasn't introduced earlier. Might be useful to refer to the results of the Data Source as 'facts' in the previous section

jorgelainfiesta

Looks great, left some suggestions on formatting

content/docs/tech-insights/track-datadog-slos/index.md

Co-authored-by: Jorge Lainfiesta <jorgelainfiesta@users.noreply.github.com>

sonarcloud · 2023-08-02T17:25:59Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

…SLO (#1072) * added recipe docs * punctuation fix * requested changes * requested changes * Update content/docs/tech-insights/track-datadog-slos/index.md Co-authored-by: Jorge Lainfiesta <jorgelainfiesta@users.noreply.github.com> * Update content/docs/tech-insights/track-datadog-slos/index.md Co-authored-by: Jorge Lainfiesta <jorgelainfiesta@users.noreply.github.com> --------- Co-authored-by: Jorge Lainfiesta <jorgelainfiesta@users.noreply.github.com>

JoaoMartins51 added 2 commits July 25, 2023 18:19

added recipe docs

bc15b2b

punctuation fix

7a69998

dtuite requested changes Jul 26, 2023

View reviewed changes

requested changes

af7493c

JoaoMartins51 requested a review from dtuite July 31, 2023 09:24

jorgelainfiesta reviewed Jul 31, 2023

View reviewed changes

requested changes

c983458

JoaoMartins51 requested a review from jorgelainfiesta August 1, 2023 11:23

jorgelainfiesta approved these changes Aug 2, 2023

View reviewed changes

content/docs/tech-insights/track-datadog-slos/index.md Outdated Show resolved Hide resolved

content/docs/tech-insights/track-datadog-slos/index.md Outdated Show resolved Hide resolved

JoaoMartins51 and others added 2 commits August 2, 2023 18:25

Update content/docs/tech-insights/track-datadog-slos/index.md

f3752c9

Co-authored-by: Jorge Lainfiesta <jorgelainfiesta@users.noreply.github.com>

Update content/docs/tech-insights/track-datadog-slos/index.md

43c1e49

Co-authored-by: Jorge Lainfiesta <jorgelainfiesta@users.noreply.github.com>

JoaoMartins51 requested a review from jorgelainfiesta August 3, 2023 08:01

dtuite approved these changes Aug 3, 2023

View reviewed changes

JoaoMartins51 merged commit ce15527 into main Aug 3, 2023
7 checks passed

JoaoMartins51 deleted the sc-15890-write-ti-tutorial-ensure-each-production branch August 3, 2023 08:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TI Recipe: Ensure each production component has at least one Datadog SLO #1072

TI Recipe: Ensure each production component has at least one Datadog SLO #1072

JoaoMartins51 commented Jul 25, 2023 •

edited by dtuite

Loading

shortcut-integration bot commented Jul 25, 2023

dtuite Jul 26, 2023

dtuite Jul 26, 2023

dtuite Jul 26, 2023

jorgelainfiesta left a comment

jorgelainfiesta Jul 31, 2023

jorgelainfiesta Jul 31, 2023

jorgelainfiesta Jul 31, 2023

jorgelainfiesta Jul 31, 2023

jorgelainfiesta Jul 31, 2023

jorgelainfiesta Jul 31, 2023

jorgelainfiesta Jul 31, 2023

jorgelainfiesta left a comment

sonarcloud bot commented Aug 2, 2023


		![Data Source Listing](./datasources_list.png)

		2. You may need to wait some time for the data source to collect all SLOs and Monitors from Datadog. It must contact the Datadog APIs for each component which is captured by the already set filter.


		### What you'll learn

		With Roadie's Tech Insights feature, there's an easier way. In this tutorial, we’re going to:


		In order to collect the Datadog SLO count from each component, the Datadog integration needs to be set up on Roadie. To do that, follow these steps:

		### Administration → Settings → Datadog


		![Data Source Visualization](./datasource_graph.png)

		This chart tells us:


		## Create a check that shows which software doesn’t have an SLO defined and configured

		Now that we can determine which components are using Dockerfiles, and we can extract the base image version from those files, let’s write a check to combine both of these properties.


		![Create a Check](./create_check.png)

		3. In the Conditions section, we’re going to create a condition that compares against the Datadog Slo facts retrieved from the data source.

TI Recipe: Ensure each production component has at least one Datadog SLO #1072

TI Recipe: Ensure each production component has at least one Datadog SLO #1072

Conversation

JoaoMartins51 commented Jul 25, 2023 • edited by dtuite Loading

shortcut-integration bot commented Jul 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgelainfiesta left a 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

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

jorgelainfiesta left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Aug 2, 2023

JoaoMartins51 commented Jul 25, 2023 •

edited by dtuite

Loading