generated from kyma-project/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 28
docs: redesign documentation #2341
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.
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
Merged
Merged
Changes from 121 commits
Commits
Show all changes
171 commits
Select commit
Hold shift + click to select a range
c64f4d8
chore: Renovate support
a-thaler dbbf6bf
Update renovate.json
a-thaler 3a514d7
Update renovate.json
a-thaler 901fb01
Update renovate.json
a-thaler 37bec0c
Update renovate.json
a-thaler 348f6ef
Update renovate.json
a-thaler 6ad3e25
Update renovate.json
a-thaler f5ff171
Update renovate.json
a-thaler 4fb14c9
Update renovate.json
a-thaler 28e56f0
docs: revamp
a-thaler d35f1cf
fix
a-thaler d3d90da
redesign
a-thaler 6168b27
Merge branch 'main' into docs
a-thaler 3a4a176
fix
a-thaler 8053983
fix
a-thaler ef241af
fixes
a-thaler 6908baa
Merge branch 'main' into docs
a-thaler 0b83bcd
fix
a-thaler cac01a4
Merge branch 'main' into docs
a-thaler 0b05b74
added migration guide
a-thaler 02cb528
Merge branch 'main' into docs
a-thaler c3a8c7b
Review feedback
a-thaler 28adee5
added istio
a-thaler b3400f6
fix
a-thaler 4ebdc4f
Merge branch 'main' into docs
a-thaler e08fcfd
improved doc titles
a-thaler aac8797
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
a-thaler b5bbc18
new diagram
a-thaler 4cac1b7
fix diagram
a-thaler 6f74592
migrate cls guide
a-thaler e23b7aa
Merge branch 'main' into docs
a-thaler 381db8f
Review migration guide
NHingerl edc4254
temporarily move the guide to root for review
NHingerl fc01206
adjust title
NHingerl 6141f81
language review
NHingerl 12ebdcf
language
NHingerl 077eec6
language
NHingerl 513d9a6
Merge branch 'main' into docs
a-thaler 776de3e
first batch of content updates
NHingerl 40b1aae
Merge pull request #22 from NHingerl/pr-2341-ninas-changes
a-thaler 9bcd945
two more docs
NHingerl c06f299
update metrics docs
NHingerl e2fa150
health monitoring
NHingerl 4803f4e
mov and rename monitor pipeline health
NHingerl 698c1b9
delete sample files
NHingerl fb5b0df
migrated architecture
a-thaler 3eb43c0
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
a-thaler b578453
troubleshooting
a-thaler 2b6c53e
add filtering docs
NHingerl 75e19ec
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
NHingerl 57dba81
renamed docs
a-thaler 4de6da5
Merge branch 'main' into docs
a-thaler 2efe997
adjusted links
a-thaler f33581a
renemd pipelines
a-thaler 73fb78b
rephrase redirects
NHingerl 8377e4f
fix link
NHingerl ec7a19a
fix link titles
NHingerl 0edcd8f
fix links
NHingerl 35edaab
a word too much
NHingerl 09be9c1
a word more
NHingerl 7784dde
integration guide
a-thaler c713f33
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
a-thaler 67527db
finalized integration guide
a-thaler d2da808
fix
a-thaler 3b0e4f2
fix readme
a-thaler f7014e3
adjust to Help Portal version
NHingerl a1e5601
align main README with Help Portal version
NHingerl 1a47775
align pipeline doc with Help Portal
NHingerl 81ea3a5
align otlp input doc with help portal
NHingerl 8c7ab82
align Collecting Logs with HP
NHingerl 4236dea
align application input with Help Portal
NHingerl 71efd00
remove curl from prerequisites
NHingerl 1edbfda
align istio logs with Help Portal
NHingerl 683e5f9
align Limitations
NHingerl 4976797
adjust Istio Traces
NHingerl 88af9cd
align phrasing
NHingerl f06f1bd
align prometheus and istio metrics
NHingerl 6819597
Update docs/user/integration/sap-cloud-logging/README.md
a-thaler dacfaed
Update docs/user/integration/sap-cloud-logging/README.md
a-thaler 1ecc118
Merge branch 'main' into docs
a-thaler 8ea5768
add missing metrics
a-thaler 73dd02f
adjusted bufferFillingUp
a-thaler e23df79
Merge branch 'main' into docs
a-thaler b5a5583
align diagnostic metrics descriptions
NHingerl 7b0d22a
align Filter Metrics with HP
NHingerl d5b0ed2
align OTLP Log Transofrmation with HP doc
NHingerl 713d8a1
align Data Enrichment with HP
NHingerl 724837c
update otlp output doc
NHingerl 05c338a
align the CLS integration guide
NHingerl 0b9af3e
align migration guide with Help Portal
NHingerl 8b19f15
align Istio Integration with HP
NHingerl 51e72de
align Architecture with HP docs
NHingerl 5adb6c7
update troubleshooting
NHingerl faae359
drop backticks for k8s resource names
NHingerl 1596d1d
improved troubleshooting
a-thaler 16d7f7c
fix
a-thaler e34d3ce
adjust metrics architecture
a-thaler a671d84
Merge branch 'main' into docs
a-thaler 917d3e7
consistent use of "observability backend"
NHingerl 4c58cf4
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
NHingerl cf87302
align with help portal doc
NHingerl 53060e1
Apply suggestions from code review
a-thaler 2b35c42
consistent into sections for input docs
NHingerl 51edf25
format attributes/parameters as bold font (https://github.com/kyma-pr…
NHingerl de0d4e4
add links for Istio Telemety CRD
NHingerl b1df368
add lost sentence for Istio Tracing
NHingerl a2d096c
adjust ambiguous sentence
NHingerl 8320aea
adjust sidebar
NHingerl 8d84a87
language review
NHingerl 01eebdc
update stages diagram
NHingerl 9de5467
delete backup diagram
NHingerl ea0f674
fix diagram
NHingerl 770ffcc
update pipeline structure
NHingerl 2e82d0d
update OTLP Input and Telemetry Stages
NHingerl 1b08cf5
review otlp output
NHingerl 92a6c79
update CLS diagram
NHingerl 1e1afe4
update telemetry architecture diagrams
NHingerl eb81852
update architecture diagrams
NHingerl 8588c6d
Merge branch 'main' into docs
a-thaler 75e1671
delete backup files
a-thaler 7b558e0
review diagrams
a-thaler f739ce2
Merge branch 'main' into docs
a-thaler e36daef
review diagrams
a-thaler 2a6d3da
fixes
a-thaler 0621e9a
consistency in architecture
NHingerl 3eefe59
font color
NHingerl 8d0d331
fix link
a-thaler b2ea5d8
Merge branch 'main' into docs
a-thaler 133ed90
fix
a-thaler 7325ec4
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
a-thaler 61655bd
Merge branch 'main' into docs
a-thaler d034770
move "app logs from system namespaces" to Filter topic, add link
NHingerl 6fc1ae7
adjust formatting for namespace names and placeholders in Tracing
NHingerl d4b2dc6
system namespaces included, not excluded
NHingerl af21478
add Filter... link to metrics inputs
NHingerl 023e40a
consistent namespace placeholders
NHingerl 1512726
improve and simplify namespace filtering
NHingerl 84ea0aa
consistent phrasing for OTLP filters
NHingerl 23e4f5d
istio metrics exclude system namespaces by default
NHingerl 19e282a
review
NHingerl 086d037
align with help portal docs
NHingerl 216dd7d
language review
NHingerl ef58c85
add a sentence
NHingerl d877973
Apply suggestions from code review
a-thaler 308f3fb
switch order for application log filters
NHingerl eee6fbe
Merge branch 'main' into docs
a-thaler b1a23ea
TW review
NHingerl fd440e0
update with G's review
NHingerl 880df04
remove duplicate entry inn sidebar
NHingerl a14c814
update repo README
NHingerl b9e5dd3
update User README and resources README acc G's suggestions
NHingerl d4c4e24
fix typo in resources README
NHingerl 43a3c12
fix error in resources readme
NHingerl ad5e879
no capital A
NHingerl 49f0d95
apply Grzesiu's suggestions
NHingerl ebe5ec9
Apply Rakesh's HP suggestion about consistent resource name and note box
NHingerl e107823
fix formatting of notes, tips, and warnings
NHingerl 5914af9
fix tip formatting
NHingerl 4cf5f66
fix warning formatting
NHingerl c8d6ba2
rephrase column titles
NHingerl 300566f
Merge branch 'main' into docs
a-thaler 6e10e5b
test gitleaks
a-thaler 96728c4
fix note and tip formatting
NHingerl 8027bbe
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
NHingerl 3311df4
fix
a-thaler 00a2781
Merge branch 'main' into docs
a-thaler f562bad
removed orphaned gitleaks variable
a-thaler e7ebcbd
apply Grzesiu's suggestions
NHingerl 04c653a
Merge branch 'docs' of https://github.com/a-thaler/telemetry-manager …
NHingerl 6ff2ba4
Merge branch 'main' into docs
a-thaler 1e5c7ec
Update docs/user/resources/README.md
NHingerl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,3 @@ | ||
| # Telemetry Manager | ||
|
|
||
| As the core element of the Telemetry module, Telemetry Manager manages the lifecycle of other Telemetry module components by watching user-created resources. | ||
|
|
||
| ## Module Lifecycle | ||
|
|
||
| The Telemetry module includes Telemetry Manager, a Kubernetes [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) that's described by a custom resource of type Telemetry. Telemetry Manager has the following tasks: | ||
|
|
||
| 1. Watch the module configuration for changes and sync the module status to it. | ||
| 2. Watch for the user-created Kubernetes resources LogPipeline, TracePipeline, and MetricPipeline. In these resources, you specify what data of a signal type to collect and where to ship it. | ||
| 3. Manage the lifecycle of the self monitor and the user-configured agents and gateways. | ||
| For example, only if you defined a LogPipeline resource, the Fluent Bit DaemonSet is deployed as log agent. | ||
|
|
||
|  | ||
|
|
||
| ### Self Monitor | ||
|
|
||
| The Telemetry module contains a self monitor, based on [Prometheus](https://prometheus.io/), to collect and evaluate metrics from the managed gateways and agents. Telemetry Manager retrieves the current pipeline health from the self monitor and adjusts the status of the pipeline resources and the module status. | ||
| Additionally, you can monitor the health of your pipelines in an integrated backend like [SAP Cloud Logging](./integration/sap-cloud-logging/README.md#use-sap-cloud-logging-alerts): To set up alerts and reports in the backend, use the [pipeline health metrics](./04-metrics.md#5-monitor-pipeline-health) emitted by your MetricPipeline. | ||
|
|
||
|  | ||
|
|
||
| ## Module Configuration and Status | ||
|
|
||
| For configuration options and the overall status of the module, see the specification of the related [Telemetry resource](./resources/01-telemetry.md). | ||
| This content moved to [Architecture](./architecture/README.md). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.