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

Jump to bottom

Restructure obsv overview #13119

Merged
merged 31 commits into from Apr 14, 2022
Merged

Restructure obsv overview #13119

merged 31 commits into from Apr 14, 2022

Conversation

NHingerl
Copy link
Contributor

@NHingerl NHingerl commented Jan 19, 2022 •
edited

Description

Changes proposed in this pull request:

  • consolidate content of the README and the introductory doc about Observability in Kyma
  • create designated overview docs for Monitoring, Logging and Tracing; add "Benefits of distributed tracing" to the latter
  • create designated operation guides for Grafana with Istio monitoring, and for mTLS with custom metrics
  • add Istio monitoring flow to general monitoring flow
  • improve consistency for Monitoring tutorials "Next Steps" section
  • adds a Limitations section to Monitoring, Logging, Tracing

Related issue(s)

@kyma-bot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@kyma-bot kyma-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 19, 2022
@netlify
Copy link

netlify bot commented Jan 19, 2022 •
edited

✅ 🥰 Documentation preview ready! 🥰

Name Link
🔨 Latest commit 4e6932d
🔍 Latest deploy log https://app.netlify.com/sites/kyma-project-docs-preview/deploys/6258422ea8cca5000a1dce59
😎 Deploy Preview https://deploy-preview-13119--kyma-project-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@NHingerl NHingerl self-assigned this Jan 19, 2022
@NHingerl NHingerl added the area/documentation Issues or PRs related to documentation label Jan 19, 2022
@kyma-stale-bot
Copy link

This issue has been automatically marked as stale due to the lack of recent activity. It will soon be closed if no further activity occurs. Thank you for your contributions.

@kyma-stale-bot kyma-stale-bot bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 28, 2022
@a-thaler a-thaler removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 28, 2022
@NHingerl
Copy link
Contributor Author

NHingerl commented Apr 6, 2022

/retest

@kyma-bot kyma-bot added the do-not-merge/missing-docs-review Indicates that a PR should not merge beacuse it has missing documentation review. label Apr 6, 2022
@NHingerl NHingerl marked this pull request as ready for review April 7, 2022 11:51
@kyma-bot kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 7, 2022
@NHingerl @a-thaler
Update docs/01-overview/main-areas/observability/obsv-01-monitoring-i…
e603f71 
…n-kyma.md

Co-authored-by: Andreas Thaler <andreas.thaler01@sap.com>
@kyma-bot kyma-bot added lgtm Looks good to me! approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Apr 13, 2022
klaudiagrz
klaudiagrz reviewed Apr 14, 2022
View reviewed changes
docs/01-overview/main-areas/observability/README.md Outdated Show resolved Hide resolved
docs/01-overview/main-areas/observability/README.md Outdated Show resolved Hide resolved
docs/01-overview/main-areas/observability/README.md Show resolved Hide resolved
docs/01-overview/main-areas/observability/README.md Outdated Show resolved Hide resolved
docs/01-overview/main-areas/observability/obsv-01-monitoring-in-kyma.md Outdated Show resolved Hide resolved
docs/05-technical-reference/00-architecture/obsv-01-architecture-monitoring.md Show resolved Hide resolved
docs/05-technical-reference/00-architecture/obsv-01-architecture-monitoring.md Outdated Show resolved Hide resolved
docs/05-technical-reference/00-architecture/obsv-01-architecture-monitoring.md Outdated Show resolved Hide resolved
docs/05-technical-reference/00-architecture/obsv-01-architecture-monitoring.md Show resolved Hide resolved
docs/05-technical-reference/00-architecture/obsv-01-architecture-monitoring.md Show resolved Hide resolved
@NHingerl @klaudiagrz
Update docs/01-overview/main-areas/observability/obsv-03-tracing-in-k…
6c46339 
…yma.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@kyma-bot kyma-bot removed the lgtm Looks good to me! label Apr 14, 2022
NHingerl and others added 7 commits April 14, 2022 12:15
@NHingerl @klaudiagrz
Update docs/03-tutorials/00-observability/obsv-03-define-alerting-rul…
859d204 
…es-monitor.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@NHingerl @klaudiagrz
Update docs/04-operation-guides/operations/obsv-03-enable-grafana-for…
d7d3a90 
…-istio.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@NHingerl @klaudiagrz
Update docs/04-operation-guides/operations/obsv-04-enable-mtls-for-cu…
8dc4355 
…stom-metrics.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@NHingerl @klaudiagrz
Update docs/05-technical-reference/00-architecture/obsv-01-architectu…
c3ffa5d 
…re-monitoring.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@NHingerl @klaudiagrz
Apply suggestions from code review
49e32d6 
Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@NHingerl
more suggestions from TW review
33da2a7
@NHingerl
remove "Kyma uses..."
4fae18e
@kyma-bot kyma-bot added lgtm Looks good to me! and removed do-not-merge/missing-docs-review Indicates that a PR should not merge beacuse it has missing documentation review. labels Apr 14, 2022
@kyma-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: a-thaler, klaudiagrz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kyma-bot kyma-bot merged commit 151e5f2 into kyma-project:main Apr 14, 2022
@NHingerl NHingerl deleted the restructure_Obsv_overview branch April 14, 2022 15:56
koala7659 pushed a commit to koala7659/kyma that referenced this pull request May 5, 2022
@NHingerl @a-thaler
@klaudiagrz @koala7659
Restructure obsv overview (kyma-project#13119)
822b0e9 
* remove old version from CLI installation

* remove line with version

* Apply suggestions from code review

Co-authored-by: Andreas Thaler <andreas.thaler01@sap.com>

* restructure Obsv docs

* remove distr tracing from overview doc

* add A.Thaler's introduction to README

* remove link to obsolete istio monitoring doc

* all Prometheus limits in the same doc

* Logging with sub-headline Limitations

* fix broken links

* monitoring flow links

* fix links

* emphasize limits

* restructured time series limit paragraphs

* Apply suggestions from code review

Co-authored-by: Andreas Thaler <andreas.thaler01@sap.com>

* Update docs/01-overview/main-areas/observability/obsv-03-tracing-in-kyma.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update docs/01-overview/main-areas/observability/obsv-01-monitoring-in-kyma.md

Co-authored-by: Andreas Thaler <andreas.thaler01@sap.com>

* Update docs/01-overview/main-areas/observability/obsv-03-tracing-in-kyma.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>

* Update docs/03-tutorials/00-observability/obsv-03-define-alerting-rules-monitor.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>

* Update docs/04-operation-guides/operations/obsv-03-enable-grafana-for-istio.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>

* Update docs/04-operation-guides/operations/obsv-04-enable-mtls-for-custom-metrics.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>

* Update docs/05-technical-reference/00-architecture/obsv-01-architecture-monitoring.md

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>

* more suggestions from TW review

* remove "Kyma uses..."

* remove motivation

Co-authored-by: Andreas Thaler <andreas.thaler01@sap.com>
Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@a-thaler a-thaler a-thaler approved these changes

@klaudiagrz klaudiagrz klaudiagrz approved these changes

@grego952 grego952 Awaiting requested review from grego952

@mmitoraj mmitoraj Awaiting requested review from mmitoraj

Assignees

@a-thaler a-thaler

@klaudiagrz klaudiagrz

@NHingerl NHingerl

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation Issues or PRs related to documentation lgtm Looks good to me! size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@NHingerl @kyma-bot @a-thaler @klaudiagrz