Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal for observability overview page #2203

Merged
merged 10 commits into from
Jun 6, 2024
Merged

Proposal for observability overview page #2203

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e7f3ecc
Proposal for observability overview page
pipo02mix May 3, 2024
78a15bc
Update src/content/overview/observability/_index.md
pipo02mix May 3, 2024
8156f8b
Merge branch 'main' into add-overview-observability
pipo02mix Jun 3, 2024
c088edb
Add a proposal
pipo02mix Jun 3, 2024
46a07c7
refactor observability overview to align with observability platform …
Rotfuks Jun 6, 2024
ab8ecc8
update review date
Rotfuks Jun 6, 2024
cb08707
Merge branch 'main' into add-overview-observability
Rotfuks Jun 6, 2024
1ab9083
fix linting errors
Rotfuks Jun 6, 2024
4cc3936
Apply suggestions from code review
pipo02mix Jun 6, 2024
45ea4c9
Address comments
pipo02mix Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions src/content/overview/observability/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,32 @@
---
title: Observability
description: Observability tooling to provide you with visibility into the Giant Swarm platform, your cluster fleet and application workloads.
description: Monitoring, Logging and Tracing to provide you with visibility into the Giant Swarm platform, your cluster fleet and application workloads.
weight: 70
menu:
principal:
parent: overview
identifier: overview-observability
last_review_date: 2024-03-18
last_review_date: 2024-05-03
owner:
- https://github.com/orgs/giantswarm/teams/sig-product
---

Check first the template (https://github.com/giantswarm/docs/pull/2180/files) it is still on development and you feedback is welcome, but you can take it as a reference.

Check failure on line 14 in src/content/overview/observability/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[Vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "src/content/overview/observability/_index.md", "range": {"start": {"line": 14, "column": 79}}}, "severity": "ERROR"}

Concepts come to my mind when I think on observability (worthy to mention here without going deep):

Check warning on line 16 in src/content/overview/observability/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[Vale] reported by reviewdog 🐶
[Microsoft.FirstPerson] Use first person (such as 'my') sparingly.

Raw Output:
{"message": "[Microsoft.FirstPerson] Use first person (such as 'my') sparingly.", "location": {"path": "src/content/overview/observability/_index.md", "range": {"start": {"line": 16, "column": 18}}}, "severity": "WARNING"}

Check warning on line 16 in src/content/overview/observability/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[Vale] reported by reviewdog 🐶
[Microsoft.FirstPerson] Use first person (such as ' I') sparingly.

Raw Output:
{"message": "[Microsoft.FirstPerson] Use first person (such as ' I') sparingly.", "location": {"path": "src/content/overview/observability/_index.md", "range": {"start": {"line": 16, "column": 30}}}, "severity": "WARNING"}

- Monitoring
- Logging
- Tracing
- Alerting
- Profiling

Write a brief description of the the observability in general from introductory point of view.

Check failure on line 24 in src/content/overview/observability/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[Vale] reported by reviewdog 🐶
[Vale.Repetition] 'the' is repeated!

Raw Output:
{"message": "[Vale.Repetition] 'the' is repeated!", "location": {"path": "src/content/overview/observability/_index.md", "range": {"start": {"line": 24, "column": 30}}}, "severity": "ERROR"}
pipo02mix marked this conversation as resolved.
Show resolved Hide resolved

## Features

Describe what use cases are covered by the observability features.

## Cloud-native technologies

- What technologies are used to provide observability in Giant Swarm?

Check failure on line 32 in src/content/overview/observability/_index.md

View workflow job for this annotation

GitHub Actions / Front matter problems

Found 1 severe problems 

FAIL - There must be a newline character at the end of the page to ensure proper parsing

Check failure on line 32 in src/content/overview/observability/_index.md

View workflow job for this annotation

GitHub Actions / markdownlint problems

markdownlint problem 

MD047/single-trailing-newline Files should end with a single newline character
Loading