Skip to content

Commit f7128d0

Browse files
Dgiordano33Dan G
andauthored
fixed MaC guide, removed old redirect, fixed the Meta Titles (#1097)
* fixed MaC guide, removed old redirect, fixed the Meta Titles * one more benefit * update tests --------- Co-authored-by: Dan G <[email protected]>
1 parent 30edecb commit f7128d0

File tree

5 files changed

+59
-19
lines changed

5 files changed

+59
-19
lines changed

__checks__/docs.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ test('homepage', async ({ page }) => {
55
const checklyPage = new ChecklySitePage(page)
66
await checklyPage.goto('/docs')
77
await checklyPage.screenshot('docs')
8-
expect(await page.title()).toEqual('Getting started with Checkly | Checkly')
8+
expect(await page.title()).toEqual('Getting started with Checkly')
99
})

site/content/docs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Getting started with Checkly
2+
title: Getting started with Checkly
33
navTitle: Get Started
44
aliases:
55
- /docs/
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: What is monitoring as code?
3+
description: >-
4+
Monitoring as code is the practice of managing monitoring configurations and alerts through code. This approach offers several benefits for engineering teams at scale, including codified, version-controlled, and reusable monitoring configurations.
5+
author: Daniel Giordano
6+
avatar: 'images/avatars/daniel-giordano.png'
7+
---
8+
9+
## An overview of monitoring as code
10+
11+
Monitoring as code is the practice of creating and maintaining your monitoring and alerting configurations through code. This approach offers several benefits over the traditional, manual approach of configuring monitors through a UI.
12+
13+
MaC is similar to other paradigms that are shifting responsibilities "left", such as infrastructure as code, configuration as code, and testing. Shifting these responsibilities to engineers allows them to manage large-scale, complex systems more effectively.
14+
15+
## The pain of traditional monitoring
16+
17+
Traditional monitoring approaches can be cumbersome and error-prone and often led to a siloed approach involving operations teams. They often require manual configuration of monitors, which can be time-consuming and difficult to manage at scale. This approach also makes it difficult to reuse configurations - each monitor needs to be configured individually. The tools themselves were built for a siloed approach and not built for extensibility in a engineering-centric world.
18+
19+
## The benefits of monitoring as code
20+
21+
### Codified and automated monitoring management
22+
Monitors and alerts are configured in code, meaning you can programmatically create, update, and delete them in the same type of lifecycle as your other application and infrastructure code. If you use a file-based routing approach, you can automate the creation of monitors based on the presence of a file in a repository - without having to manually create them through a UI.
23+
24+
### Version-controlled and ready for CI/CD
25+
When you manage your monitors and alerts in code, you can use the same version control system you use for your other code. This allows you to track changes, collaborate with others, and roll back to previous versions if needed inside your CI/CD pipelines.
26+
27+
### Reuse of existing designs and tests as monitors
28+
Monitors and alerts configured in code can be reused across teams, workflows, and environments. For example, you can create a monitor for a service in your development environment, and use the same monitor in your production environment without having to manually configure it. You also can create a centralized wrapper for configuration that can be reused across multiple monitors and teams.
29+
30+
### Fully programmable within your stack
31+
Use the same tools you use for testing and observability to create monitors. Checkly natively supports Playwright and OpenTelemetry, so you can use the same libraries and tools you use for testing to create monitors. Then integrate your oTel traces with Checkly traces for a faster, more accurate mean time to resolution.
32+
33+
### Unify Your Testing and Monitoring
34+
35+
Build and run your test and monitoring setup from the same code base. Create tests locally with Playwright, test and monitor deployments in CI, then deploy them as monitors on our global infrastructure or deploy them to your own infrastructure.
36+
37+
## Use cases of monitoring as code
38+
39+
### Uptime monitoring of your UI or APIs
40+
Build simple monitors that check the availability of your UI or APIs and measure response times, status codes, and other simple metrics.
41+
42+
### End-to-end monitoring
43+
Create monitors that confirm the uptime or availability of a end-to-end process or transaction. Monitor login flows, checkout flows, or other complex workflows from the UI or create monitors that check multiple steps within an API call
44+
45+
### Automate monitor creation with new services
46+
Automate the creation of monitors individually or configure a routing approach to create them based on the presence of a file or specification in a repository.
47+
48+
### Programmable alerting
49+
Set highly configurable and customized alerting strategies that can be reused across monitors and teams.
50+
51+
### Customized dashboards and reports
52+
Generate customized dashboards and reports that can be deployed anywhere to improve collaboration and get the right information to the right people.
53+
54+
## Getting started
55+
Getting started with monitoring as code is straightforward with the [Checkly platform](https://checklyhq.com). To begin, sign up for a [free account of Checkly](https://app.checklyhq.com/signup) and start creating monitors and alerts using our CLI.

site/layouts/partials/head.html

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,7 @@
11
<head>
2-
{{ if .IsHome }}
3-
<title>{{ .Site.Title }} | Checkly</title>
4-
{{ else if .Params.head.title }}
5-
<title>{{ .Params.head.title }} | Checkly</title>
6-
{{ else }}
7-
<title>{{ .Title }} | Checkly</title>
8-
{{ end }}
2+
3+
<title>{{ if .Params.title }}{{ .Params.title }}{{ else }}{{ .Site.Title }}{{ end }}</title>
94

10-
{{$title := ""}}
11-
{{ if .IsHome }}{{$title = .Site.Title}}{{ else if .Params.head.title }}{{$title = .Params.head.title}}{{ else }}{{$title = .Title}}{{ end }}
12-
{{$titleLength := $title | len}}
13-
14-
{{ if lt $titleLength 50 }}
15-
<title>{{$title}} | Checkly</title>
16-
{{ else }}
17-
<title>{{$title}}</title>
18-
{{ end }}
195
<meta charset="utf-8" />
206
<meta name="description" content="{{ with .Description }}{{ . | markdownify }}{{ else }}{{if .IsPage}}{{ .Summary }}{{ else }}{{ with .Site.Params.description }}{{ . | markdownify}}{{ end }}{{ end }}{{ end }}" />
217
<meta name="viewport" content="width=device-width" initial-scale="1" maximum-scale="1" />

vercel.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@
8686
{ "source": "/guides/api-monitoring(/)?", "destination": "/guides/monitoring-the-stripe-api/", "permanent": true },
8787
{ "source": "/guides/puppeteer-to-playwright(/)?", "destination": "/guides/moving-from-puppeteer-to-playwright/", "permanent": true },
8888
{ "source": "/guides/monitoring-as-code-cli(/)?", "destination": "/guides/monitoring-ecommerce-apps-using-playwright/", "permanent": true },
89-
{ "source": "/guides/monitoring-as-code(/)?", "destination": "/guides/monitoring-ecommerce-apps-using-terraform/", "permanent": true },
9089
{ "source": "/guides/setup-scripts(/)?", "destination": "/guides/setup-scripts-for-apis/", "permanent": true },
9190
{ "source": "/guides/openapi-swagger(/)?", "destination": "/guides/monitoring-an-openapi-spec/", "permanent": true }
9291
]

0 commit comments

Comments
 (0)