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

docs: Documentation for MetricPipeline #362

Merged
merged 9 commits into from
Aug 29, 2023
Merged

docs: Documentation for MetricPipeline #362

merged 9 commits into from
Aug 29, 2023

Conversation

a-thaler
Copy link
Collaborator

Description

Changes proposed in this pull request:

  • added full new documentation for the feature

Related Issues and Documents

Closes:

Related issues:

Traceability

  • The PR is linked to a GitHub Issue.
  • New features have a milestone label set.
  • New features have defined acceptance criteria in a corresponding GitHub Issue, and all criteria are satisfied with this PR.
  • The corresponding GitHub Issue has a respective area label.
  • The follow-up issues (if any) are linked in the Related Issues section.

Testability

The feature is unit-tested:

  • Yes.
  • No, because unit tests are not needed.
  • No, because of ...

The feature is e2e-tested:

  • Yes.
  • No, because e2e-tests are not needed.
  • No, because of ...

Tests conducted for the PR:

Codebase

  • My code follows the Effective Go style guidelines.
  • The code was planned and designed following the defined architecture and the separation of concerns.
  • The code has sufficient comments, particularly for all hard-to-understand areas.
  • This PR adds value and shows no feature creep.
  • I have augmented the test suite that proves my fix is effective or that my feature works.
  • Adjusted the documentation if the change is user-facing.

@kyma-bot kyma-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 24, 2023
@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

@a-thaler a-thaler added kind/feature Categorizes issue or PR as related to a new feature. area/documentation Documentation changes and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Aug 24, 2023
@kyma-bot kyma-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Aug 24, 2023
@a-thaler a-thaler mentioned this pull request Aug 24, 2023
Closed
32 tasks
NHingerl
NHingerl reviewed Aug 24, 2023
View reviewed changes
docs/user/03-traces.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Outdated Show resolved Hide resolved
docs/user/04-metrics.md Show resolved Hide resolved
a-thaler
a-thaler commented Aug 24, 2023
View reviewed changes
docs/user/04-metrics.md Outdated Show resolved Hide resolved
@a-thaler a-thaler marked this pull request as ready for review August 28, 2023 12:51
@a-thaler a-thaler requested a review from a team as a code owner August 28, 2023 12:51
@NHingerl NHingerl self-assigned this Aug 28, 2023
NHingerl
NHingerl reviewed Aug 28, 2023
View reviewed changes
docs/user/02-logs.md Outdated
@@ -320,6 +307,22 @@ spec:
...
```

### Result

To activate and verify the constructed LogPipeline, follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't activating the LogPipeline rather something like step 7? Why construct it if you're not going to activate it?
In that case, I'd put steps 1+2 of Result as a last step 7 of the procedure above. And then the verification step would be part of the Result section, along the lines of: "Result: Your Logpipeline has been activated and has the status Ready in your cluster. Check the status with the following command:"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

docs/user/03-traces.md Outdated

Telemetry Manager continuously watches the Secret referenced with the **secretKeyRef** construct. You can update the Secret’s values, and Telemetry Manager detects the changes and applies the new Secret to the setup.
If you use a Secret owned by the [SAP BTP Service Operator](https://github.com/SAP/sap-btp-service-operator), you can configure an automated rotation using a `credentialsRotationPolicy` with a specific `rotationFrequency` and don’t have to intervene manually.

### Result

To activate and verify the constructed TracePipeline, follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above, why is activating the pipeline not part of the procedure? How common is it that users construct the pipeline but won't activate it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

docs/user/03-traces.md Outdated Show resolved Hide resolved
@kyma-bot kyma-bot added the lgtm Looks good to me! label Aug 29, 2023
@kyma-bot kyma-bot merged commit 82e2fee into kyma-project:main Aug 29, 2023
@a-thaler a-thaler added this to the 0.10.0 milestone Aug 29, 2023
@a-thaler a-thaler deleted the metrics branch August 29, 2023 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NHingerl NHingerl NHingerl approved these changes

Assignees

@NHingerl NHingerl

Labels
area/documentation Documentation changes kind/feature Categorizes issue or PR as related to a new feature. lgtm Looks good to me! size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
0.10.0
Development

Successfully merging this pull request may close these issues.
3 participants
@a-thaler @kyma-bot @NHingerl